Skip to content

Commit a6de0c0

Browse files
rianlirianli
committed
feat: 更新event payload说明文档
1 parent cf0532b commit a6de0c0

File tree

1 file changed

+44
-63
lines changed

1 file changed

+44
-63
lines changed

‎docs/develop/api-v2/dev-prepare/interface-framework/event-emit.md‎

Lines changed: 44 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,62 @@
66
当用户在QQ平台内的一些行为操作或某些接口的有异步返回通知确认机制的场景的时候，QQ 会通过"事件"的方式，通知到开发者服务器，开发者可自行根据具体事件通知来进行下一步响应。譬如用户跟机器人发消息，用户添加机器人好友，机器人被拉入群聊等等事件。
77
:::
88

9-
## Webhook方式
10-
11-
webhook事件回调链路目前在灰度验证，灰度用户可体验通过页面配置事件监听及回调地址。如未在灰度范围，可联系QQ机器人反馈助手开通。
12-
13-
<img :src="$withBotBase('/images/api-231017/feedback_bot.png')" alt="QQ机器人反馈助手">
14-
15-
QQ机器人开放平台支持通过使用HTTP接口接收事件。开发者可通过[管理端](https://q.qq.com/qqbot/#/developer/webhook-setting)设定回调地址，监听事件等。
16-
17-
### 数据结构
18-
19-
#### Payload
9+
## 通用数据结构 Payload
2010

21-
网关的上下行消息采用的都是同一个结构，如下：
11+
`payload` 指的是在 `webhook`或`websocket` 连接上传输的数据，网关的上下行消息采用的都是同一个结构，如下：
2212

2313
```json
2414
{
15+
"id":"event_id",
2516
"op": 0,
2617
"d": {},
18+
"s": 42,
2719
"t": "GATEWAY_EVENT_NAME"
2820
}
2921
```
3022

31-
##### OpCode
23+
| 字段 | 描述 |
24+
|-----|------------------------------------------------------|
25+
| id | 事件id |
26+
| op | 指的是 opcode，参考连接维护 |
27+
| s | 下行消息都会有一个序列号，标识消息的唯一性，客户端需要再发送心跳的时候，携带客户端收到的最新的s |
28+
| t | 代表事件类型。主要用在op为 0 Dispatch 的时候 |
29+
| d | 代表事件内容，不同事件类型的事件内容格式都不同，请注意识别。主要用在op为 0 Dispatch 的时候 |
30+
3231

33-
`opcode` 含义如下：
32+
### OpCode 含义
33+
34+
所有 `opcode` 列表如下：
35+
36+
| **CODE** | **名称** | 接入方式 | **客户端行为** | **描述** |
37+
|----------|-------------------|-------------------|---------------|------------------------------------------|
38+
| 0 | Dispatch | webhook/websocket | Receive | 服务端进行消息推送 |
39+
| 1 | Heartbeat | websocket | Send/Receive | 客户端或服务端发送心跳 |
40+
| 2 | Identify | websocket | Send | 客户端发送鉴权 |
41+
| 6 | Resume | websocket | Send | 客户端恢复连接 |
42+
| 7 | Reconnect | websocket | Receive | 服务端通知客户端重新连接 |
43+
| 9 | Invalid Session | websocket | Receive | 当 identify 或 resume 的时候，如果参数有错，服务端会返回该消息 |
44+
| 10 | Hello | websocket | Receive | 当客户端与网关建立 ws 连接之后，网关下发的第一条消息 |
45+
| 11 | Heartbeat ACK | websocket | Receive/Reply | 当发送心跳成功之后，就会收到该消息 |
46+
| 12 | HTTP Callback ACK | webhook | Reply | 仅用于 http 回调模式的回包，代表机器人收到了平台推送的数据 |
47+
| 13 | 回调地址验证 | webhook | Receive | 开放平台对机器人服务端进行验证 |
48+
客户端行为含义如下：
49+
50+
`Receive` 客户端接收到服务端 `push` 的消息
51+
52+
`Send` 客户端发送消息
53+
54+
`Reply` 客户端接收到服务端发送的消息之后的回包（HTTP 回调模式）
55+
56+
57+
## Webhook方式
58+
59+
webhook事件回调链路目前在灰度验证，灰度用户可体验通过页面配置事件监听及回调地址。如未在灰度范围，可联系QQ机器人反馈助手开通。
60+
61+
<img :src="$withBotBase('/images/api-231017/feedback_bot.png')" alt="QQ机器人反馈助手">
62+
63+
QQ机器人开放平台支持通过使用HTTP接口接收事件。开发者可通过[管理端](https://q.qq.com/qqbot/#/developer/webhook-setting)设定回调地址，监听事件等。
3464

35-
| **CODE** | **名称** | **客户端行为** | **描述** |
36-
|----------|----------|-----------|-----------------|
37-
| 0 | Dispatch | Receive | 服务端进行消息推送 |
38-
| 13 | 回调地址验证 | Receive | 开放平台对机器人服务端进行验证 |
3965

4066
### 签名校验
4167

@@ -141,51 +167,6 @@ body: {"plain_token": "Arq0D5A61EgUu4OxUvOp","signature": "87befc99c42c651b3aac0
141167

142168
优势：本地服务器即可发起调试，无需依赖公网域名和公网服务器（`WebHook`）接收回调通知。
143169

144-
### 通用数据结构 Payload
145-
146-
`payload` 指的是在 `websocket` 连接上传输的数据，网关的上下行消息采用的都是同一个结构，如下：
147-
148-
```json
149-
{
150-
"op": 0,
151-
"d": {},
152-
"s": 42,
153-
"t": "GATEWAY_EVENT_NAME"
154-
}
155-
```
156-
157-
| 字段 | 描述 |
158-
|-----|------------------------------------------------------|
159-
| op | 指的是 opcode，参考连接维护 |
160-
| s | 下行消息都会有一个序列号，标识消息的唯一性，客户端需要再发送心跳的时候，携带客户端收到的最新的s |
161-
| t | 代表事件类型。主要用在op为 0 Dispatch 的时候 |
162-
| d | 代表事件内容，不同事件类型的事件内容格式都不同，请注意识别。主要用在op为 0 Dispatch 的时候 |
163-
164-
165-
### 长连接维护 OpCode
166-
167-
所有 `opcode` 列表如下：
168-
169-
| **CODE** | **名称** | **客户端行为** | **描述** |
170-
|----------|-------------------|---------------|------------------------------------------|
171-
| 0 | Dispatch | Receive | 服务端进行消息推送 |
172-
| 1 | Heartbeat | Send/Receive | 客户端或服务端发送心跳 |
173-
| 2 | Identify | Send | 客户端发送鉴权 |
174-
| 6 | Resume | Send | 客户端恢复连接 |
175-
| 7 | Reconnect | Receive | 服务端通知客户端重新连接 |
176-
| 9 | Invalid Session | Receive | 当 identify 或 resume 的时候，如果参数有错，服务端会返回该消息 |
177-
| 10 | Hello | Receive | 当客户端与网关建立 ws 连接之后，网关下发的第一条消息 |
178-
| 11 | Heartbeat ACK | Receive/Reply | 当发送心跳成功之后，就会收到该消息 |
179-
| 12 | HTTP Callback ACK | Reply | 仅用于 http 回调模式的回包，代表机器人收到了平台推送的数据 |
180-
181-
客户端行为含义如下：
182-
183-
`Receive` 客户端接收到服务端 `push` 的消息
184-
185-
`Send` 客户端发送消息
186-
187-
`Reply` 客户端接收到服务端发送的消息之后的回包（HTTP 回调模式）
188-
189170
### 发起连接到 Gateway
190171

191172
第一步先调用 [获取通用WSS 接入点 | QQ机器人文档](../../openapi/wss/url_get.md) 或 [获取带分片WSS 接入点 | QQ机器人文档](../../openapi/wss/shard_url_get.md) 接口获取网关地址。

0 commit comments

Comments
 (0)