事件回调概述
事件回调说明
事件回调可以让你的应用及时响应卫瓴里的动作,实现高度整合。只需提供一个接收事件的URL,卫瓴开放平台会在事件发生时,以HTTP POST请求的方式将事件内容以JSON格式推送给你。
事件回调流程
假设你接收事件回调的URL为 http://open.test.com 需要实现该URL对应的服务并完成事件回调配置。
STEP1.配置回调
管理员可以在设置-开放平台,创建应用后配置回调地址。
配置项说明
Token:用于计算签名,由 16-32 位的英文或数字组成的自定义字符串。
EncodingAESKey:用于消息内容加密,由 43 位的英文或数字组成的自定义字符串。
回调地址URL:回调服务地址,由开发者搭建,用于接收通知消息或事件。
STEP2.回调地址有效性验证
配置回调信息时,卫瓴会发送一条验证请求,如下:
- 请求方式:GET
- 请求地址:http://open.test.com?msg_signature=MS×tamp=TS&nonce=N&echostr=STR
- 请求参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_signature | String | 消息签名,msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、echostr |
timestamp | String | 时间戳 |
nonce | String | 随机数 |
echostr | String | 加密的字符串 |
- 响应参数说明:
- 1.必须是上面echostr对应的解密明文,卫瓴会根据你返回的解密明文进行验证后才能配置成功
STEP3.接收回调
配置通过后,当有新事件产生时,卫瓴会发送回调消息到配置的 URL,请求内容如下:
- 请求方式: POST
- 请求地址: http://open.test.com?msg_signature=MS×tamp=TS&nonce=N
- 请求参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_signature | String | 消息签名,msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、请求体中的encrypt_msg |
timestamp | String | 时间戳 |
nonce | String | 随机数 |
- 响应参数说明:需在 1 秒内返回 success 字符串
最后修改时间: 21 天前