From 3ae6d8bed0f28b9890da045419c7dc92eee5a571 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 23 Oct 2023 18:24:36 +0800 Subject: [PATCH] Modify REST API Doc --- docs/document/server-side/chatroom.md | 8 +++--- docs/document/server-side/group.md | 28 +++++++++---------- docs/document/server-side/message_download.md | 6 +++- docs/document/server-side/message_import.md | 4 +-- docs/document/server-side/message_recall.md | 9 +++++- 5 files changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/document/server-side/chatroom.md b/docs/document/server-side/chatroom.md index 30734a72a..6077cbead 100644 --- a/docs/document/server-side/chatroom.md +++ b/docs/document/server-side/chatroom.md @@ -125,9 +125,9 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/super_admin ```shell # 将 替换为你在服务端生成的 App Token -curl -X POST 'https://XXXX/XXXX/XXXX//chatrooms/super_admin' --H 'Authorization: Bearer ' --H 'Content-Type: application/json' +curl -X POST 'https://XXXX/XXXX/XXXX/chatrooms/super_admin' \ +-H 'Authorization: Bearer ' \ +-H 'Content-Type: application/json' \ -d '{ "superadmin": "user1" }' @@ -1247,7 +1247,7 @@ DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user ```shell # 将 替换为你在服务端生成的 App Token -DELETE -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '{ +curl -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '{ "keys": ["key1","key2"] }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1/forced' ``` diff --git a/docs/document/server-side/group.md b/docs/document/server-side/group.md index 489edab7d..5401ef3fe 100644 --- a/docs/document/server-side/group.md +++ b/docs/document/server-side/group.md @@ -399,7 +399,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups?limit={N}&cursor={cursor} | 参数 | 类型 | 是否必需 | 描述 | | :------- | :----- | :------- | :---------------------------------------------------------- | -| `limit` | Int | 否 | 每次期望返回的群组数量。取值范围为 [1,100]，默认值为 `10`。 | +| `limit` | Int | 否 | 每次期望返回的群组数量。取值范围为 [1,1000]，默认值为 `10`。 | | `cursor` | String | 否 | 数据查询的起始位置。 | :::tip @@ -494,7 +494,7 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer 替换为你在服务端生成的 App Token -curl --location --request PUT 'https://a1-hsb.easemob.com/easemob-demo/testy/metadata/chatgroup/207059303858177/user/test2' \ +curl --location --request PUT 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/user/XXXX' \ -H 'Content-Type: application/json' \ --H 'Accept: application/json' --H 'Authorization: Bearer YWMtozZwfsFFEe2oQTE6aob5eQAAAAAAAAAAAAAAAAAAAAExCXvf5bRGAJBgXNYFJVQ9AQMAAAGG2MUClwBPGgDsI1GYg1QtapTEdGyrm29Eu6L8qx60lDZ9TJRDOQjEsw' \ ---data-raw '{ +-H 'Accept: application/json' \ +-H 'Authorization: Bearer ' \ +-d '{ "metaData": { "key1": "value1" } @@ -1829,11 +1829,11 @@ POST https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/get ```shell # 将 替换为你在服务端生成的 App Token -curl --location --request POST 'https://a1-hsb.easemob.com/easemob-demo/testy/metadata/chatgroup/207059303858177/get' \ --H 'Content-Type: application/json' \ --H 'Accept: application/json' --H 'Authorization: Bearer YWMtozZwfsFFEe2oQTE6aob5eQAAAAAAAAAAAAAAAAAAAAExCXvf5bRGAJBgXNYFJVQ9AQMAAAGG2MUClwBPGgDsI1GYg1QtapTEdGyrm29Eu6L8qx60lDZ9TJRDOQjEsw' \ ---data-raw '{ +curl--location--request POST 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/get'\ +-H'Content-Type: application/json'\ +-H'Accept: application/json'\ +-H'Authorization: Bearer '\ +-d '{ "targets":["test1","test2"], "properties":["key1","key2"] }' diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md index a265c6706..f19c4182e 100644 --- a/docs/document/server-side/message_download.md +++ b/docs/document/server-side/message_download.md @@ -108,7 +108,11 @@ POST https://{host}/{org_name}/{app_name}/chatfiles ```shell # 将 替换为你在服务端生成的 App Token，将 file 的路径替换为待上传文件所在的本地完整路径 -curl -X POST https://XXXX/XXXX/XXXX/chatfiles -H 'Authorization: Bearer ' -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -H 'restrict-access: true' -F file=@/Users/test/9.2/easemob/image/IMG_2953.JPG +curl L -X POST 'https://XXXX/XXXX/XXXX/chatfiles' \ +-H 'Authorization: Bearer ' \ +-H 'Content-Type: multipart/form-data; boundary=---WebKitFormBoundary7MA4YWxkTrZu0gW' \ +-H 'restrict-access: true' \ +-F 'file="@/Users/test/9.2/easemob/image/IMG_2953.JPG"' ``` #### 响应示例 diff --git a/docs/document/server-side/message_import.md b/docs/document/server-side/message_import.md index 421792bea..792303caa 100644 --- a/docs/document/server-side/message_import.md +++ b/docs/document/server-side/message_import.md @@ -213,7 +213,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatgroups/import ```shell # 将 替换为你在服务端生成的 App Token curl -X POST -H "Authorization: Bearer " "https://XXXX/XXXX/XXXX/messages/chatgroups/import" -d '{ - "target": "username2", + "target": "1123376564212", "type": "txt", "body": { "msg": "import message." @@ -229,7 +229,7 @@ curl -X POST -H "Authorization: Bearer " "https://XXXX/XXXX/XXXX/ ```shell # 将 替换为你在服务端生成的 App Token curl -X POST -H "Authorization: Bearer " "https://XXXX/XXXX/XXXX/messages/chatgroups/import" -d '{ - "target": "username2", + "target": "1123376564212", "type": "img", "body": { "url": "", diff --git a/docs/document/server-side/message_recall.md b/docs/document/server-side/message_recall.md index 95aaaa910..d598c3a64 100644 --- a/docs/document/server-side/message_recall.md +++ b/docs/document/server-side/message_recall.md @@ -178,7 +178,14 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/user_channel ```shell # 将 替换为你在服务端生成的 App Token -curl -X DELETE -H "Authorization: Bearer " "https://XXXX/XXXX/XXXX/users/u1/user_channel" -d '{"channel":"u2", "type":"chat"，"delete_roam": true}' +curl -L -X DELETE 'https://XXXX/XXXX/XXXX/users/u1/user_channel' \ +-H 'Authorization: Bearer ' \ +-H 'Content-Type: application/json' \ +-H 'Accept: application/json' \ +-d ' + +{ "channel": "u2", "type": "chat", "delete_roam": true } +' ``` #### 响应示例