diff --git a/docs/develop/api-v2/dev-prepare/interface-framework/api-use.md b/docs/develop/api-v2/dev-prepare/interface-framework/api-use.md
index ea56d94c..039af855 100644
--- a/docs/develop/api-v2/dev-prepare/interface-framework/api-use.md
+++ b/docs/develop/api-v2/dev-prepare/interface-framework/api-use.md
@@ -90,14 +90,12 @@ https://api.sgroup.qq.com
| 名称 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| Authorization | string | 是 | 格式值:"QQBot ACCESS_TOKEN" |
-| X-Union-Appid | string | 是 | 格式值:"BOT_APPID", 机器人 AppID |
**示例**
```json
{
"headers": {
- "Authorization": "QQBot {ACCESS_TOKEN}",
- "X-Union-Appid": "{BOT_APPID}",
+ "Authorization": "QQBot {ACCESS_TOKEN}"
}
}
```
diff --git a/docs/develop/api-v2/dev-prepare/interface-framework/event-emit.md b/docs/develop/api-v2/dev-prepare/interface-framework/event-emit.md
index 7d12877b..113a248b 100644
--- a/docs/develop/api-v2/dev-prepare/interface-framework/event-emit.md
+++ b/docs/develop/api-v2/dev-prepare/interface-framework/event-emit.md
@@ -27,14 +27,14 @@
"s": 42,
"t": "GATEWAY_EVENT_NAME"
}
-
-op 指的是 opcode,参考连接维护
-opcode 列表
-s 下行消息都会有一个序列号,标识消息的唯一性,客户端需要再发送心跳的时候,携带客户端收到的最新的s。
-t和d 主要是用在op为 0 Dispatch 的时候。
-t 代表事件类型。
-d 代表事件内容,不同事件类型的事件内容格式都不同,请注意识别。
```
+| 字段 | 描述|
+| ----- | ----- |
+| op |指的是 opcode,参考连接维护 |
+| s |下行消息都会有一个序列号,标识消息的唯一性,客户端需要再发送心跳的时候,携带客户端收到的最新的s |
+| t |代表事件类型。主要用在op为 0 Dispatch 的时候|
+| d |代表事件内容,不同事件类型的事件内容格式都不同,请注意识别。主要用在op为 0 Dispatch 的时候|
+
### 长连接维护 OpCode
diff --git a/docs/develop/api-v2/server-inter/channel/manage/event/channel.md b/docs/develop/api-v2/server-inter/channel/manage/event/channel.md
index 1fc883f2..35ede7f5 100644
--- a/docs/develop/api-v2/server-inter/channel/manage/event/channel.md
+++ b/docs/develop/api-v2/server-inter/channel/manage/event/channel.md
@@ -14,10 +14,6 @@
```json
{
- "op": 0,
- "s": 2,
- "t": "CHANNEL_CREATE",
- "d": {
"guild_id": "200000000",
"id": "2943679",
"name": "测试",
@@ -25,7 +21,6 @@
"owner_id": "100000000",
"sub_type": 0,
"type": 0
- }
}
```
@@ -39,10 +34,6 @@
```json
{
- "op": 0,
- "s": 3,
- "t": "CHANNEL_UPDATE",
- "d": {
"guild_id": "200000000",
"id": "2943679",
"name": "测试2",
@@ -50,7 +41,6 @@
"owner_id": "100000000",
"sub_type": 0,
"type": 0
- }
}
```
@@ -64,10 +54,6 @@
```json
{
- "op": 0,
- "s": 4,
- "t": "CHANNEL_DELETE",
- "d": {
"guild_id": "200000000",
"id": "2943679",
"name": "测试2",
@@ -75,6 +61,5 @@
"owner_id": "100000000",
"sub_type": 0,
"type": 0
- }
}
```
diff --git a/docs/develop/api-v2/server-inter/channel/manage/event/guild.md b/docs/develop/api-v2/server-inter/channel/manage/event/guild.md
index 86d98ef0..1f8c5ab4 100644
--- a/docs/develop/api-v2/server-inter/channel/manage/event/guild.md
+++ b/docs/develop/api-v2/server-inter/channel/manage/event/guild.md
@@ -17,10 +17,6 @@
```json
{
- "op": 0,
- "s": 6,
- "t": "GUILD_CREATE",
- "d": {
"description": "频道介绍",
"icon": "https://pub.idqqimg.com/pc/misc/files/20211208/311cfc87ce394c62b7c9f0508658cf25.png",
"id": "200000000",
@@ -30,7 +26,6 @@
"name": "频道名称",
"op_user_id": "100000000",
"owner_id": "100000000"
- }
}
```
@@ -45,10 +40,6 @@
```json
{
- "op": 0,
- "s": 7,
- "t": "GUILD_UPDATE",
- "d": {
"description": "修改了的频道介绍",
"icon": "https://pub.idqqimg.com/pc/misc/files/20211208/311cfc87ce394c62b7c9f0508658cf25.png",
"id": "200000000",
@@ -58,7 +49,6 @@
"name": "频道名称",
"op_user_id": "100000000",
"owner_id": "100000000"
- }
}
```
@@ -74,10 +64,6 @@
```json
{
- "op": 0,
- "s": 5,
- "t": "GUILD_DELETE",
- "d": {
"description": "频道介绍",
"icon": "https://pub.idqqimg.com/pc/misc/files/20211208/311cfc87ce394c62b7c9f0508658cf25.png",
"id": "200000000",
@@ -87,6 +73,5 @@
"name": "频道名称",
"op_user_id": "100000000",
"owner_id": "100000000"
- }
}
```
diff --git a/docs/develop/api-v2/server-inter/channel/role/guild_member.md b/docs/develop/api-v2/server-inter/channel/role/guild_member.md
index 08627558..3e06d281 100644
--- a/docs/develop/api-v2/server-inter/channel/role/guild_member.md
+++ b/docs/develop/api-v2/server-inter/channel/role/guild_member.md
@@ -16,10 +16,6 @@
```json
{
- "op": 0,
- "s": 5,
- "t": "GUILD_MEMBER_ADD",
- "d": {
"guild_id": "200000000",
"joined_at": "2021-10-21T11:20:18+08:00",
"nick": "",
@@ -33,7 +29,6 @@
"id": "8834102668809967837",
"username": "b站机器人"
}
- }
}
```
@@ -47,10 +42,6 @@
```json
{
- "op": 0,
- "s": 6,
- "t": "GUILD_MEMBER_UPDATE",
- "d": {
"guild_id": "200000000",
"joined_at": "2021-10-21T11:20:18+08:00",
"nick": "",
@@ -62,7 +53,6 @@
"id": "8834102668809967837",
"username": "b站机器人"
}
- }
}
```
@@ -76,10 +66,6 @@
```json
{
- "op": 0,
- "s": 4,
- "t": "GUILD_MEMBER_REMOVE",
- "d": {
"guild_id": "200000000",
"joined_at": "2021-10-21T11:20:18+08:00",
"nick": "",
@@ -93,6 +79,5 @@
"id": "8834102668809967837",
"username": "b站机器人"
}
- }
}
```
diff --git a/docs/develop/api-v2/server-inter/group/manage/event.md b/docs/develop/api-v2/server-inter/group/manage/event.md
index c522bcbe..9e0a39f8 100644
--- a/docs/develop/api-v2/server-inter/group/manage/event.md
+++ b/docs/develop/api-v2/server-inter/group/manage/event.md
@@ -42,15 +42,9 @@
```json
{
- "op": 0,
- "s": 2,
- "t": "GROUP_ADD_ROBOT",
- "id": "GROUP_ADD_ROBOT:39ab91b8-36ee-44d6-80e9-4447a2f2c571",
- "d": {
- "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
- "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240248
- }
+ "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
+ "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240248
}
```
@@ -96,15 +90,9 @@
```json
{
- "op": 0,
- "s": 5,
- "t": "GROUP_DEL_ROBOT",
- "id": "GROUP_DEL_ROBOT:a94f1712-b316-4731-b1f1-9f39474ef4b6",
- "d": {
- "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
- "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240426
- }
+ "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
+ "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240426
}
```
@@ -151,15 +139,9 @@
```json
{
- "op": 0,
- "s": 7,
- "t": "GROUP_MSG_REJECT",
- "id": "GROUP_MSG_REJECT:68f2b039-ae03-44f2-a4d1-b88e5de881cb",
- "d": {
- "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
- "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240458
- }
+ "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
+ "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240458
}
```
@@ -205,15 +187,10 @@
```json
{
- "op": 0,
- "s": 8,
- "t": "GROUP_MSG_RECEIVE",
- "id": "GROUP_MSG_RECEIVE:db4a10f1-0599-4345-bbbb-a2ed194b9c9c",
- "d": {
- "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
- "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240477
- }
+
+ "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
+ "op_member_openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240477
}
```
diff --git a/docs/develop/api-v2/server-inter/message/send-receive/event.md b/docs/develop/api-v2/server-inter/message/send-receive/event.md
index 84ba837b..164b92ec 100644
--- a/docs/develop/api-v2/server-inter/message/send-receive/event.md
+++ b/docs/develop/api-v2/server-inter/message/send-receive/event.md
@@ -42,28 +42,35 @@
| **属性** | **类型** | **说明** |
| --- | --- | --- |
| id | string | 平台方消息ID,可以用于被动消息发送 |
-| author | object | 发送者 {"user_openid": "xxx"} // 用户 openid |
+| author | object | 发送者 |
| content | string | 文本消息内容 |
| timestamp | string | 消息生产时间(RFC3339) |
-| attachments | object[] | 富媒体文件附件,文件类型:"图片,语音,视频,文件"
{"content_type": "", "filename": "", "height": "", "width": "", "size": "", "url": ""} |
+| attachments | object[] | 富媒体文件附件,文件类型:"图片,语音,视频,文件" |
+author对象
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| user_openid | string | 用户 openid |
+attachment对象
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| content_type | string | 文件类型,"image/jpeg","image/png","image/gif","file","video/mp4","voice" |
+| filename | string | 文件名称 |
+| height | int | 图片高度 |
+| width | int | 图片宽度 |
+| size | int | 文件大小 |
+| url | string | 文件链接 |
- **事件示例**
```json
{
- "op": 0,
- "s": 2,
- "t": "C2C_MESSAGE_CREATE",
- "id": "C2C_MESSAGE_CREATE:051c863a-05d1-483d-8fd5-15b4e1d7ea1a",
- "d": {
- "author": {
- "user_openid": "E4F4AEA33253A2797FB897C50B81D7ED"
- },
- "content": "123",
- "id": "ROBOT1.0_.b6nx.CVryAO0nR58RXuU6SC.m92gc19j02qKqdm8ek!",
- "timestamp": "2023-11-06T13:37:18+08:00"
- }
+ "author": {
+ "user_openid": "E4F4AEA33253A2797FB897C50B81D7ED"
+ },
+ "content": "123",
+ "id": "ROBOT1.0_.b6nx.CVryAO0nR58RXuU6SC.m92gc19j02qKqdm8ek!",
+ "timestamp": "2023-11-06T13:37:18+08:00"
}
```
@@ -111,30 +118,29 @@
| **属性** | **类型** | **说明** |
| --- | --- | --- |
| id | string | 平台方消息 ID,可以用于被动消息发送 |
-| author | object | 发送者 {"member_openid": "xxx"} // 用户在本群的 member_openid |
+| author | object | 发送者 |
| content | string | 消息内容 |
| timestamp | string | 消息生产时间(RFC3339) |
| group_openid | string | 群聊的 openid |
-| attachments | object[] | 富媒体文件附件,文件类型:"图片,语音,视频,文件"
{"content_type": "", "filename": "", "height": "", "width": "", "size": "", "url": ""} |
+| attachments | object[] | 富媒体文件附件,文件类型:"图片,语音,视频,文件"|
+
+author对象
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| member_openid | string | 用户在本群的 member_openid |
- **事件示例**
```json
// Websocket
{
- "op": 0,
- "s": 3,
- "t": "GROUP_AT_MESSAGE_CREATE",
- "id": "GROUP_AT_MESSAGE_CREATE:87612938-5b4b-441f-b4aa-2c0266092fe0",
- "d": {
- "author": {
- "member_openid": "E4F4AEA33253A2797FB897C50B81D7ED"
- },
- "content": " 123",
- "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
- "id": "ROBOT1.0_eBIyWnxpmSu6uLQ7u7fU0eGloKGYg4eEa737vRyKnMCgyZjKi7JLYkQ9B0VapbiY",
- "timestamp": "2023-11-06T13:37:18+08:00"
- }
+ "author": {
+ "member_openid": "E4F4AEA33253A2797FB897C50B81D7ED"
+ },
+ "content": " 123",
+ "group_openid": "C9F778FE6ADF9D1D1DBE395BF744A33A",
+ "id": "ROBOT1.0_eBIyWnxpmSu6uLQ7u7fU0eGloKGYg4eEa737vRyKnMCgyZjKi7JLYkQ9B0VapbiY",
+ "timestamp": "2023-11-06T13:37:18+08:00"
}
```
diff --git a/docs/develop/api-v2/server-inter/message/send-receive/send.md b/docs/develop/api-v2/server-inter/message/send-receive/send.md
index ed3b32fd..358920b1 100644
--- a/docs/develop/api-v2/server-inter/message/send-receive/send.md
+++ b/docs/develop/api-v2/server-inter/message/send-receive/send.md
@@ -68,10 +68,10 @@ QQ 用户可以在 QQ 客户端主动设置是否接收机器人发送的主动
| --- | --- | --- | --- |
| content | string | 否 | 文本内容 |
| msg_type | int | 是 | 消息类型:0 是文本,2 是 markdown, 3 ark,4 embed,7 media 富媒体 |
-| markdown | object | 否 | 格式参考"消息类型=\>markdown=\>数据结构与协议" |
-| keyboard | object | 否 | 格式参考"消息交互=\>消息按钮=\>数据结构与协" |
-| ark | object | 否 | 格式参考"消息类型=\>ark=\>数据结构与协议" |
-| media | object | 否 | {file_info: ""} 数据来源"消息收发=\>富媒体消息" |
+| markdown | object | 否 | [Markdown](../type/markdown.md#数据结构与协议)对象 |
+| keyboard | object | 否 | [Keyboard](../trans/msg-btn.md#数据结构与协议)对象 |
+| ark | object | 否 | [Ark](../type/ark.md#数据结构与协议)对象 |
+| media | object | 否 | [富媒体单聊](./rich-media.md#用于单聊)的file_info |
| message_reference | object | 否 | 【暂未支持】消息引用 |
| event_id | string | 否 | 前置收到的事件 ID,用于发送被动消息,支持事件:"INTERACTION_CREATE"、"C2C_MSG_RECEIVE"、"FRIEND_ADD"|
| msg_id | string | 否 | 前置收到的用户发送过来的消息 ID,用于发送被动(回复)消息 |
@@ -131,10 +131,10 @@ QQ 用户可以在 QQ 客户端主动设置是否接收机器人发送的主动
| --- | --- | --- | --- |
| content | string | 是 | 文本内容 |
| msg_type | int | 是 | 消息类型: 0 文本,2 是 markdown,3 ark 消息,4 embed,7 media 富媒体 |
-| markdown | object | 否 | 格式参考"消息类型=\>markdown=\>数据结构与协议" |
-| keyboard | object | 否 | 格式参考"消息交互=\>消息按钮=\>数据结构与协" |
-| media | object | 否 | {file_info: ""} 数据来源"消息收发=\>富媒体消息" |
-| ark | object | 否 | 格式参考"消息类型=\>ark=\>数据结构与协议" |
+| markdown | object | 否 | [Markdown](../type/markdown.md#数据结构与协议)对象 |
+| keyboard | object | 否 | [Keyboard](../trans/msg-btn.md#数据结构与协议)对象 |
+| media | object | 否 | [富媒体群聊](./rich-media.md#用于群聊)的file_info |
+| ark | object | 否 | [Ark](../type/ark.md#数据结构与协议)对象 |
| message_reference | object | 否 | 【暂未支持】消息引用 |
| event_id | string | 否 | 前置收到的事件 ID,用于发送被动消息,支持事件:"INTERACTION_CREATE"、"GROUP_ADD_ROBOT"、"GROUP_MSG_RECEIVE" |
| msg_id | string | 否 | 前置收到的用户发送过来的消息 ID,用于发送被动消息(回复) |
diff --git a/docs/develop/api-v2/server-inter/message/trans/msg-btn.md b/docs/develop/api-v2/server-inter/message/trans/msg-btn.md
index 072c5d6e..3dfe36f1 100644
--- a/docs/develop/api-v2/server-inter/message/trans/msg-btn.md
+++ b/docs/develop/api-v2/server-inter/message/trans/msg-btn.md
@@ -189,32 +189,25 @@
| data.resoloved.feature_id | string | 操作按钮的 id 字段值,仅自定义菜单提供该字段(在管理端设置) |
| data.resoloved.message_id | string | 操作的消息id,目前仅频道场景提供该字段 |
| version | int | 默认 1 |
-| application_id | string | 机器人的 appid |
- **事件示例**
```json
// Websocket
{
- "op": 0,
- "s": 4,
- "t": "INTERACTION_CREATE",
- "id": "INTERACTION_CREATE:b68a29b3-2373-434d-ab7e-76638506237c",
- "d": {
- "application_id": "102041818",
- "chat_type": 2,
- "data": {
- "resolved": {
- "button_data": "回调按钮",
- "button_id": "21",
- "user_id": "E4F4AEA33253A2797FB897C50B81D7ED"
- },
- "type": 11
+ "chat_type": 2,
+ "data": {
+ "resolved": {
+ "button_data": "回调按钮",
+ "button_id": "21",
+ "user_id": "E4F4AEA33253A2797FB897C50B81D7ED"
},
- "id": "30540ff7-9d8f-4737-83f1-e116ce6afa8b",
- "type": 11,
- "version": 1
- }
+ "type": 11
+ },
+ "id": "30540ff7-9d8f-4737-83f1-e116ce6afa8b",
+ "type": 11,
+ "version": 1
+
}
```
diff --git a/docs/develop/api-v2/server-inter/message/type/embed.md b/docs/develop/api-v2/server-inter/message/type/embed.md
index 5456e6e9..13e88cc3 100644
--- a/docs/develop/api-v2/server-inter/message/type/embed.md
+++ b/docs/develop/api-v2/server-inter/message/type/embed.md
@@ -21,14 +21,14 @@ application/json
| 字段名 | 类型 | 描述 |
| ------ | ---------------------------------------- | -------------- |
-| embed | [MessageEmbed](../../template/model.md#messageembed) | embed 消息详情 |
+| embed | [MessageEmbed](../template/model.md#messageembed) | embed 消息详情 |
- 其中 embed.thumbnail 为选填,没有缩略图的可以不填。
- embed.fields.name 为文本。
### 返回
-返回[Message](../../template/model.md#message)对象。
+返回[Message](../template/model.md#message)对象。
### 错误码
diff --git a/docs/develop/api-v2/server-inter/user/manage/event.md b/docs/develop/api-v2/server-inter/user/manage/event.md
index 618446d1..ebfa5b22 100644
--- a/docs/develop/api-v2/server-inter/user/manage/event.md
+++ b/docs/develop/api-v2/server-inter/user/manage/event.md
@@ -41,14 +41,8 @@
```json
{
- "op": 0,
- "s": 4,
- "t": "FRIEND_ADD",
- "id": "FRIEND_ADD:701d1cfb-46cd-4979-9a01-1031819c2e4b",
- "d": {
- "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240365
- }
+ "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240365
}
```
@@ -93,14 +87,8 @@
```json
{
- "op": 0,
- "s": 3,
- "t": "FRIEND_DEL",
- "id": "FRIEND_DEL:bcb31d69-a2b6-4a3e-89dc-077951f22e53",
- "d": {
- "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240328
- }
+ "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240328
}
```
@@ -145,14 +133,8 @@
```json
{
- "op": 0,
- "s": 9,
- "t": "C2C_MSG_REJECT",
- "id": "C2C_MSG_REJECT:5f68ab54-f67e-446c-81e4-2e6e1975eb29",
- "d": {
- "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240599
- }
+ "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240599
}
```
@@ -197,14 +179,8 @@
```json
{
- "op": 0,
- "s": 10,
- "t": "C2C_MSG_RECEIVE",
- "id": "C2C_MSG_RECEIVE:f064381c-360d-4400-9320-ea3dae112ce2",
- "d": {
- "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
- "timestamp": 1699240617
- }
+ "openid": "E4F4AEA33253A2797FB897C50B81D7ED",
+ "timestamp": 1699240617
}
```