信达 - Sender

一个双向(上行、下行)消息推送服务。

这是信达的 Beta 2 版本,API接口与之前一致。原有的Agent程序还能继续使用,新的信令发送方式有所变化,请悉知。

快速开始

注册及关注微信服务号

首先,你需要注册一个账号,从而获取secretkey。这是调用信达API的鉴权方式。

https://sender.xzhsh.ch/signup

关注公众号并取得Secretkey。

接收通知

调用下面的接口即可通过公众号发送消息。接口参数和Server酱一样。

desc参数表示正文。支持使用markdown语法。在公众号消息卡片点击,能跳转到完整的消息内容页面。

发送「信令」

在公众号消息框发送的消息(信令)会被信达服务器加入一个队列。等待Agent(接收消息的一侧)拉取。

除了使用公众号发送信令,也可以使用API。

API与公众号发送的效果相同。

在Agent一侧调用这个API可以获取现有的信令。每隔一分钟轮询这个接口可以实时接收信令。

Webhook

除了使用API轮询信令,还可以设置一个Webhook主动接收信令。

发送信令后webhook会收到这样的一个POST请求。

Agent路由

通常情况下,人类只有一名,接收消息的Agent可能不止一个。不同的服务器或者不同服务器上的不同业务,都可能区分为不同的Agent。

于是,将信令发送给哪个Agent,即为Agent路由。

公众号发送消息时使用#AgentName Signaling的格式发送消息,即可确定一个Agent。(不需要提前创建Agent,新Agent自动创建)

相应的,API上也可以加入agent参数。

默认情况下不指定Agent,Agent视作为空「""」处理。

接收结果

信令通常代表的是需要执行的任务。

使用结果提交API向信达报告任务执行的结果,同时公众号也会推送结果通知。

TODO

计划开发一个cli工具,用于向公众号推送通知,以及将信令拉取转换为Shell。

评论