Merge pull request #495 from haoxiuwen/doc-v2

Modify REST API JSON Array Format
easemob · Nov 13, 2023 · 3b4b155 · 3b4b155
2 parents 77d3eb0 + 40f087e
commit 3b4b155
Show file tree

Hide file tree

Showing 8 changed files with 325 additions and 325 deletions.
diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md
diff --git a/docs/document/server-side/chatroom.md b/docs/document/server-side/chatroom.md
diff --git a/docs/document/server-side/group.md b/docs/document/server-side/group.md
diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md
@@ -418,7 +418,6 @@ curl -X POST -i 'https://XXXX/XXXX/XXXX/messages/chatrooms' \
   "to": ["185145305923585"],
   "type": "video",
   "body": {
-    "filename" : "test.avi"
     "thumb" : "https://XXXX/XXXX/XXXX/chatfiles/67279b20-7f69-11e4-8eee-21d3334b3a97",
     "length" : 0,"secret":"VfXXXXNb_",
     "file_length" : 58103,

diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md
@@ -92,11 +92,12 @@ POST https://{host}/{org_name}/{app_name}/chatfiles
 
 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段：
 
-| 参数                    | 类型   | 描述                                                                            |
-| :---------------------- | :----- | :------------------------------------------------------------------------------ |
-| `entities.uuid`         | String | 文件 ID，即时通讯服务分配给该文件的唯一标识符。该参数在发送消息时需用到。       |
-| `entities.type`         | String | 文件类型，为固定值 `chatfile`。                                                 |
-| `entities.share-secret` | String | 文件访问密钥。你需要自行保存 `share-secret`，以便 [下载文件](#下载文件)时使用。 |
+| 参数                    | 类型   | 描述         |
+| :---------------------- | :----- | :------------------ |
+| `entities`       | JSON Array | 响应数据。                          |
+|  - `uuid`         | String | 文件 ID，即时通讯服务分配给该文件的唯一标识符。该参数在发送消息时需用到。  |
+|  - `type` | String | 文件类型，为固定值 `chatfile`。   |
+|  - `share-secret` | String | 文件访问密钥。你需要自行保存 `share-secret`，以便 [下载文件](#下载文件)时使用。 |
 
 其他参数及说明详见 [公共参数](#公共参数)。
 

diff --git a/docs/document/server-side/presence.md b/docs/document/server-side/presence.md
@@ -143,11 +143,11 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/presence/{expiry}
 | 字段        | 类型       | 描述                                                         |
 | :---------- | :--------- | :----------------------------------------------------------- |
 | `result`    | JSON Array | 是否成功批量订阅了多个用户的在线状态。若成功，则返回被订阅用户的在线状态信息，失败则返回相应的错误原因。 |
-| `result.uid`       | String     | 被订阅用户在即时通讯服务器的唯一 ID。                              |
-| `result.last_time` | Long    | 被订阅用户的最近在线时间，Unix 时间戳，单位为秒。服务端会在被订阅的用户登录和登出时记录该时间。 |
-| `result.expiry`    | Long    | 订阅过期的 Unix 时间戳，单位为秒。                                           |
-| `result.ext`       | String     | 被订阅用户的在线状态扩展信息。                   |
-| `result.status`    | JSON | 被订阅用户在多端的状态：<br> - `0`：离线；<br> - `1`：在线；<br/> - 其他值：用户可设置其他值自定义在线状态。 |
+|  - `uid`       | String     | 被订阅用户在即时通讯服务器的唯一 ID。                              |
+|  - `last_time` | Long    | 被订阅用户的最近在线时间，Unix 时间戳，单位为秒。服务端会在被订阅的用户登录和登出时记录该时间。 |
+|  - `expiry`    | Long    | 订阅过期的 Unix 时间戳，单位为秒。                                           |
+|  - `ext`       | String     | 被订阅用户的在线状态扩展信息。                   |
+|  - `status`    | JSON | 被订阅用户在多端的状态：<br> - `0`：离线；<br> - `1`：在线；<br/> - 其他值：用户可设置其他值自定义在线状态。 |
 
 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](error.html) 了解可能的原因。
 
@@ -222,10 +222,10 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/presence
 | 参数        | 类型       | 描述                                                         |
 | :---------- | :--------- | :----------------------------------------------------------- |
 | `result`    | JSON Array | 是否成功批量获取用户的在线状态信息。若成功获取，返回被订阅用户的在线状态信息，失败则返回相应的错误原因。 |
-| `result.uid`       | String     | 用户在即时通讯服务器的唯一 ID。                              |
-| `result.last_time` | Long       | 用户的最近在线时间，Unix 时间戳，单位为秒。                                           |
-| `result.ext`       | String     | 用户的在线状态扩展信息。                 |
-| `result.status`    | JSON | 用户在多个设备上的在线状态：<br/> - `0`： 离线。<br/> - `1`： 在线。<br/> - 其他值：用户自定义的在线状态。                                            |
+|  - `uid`       | String     | 用户在即时通讯服务器的唯一 ID。                              |
+|  - `last_time` | Long       | 用户的最近在线时间，Unix 时间戳，单位为秒。                                           |
+|  - `ext`       | String     | 用户的在线状态扩展信息。                 |
+|  - `status`    | JSON | 用户在多个设备上的在线状态：<br/> - `0`： 离线。<br/> - `1`： 在线。<br/> - 其他值：用户自定义的在线状态。                                            |
 
 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](error.html) 了解可能的原因。