Merge pull request #654 from haoxiuwen/doc-v2

Add Console Doc for User Device Log & Presence REST API & Conversation Read Ack Callback Event

docs/document/server-side/callback_configurations.md

@@ -2353,13 +2353,41 @@ payload 示例：
 }
 ```
 
-### ack 事件
+### 发送会话已读回执
 
-| 事件         | payload 中类型 | 触发事件     |
-| :----------- | :------------- | :----------- |
-| `read_ack`     | 无             | 发送已读回执 |
+回调请求主要字段含义：
+
+| 字段          | 数据类型 | 含义                                                         |
+| :------------ | :------- | :----------------------------------------------------------- |
+| chat_type | String    |  会话已读回执。           |
+| payload.ack_message_id | String     | 会话中消息的消息 ID。                  |
+| payload.type | 会话已读回执类型。       |                |
+| from | String          | 发送已读回执的用户。|
+| to | String    |  接收已读回执的用户。                 |
+| msg_id | String      | 已读回执消息的消息 ID。 |
+
+会话已读回执的回调请求示例：
+
+```json
+{
+"callId": "easemob-demo#testy_1252106597610555348",
+"eventType": "chat",  
+"chat_type": "channel_ack", 
+"security": "203e3c86710ebdbd776d8aa9cc057b2d",
+"payload": {
+"ack_message_id": "1252106100258375636", 
+"type": "channel_ack" 
+},
+"host": "easemob@hsb-im-msync0",
+"appkey": "easemob-demo#testy",
+"from": "wzy",   
+"to": "wzy1",   
+"msg_id": "1252106597610555348",  
+"timestamp": 1709093585046
+}
+```
 
-#### 发送已读回执
+#### 发送消息已读回执
 
 回调请求主要字段含义：
 

docs/document/server-side/presence.md

@@ -115,6 +115,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/presence/{expiry}
 
 | 参数     | 类型  | 是否必需 | 描述                                |
 | :------- | :----- | :---------------- | :------- |
+| `username` | String | 是 | 为哪个用户订阅在线状态。|
 | `expiry` | String | 是  | 订阅时长，单位为秒，最大值为 `2,592,000`，即 30 天。  |
 
 其他参数及描述详见 [公共参数](#公共参数)。
@@ -200,6 +201,10 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/presence
 
 #### 路径参数
 
+| 参数     | 类型  | 是否必需 | 描述                                |
+| :------- | :----- | :---------------- | :------- |
+| `username` | String | 是 | 获取哪个用户订阅的在线状态。若传入的用户 ID 不存在或未订阅其他用户的在线状态，返回空列表。|
+
 参数及描述详见 [公共参数](#公共参数)。
 
 #### 请求 header
@@ -337,6 +342,10 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/presence
 
 ### 路径参数
 
+| 参数     | 类型  | 是否必需 | 描述                                |
+| :------- | :----- | :---------------- | :------- |
+| `username` | String | 是 | 为哪个用户取消订阅的在线状态。|
+
 参数及描述详见 [公共参数](#公共参数)。
 
 ### 请求 header
@@ -392,6 +401,10 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/presence/sublist?pageN
 
 #### 路径参数
 
+| 参数     | 类型  | 是否必需 | 描述                                |
+| :------- | :----- | :---------------- | :------- |
+| `username` | String | 是 | 查询哪个用户的订阅列表。若传入的用户 ID 不存在或未订阅其他用户的在线状态，返回空列表。|
+
 参数及描述详见 [公共参数](#公共参数)。
 
 #### 查询参数

docs/product/enable_and_configure_IM.md

@@ -369,6 +369,26 @@
 
 要添加聊天室成员，选择 **查看聊天室成员**，在弹出的对话框中，输入用户 ID，点击 **添加成员**。成员添加后会显示在下方的成员列表中，你可以移除该成员。
 
+## IM 用户设备日志
+
+环信即时通讯云控制台支持查询用户设备端的日志，或将设备端的日志上传到环信日志服务器。目前，仅支持使用了高于 3.3.2 的 Android/iOS SDK 的设备。
+
+![img](@static/images/product/enable_and_configure/user_device_log.png)
+
+### 上传设备日志到环信日志服务器
+
+输入用户 ID 后，点击**下发上传log指令**，服务端将对指定用户设备下发指令：
+
+- 如果当前用户在线，则会开始上传设备日志，正常情况预计 5s 内可完成上传。
+
+- 如果当前用户不在线，则需要等用户下次上线时开始上传设备日志，日志保留时间为 7 天。
+
+上传指令和日志保留时间为 7 天，即如果下发指令后 7 天内用户均未上线，则 7 天后指令失效，不会触发上传日志。
+
+### 查询用户设备端日志
+
+输入用户 ID 后，点击**查询**，查询用户设备端的日志。若设备已上传日志，则会查询到；若设备未上传过日志，则查询不到。
+
 ## 账户中心
 
 登录环信即时通讯云控制台，选择 **费用中心** > **账户中心**，可查看你当前的账户余额和支出明细。