WebHook
当发生特定的事件时,向已配置的 WebHook地址 推送以下事件。
事件枚举
| 序号 | 事件值 | 说明 |
|---|---|---|
| 1 | bind | 客户端绑定UID事件 |
| 2 | unbind | 客户端解绑UID事件 |
| 3 | online | UID上线事件 |
| 4 | offline | UID下线事件 |
| 5 | ping | 客户端心跳事件 |
| 6 | pong | 客户端心跳事件 |
注意
- 调用
bindUid之后,UID在线客户端数量 等于1 仅触发online事件;大于1 只会触发bind。 - 调用
unbindUid之后 或 客户端断开连接,UID在线客户端数量 等于0 仅触发offline事件;大于1 只会触发unbind。
WebHook推送的数据结构
请求方式
POST
请求Header参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| Content-Type | string | application/json |
| Timestamp | string | 毫秒时间戳 |
| Signature | string | 签名值,签名算法 |
请求Body参数
json
{
"event": "bind",
"uid": "123456",
"client_id": "97fccffe-611f-421e-83cd-5aa6ca51bfe2",
"time": "RFC3339 日期时间"
}