Skip to content

WebHook

当发生特定的事件时,向已配置的 WebHook地址 推送以下事件。

事件枚举

序号事件值说明
1bind客户端绑定UID事件
2unbind客户端解绑UID事件
3onlineUID上线事件
4offlineUID下线事件
5ping客户端心跳事件
6pong客户端心跳事件

注意

  • 调用 bindUid 之后,UID在线客户端数量 等于1 仅触发 online 事件;大于1 只会触发 bind
  • 调用 unbindUid 之后 或 客户端断开连接,UID在线客户端数量 等于0 仅触发 offline 事件;大于1 只会触发 unbind

WebHook推送的数据结构

请求方式

POST

参数名类型描述
Content-Typestringapplication/json
Timestampstring毫秒时间戳
Signaturestring签名值,签名算法

请求Body参数

json
{
  "event": "bind",
  "uid": "123456",
  "client_id": "97fccffe-611f-421e-83cd-5aa6ca51bfe2",
  "time": "RFC3339 日期时间"
}