订阅流程
应用可通过订阅 WPS 开放平台提供的订阅事件,实时获取并响应 WPS 办公套件里的动作,充分利用 WPS 的协作能力,提升应用的业务协作能力。
适用场景
下面列举两个简单的适用场景。开发者可以根据实际需求,订阅不同的事件。
实时数据处理 如果应用对数据的实时性要求比较高,希望能够及时地从 WPS 同步数据的变化,可以进行事件订阅。例如在用户离职时,应用需要第一时间处理离职用户的业务数据,就可以订阅用户变更事件。
快速事件响应 如果应用需要及时响应用户的操作,可以进行事件订阅。例如当新人入群时,群机器人需要给新人发送一条欢迎消息,就可以订阅用户进群事件。
事件订阅流程
事件订阅整体可分为 4 个步骤:
1、在 开发者后台-事件与回调
配置用于接收事件消息推送的地址(URL)。 2、在 开发者后台-事件回调
选择需要订阅的事件。 3、申请并开通事件所需权限。 4、事件触发并推送至应用的事件订阅地址,应用解密消息体并响应成功。详见 事件安全校验
配置订阅地址
配置事件订阅地址后,WPS 开放平台服务器会向该地址发送一个 application/json
格式的 HTTP POST 请求,以验证配置地址的有效,该 POST 请求中会携带一个 challenge
字段。
请求名称 | 参数类型 | 说明 |
---|---|---|
challenge | string | 应用需要在响应中原样返回的值 |
json
{
"challenge": "string"
}
当事件订阅地址收到开放平台推送的验证请求时,应用需要在 1
秒内,将接收到的 challenge
值原样返回给 WPS 开放平台。仅事件地址验证通过情况下,才可接收后续的订阅事件。
响应名称 | 参数类型 | 说明 |
---|---|---|
challenge | string | 应用在响应中原样返回的值 |
json
{
"challenge": "string"
}
接收并处理事件
应用收到 HTTP POST 请求后,需要在 3 秒内以 HTTP 200 状态码响应该请求。 否则 WPS 开放平台认为本次推送失败,并以 5 秒、15 秒、30 秒、50 秒、75 秒 的间隔重新推送事件,最多重试 5 次。