Merge pull request #1267 from haoxiuwen/doc-v2

Add Callback Event for Group Read Ack

Author: haoxiuwen

docs/.vuepress/sidebar/document.ts

@@ -490,6 +490,7 @@ const documentSidebar = [
           { text: '用户登入/登出', link: 'callback_login_logout.html' },
           { text: '发送消息', link: 'callback_message_send.html' },
           { text: '发送单聊消息已读回执', link: 'callback_single_read_ack.html' },
+          { text: '发送群聊消息已读回执', link: 'callback_group_read_ack.html' },
           { text: '发送会话已读回执', link: 'callback_single_conversation_ack.html' },
           { text: '修改消息', link: 'callback_message_modify.html' },
           { text: '撤回消息', link: 'callback_message_recall.html' },

docs/document/server-side/callback_group_read_ack.md

@@ -0,0 +1,62 @@
+# 发送群组消息已读回执
+
+成功发送群组消息已读回执后，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。
+
+:::tip
+1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务说明](/product/pricing.html#增值服务费用)。
+2. 如果需要发送群组消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。
+3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。
+:::
+
+## 回调时机
+
+客户端发送群组消息已读回执。
+
+## 回调请求
+
+### 请求示例
+
+下面的请求示例为发送群组消息已读回执。
+
+```json
+{
+    "callId": "XXXX#XXXX_1406088760298309588",
+    "channel_channel": "XXXX#[email protected]",
+    "eventType": "chat",
+    "channel_user": "XXXX#[email protected]",
+    "chat_type": "read_ack",
+    "security": "bc392b82e70e24cc1ea29e08aa41765d",
+    "content_type": "chat:ack:read",
+    "payload": {
+        "ext": {},
+        "ack_message_id": "1406088702140090324",
+        "msg_config": {
+            "allow_group_ack": true
+        },
+        "type": "read_ack"
+    },
+    "writed_channel": false,
+    "host": "easemob@hsb-im-msync0",
+    "appkey": "eXXXX#XXXX",
+    "from": "tst",
+    "to": "277721224642561",
+    "msg_id": "1406088760298309588",
+    "timestamp": 1744945351097
+}
+```
+
+### 请求字段说明
+
+| 字段        | 数据类型 | 含义                                                         |
+| :---------- | :------- | :----------------------------------------------------------- |
+| `callId`    | String   | `callId` 为每个回调请求的唯一标识，格式为 `App Key_回执消息的消息 ID`。 | 
+| `channel_channel` | String   | 群聊消息的已读回执，格式为 `App Key_群组 [email protected]`，例如，示例中的 `easemob-demo#[email protected]`。|
+| `eventType`       | String | `chat`：表示上行消息。                      |
+| `security`  | String   | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 |  
+| `payload`   | object   | 包括：<br/> - `ext`：消息扩展字段<br/> - `ack_message_id`：消息 ID<br/> - `msg_config.allow_group_ack`：是否需要群消息已读回执 <br/> - `type`：`read_ack` 表示消息已读回执。|
+| `host`      | String   | 服务器名称。                                                 |
+| `appkey`    | String   | 你在环信管理后台注册的应用唯一标识。                         |
+| `from`      | String   | 发送已读回执的用户 ID。                                        |
+| `to`        | String   | 群组 ID。  |
+| `msg_id`    | String   | 该回执消息的消息 ID。                                        |
+| `timestamp` | long     | 环信 IM 服务器收到消息已读回执的 Unix 时间戳，单位为 ms。  |

docs/document/server-side/callback_group_room_create.md

@@ -1,4 +1,5 @@
 # 创建群组/聊天室事件 
+
 成功创建群组或聊天室后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看创建的群组/聊天室的信息，进行数据同步。
 
 :::tip

docs/document/server-side/callback_single_read_ack.md

@@ -1,27 +1,28 @@
 # 发送单聊消息已读回执
 
-回调请求主要字段含义：
+成功发送单聊消息已读回执后，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。
 
-| 字段        | 数据类型 | 含义                                                         |
-| :---------- | :------- | :----------------------------------------------------------- |
-| `chat_type` | String   | `read_ack` 已读回执。                                        |
-| `callId`    | String   | `callId` 为每个回调请求的唯一标识，格式为 “App Key_回执消息的消息 ID”。 | 
-| `security`  | String   | 签名，格式如下: `MD5（callId+secret+timestamp）`。 Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 |
-| `payload`   | object   | 包括：<br/> - `ext`：消息扩展字段<br/> - `ack_message_id`：消息 ID<br/> - `bodies`：消息体内容。 |
-| `host`      | String   | 服务器名称。                                                 |
-| `appkey`    | String   | 你在环信管理后台注册的应用唯一标识。                         |
-| `from`      | String   | 发送已读回执用户 ID。                                        |
-| `to`        | String   | 接收已读回执用户 ID。                                        |
-| `eventType` | String   | `chat`：单聊。                                               |
-| `timestamp` | long     | 环信 IM 服务器收到消息已读回执的 Unix 时间戳，单位为 ms。                  |
-| `msg_id`    | String   | 该回执消息的消息 ID。                                        |
+:::tip
+1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务说明](/product/pricing.html#增值服务费用)。
+2. 如果需要发送单聊消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。
+3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。
+:::
+
+## 回调时机
+
+客户端发送单聊消息已读回执。
+
+## 回调请求
 
-回调请求示例：
+### 请求示例
+
+下面的请求示例为发送单聊消息已读回执。
 
 ```json
 {
     "chat_type": "read_ack",
     "callId": "XXXX#XXXX_968665325555943556",
+    "channel_channel": "XXXX#[email protected]",
     "security": "bd63d5fa8f72823e6d33e09a43aa4239",
     "payload": {
         "ext": {},
@@ -36,4 +37,21 @@
     "msg_id": "968665325555943556",
     "timestamp": 1643099771248
 }
-```
+```
+
+### 请求字段说明
+
+| 字段        | 数据类型 | 含义                                                         |
+| :---------- | :------- | :----------------------------------------------------------- |
+| `chat_type` | String   | `read_ack` 已读回执。                                        |
+| `callId`    | String   | `callId` 为每个回调请求的唯一标识，格式为 “App Key_回执消息的消息 ID”。 | 
+| `channel_channel` | String   | 单聊消息的已读回执，格式为 `App Key_接收已读回执用户 [email protected]`，例如，示例中的 `easemob-demo#[email protected]`。|
+| `security`  | String   | 签名，格式如下: `MD5（callId+secret+timestamp）`。 Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 |
+| `payload`   | object   | 包括：<br/> - `ext`：消息扩展字段<br/> - `ack_message_id`：消息 ID<br/> - `bodies`：消息体内容。 |
+| `host`      | String   | 服务器名称。                                                 |
+| `appkey`    | String   | 你在环信管理后台注册的应用唯一标识。                         |
+| `from`      | String   | 发送已读回执用户 ID。                                        |
+| `to`        | String   | 接收已读回执用户 ID。                                        |
+| `eventType` | String   | `chat`：单聊。                                               |
+| `timestamp` | long     | 环信 IM 服务器收到消息已读回执的 Unix 时间戳，单位为 ms。                  |
+| `msg_id`    | String   | 该回执消息的消息 ID。                                        |