Merge pull request #8 from haoxiuwen/doc-shengwang

Change org/app_name to App ID for User-Related Modules
easemob · Dec 28, 2024 · 2348070 · 2348070
2 parents 47a4095 + 5e4507e
commit 2348070
Show file tree

Hide file tree

Showing 44 changed files with 1,403 additions and 1,987 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_attribute.md b/docs/document/server-side/chatroom_attribute.md
@@ -6,21 +6,21 @@
 
 ## 前提条件
 
-要调用环信即时通讯 RESTful API，请确保满足以下要求：
+要调用声网即时通讯 RESTful API，请确保满足以下要求：
 
-- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。
-- 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。
-- 了解聊天室属性相关限制，详见[使用限制](/product/limitation.html#聊天室基本属性)。
+- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置声网即时通讯 IM 服务](enable_im.html)。
+- 已从服务端获取 app token，详见 [使用 Token 鉴权](token_authentication.html)。
+- 了解声网即时通讯 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。
+- 了解聊天室属性相关限制，详见[使用限制](limitation.html#聊天室基本属性)。
 
 ## 公共参数
 
 #### 请求参数
 
 | 参数          | 类型   | 是否必需 | 描述  |
 | :------------ | :----- | :------- | :---------------- |
-| `host`        | String | 是       | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 |
-| `org_name`    | String | 是       | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。  |
-| `app_name`    | String | 是       | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。  |
+| `host`     | String | 是       | 即时通讯 IM 分配的用于访问 RESTful API 的域名。 | 
+| `app_id`     | String | 是       | 声网为每个项目自动分配的 App ID，作为项目唯一标识。 | 
 | `chatroom_id` | String | 是       | 聊天室 ID。  |
 | `username`    | String | 是       | 用户 ID。    |
 | `name`        | String | 是       | 聊天室名称，最大长度为 128 个字符。       |
@@ -32,32 +32,28 @@
 | 参数                 | 类型   | 描述   |
 | :------------------- | :----- | :------------ |
 | `action`             | String | 请求方法。  |
-| `host`               | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。    |
-| `organization`       | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。      |
-| `application`        | String | 系统内为应用生成的唯一标识，开发者无需关心。  |
-| `applicationName`    | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。   |
+| `host`               | String | 即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。    |
 | `uri`                | String | 请求 URL。   |
 | `path`               | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。   |
-| `id`                 | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。    |
+| `id`                 | String | 聊天室 ID，聊天室唯一标识，由声网即时通讯 IM 服务器生成。    |
 | `entities`           | JSON   | 响应实体。  |
 | `data`               | JSON   | 数据详情。 |
-| `uuid`               | String | 系统内为用户或者应用生成的系统内唯一标识，开发者无需关心。   |
 | `created`            | String | 用户、群组或聊天室的创建时间，Unix 时间戳，单位为毫秒。    |
 | `username`           | String | 用户 ID。     |
 | `affiliations_count` | Int    | 聊天室现有成员总数。     |
-| `affiliations`       | Array  | 聊天室现有成员列表，数组类型，包含 `owner` 和 `member` 元素，即聊天室所有者和聊天室成员（包括聊天室管理员）。例如： “affiliations”:[{“owner”: “13800138001”},{“member”:”v3y0kf9arx”},{“member”:”xc6xrnbzci”}]。 |
-| `owner`              | String | 聊天室所有者的用户 ID。例如：{“owner”: “13800138001”}。     |
-| `member`             | String | 聊天室成员的用户 ID，包括聊天室管理员和普通成员的用户 ID。例如：{“member”:”xc6xrnbzci”}。    |
+| `affiliations`       | Array  | 聊天室现有成员列表，数组类型，包含 `owner` 和 `member` 元素，即聊天室所有者和聊天室成员（包括聊天室管理员）。例如： "affiliations":[{"owner": "13800138001"},{"member":"v3y0kf9arx"},{"member":"xc6xrnbzci"}]。 |
+| `owner`              | String | 聊天室所有者的用户 ID。例如：{"owner": "13800138001"}。     |
+| `member`             | String | 聊天室成员的用户 ID，包括聊天室管理员和普通成员的用户 ID。例如：{"member":"xc6xrnbzci"}。    |
 | `timestamp`          | Long   | HTTP 响应的 Unix 时间戳，单位为毫秒。   |
 | `duration`           | Long   | 从发送 HTTP 请求到响应的时长，单位为毫秒。     |
 
 ## 认证方式
 
-环信即时通讯 REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，都必须在请求头部填入如下 `Authorization` 字段：
+声网即时通讯 IM RESTful API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，都必须在请求头部填入如下 `Authorization` 字段：
 
 `Authorization: Bearer YourAppToken`
 
-为提高项目的安全性，环信使用 token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 REST API 推荐使用 app token 的鉴权方式，详见 [使用 App Token 鉴权](easemob_app_token.html)。
+为提高项目的安全性，声网使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 RESTful API 推荐使用 app token 的 鉴权方式，详见 [使用 Token 鉴权](token_authentication.html)。
 
 ## 获取聊天室公告
 
@@ -66,7 +62,7 @@
 #### HTTP 请求
 
 ```http
-GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement
+GET https://{host}/app-id/{app_id}/chatrooms/{chatroom_id}/announcement
 ```
 
 ##### 路径参数
@@ -104,24 +100,21 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcement'
+curl -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/app-id/XXXX/chatrooms/12XXXX11/announcement'
 ```
 
 ##### 响应示例
 
 ```json
 {
   "action": "get",
-  "application": "52XXXXf0",
   "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcement",
   "entities": [],
   "data": {
     "announcement": "XXXX."
   },
   "timestamp": 1542363546590,
-  "duration": 0,
-  "organization": "XXXX",
-  "applicationName": "testapp"
+  "duration": 0
 }
 ```
 
@@ -143,7 +136,7 @@ curl -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 #### HTTP 请求
 
 ```http
-POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement
+POST https://{host}/app-id/{app_id}/chatrooms/{chatroom_id}/announcement
 ```
 
 ##### 路径参数
@@ -186,25 +179,22 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcement' -d '{"announcement" : "聊天室公告…"}'
+curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/app-id/XXXX/chatrooms/12XXXX11/announcement' -d '{"announcement" : "聊天室公告…"}'
 ```
 
 ##### 响应示例
 
 ```json
 {
   "action": "post",
-  "application": "52XXXXf0",
   "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcement",
   "entities": [],
   "data": {
     "id": "12XXXX11",
     "result": true
   },
   "timestamp": 1594808604236,
-  "duration": 0,
-  "organization": "XXXX",
-  "applicationName": "testapp"
+  "duration": 0
 }
 ```
 
@@ -227,7 +217,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -
 #### HTTP 请求
 
 ```http
-PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}
+PUT https://{host}/app-id/{app_id}/metadata/chatroom/{chatroom_id}/user/{username}
 ```
 
 ##### 路径参数
@@ -250,8 +240,8 @@ PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{u
 
 | 参数         | 类型   | 是否必需 | 描述             |
 | :----------- | :----- | :------- | :----------------------- |
-| `metaData`   | JSON   | 是       | 聊天室的自定义属性，存储为键值对（key-value）集合，即 Map<String,String>。该集合中最多可包含 10 个键值对，在每个键值对中，key 为属性名称，最多可包含 128 个字符；value 为属性值，不能超过 4096 个字符。每个聊天室最多可有 100 个自定义属性，每个应用的聊天室自定义属性总大小为 10 GB。<br/> key 支持以下字符集：<br/> • 26 个小写英文字母 a-z；<br/> • 26 个大写英文字母 A-Z；<br/> • 10 个数字 0-9；<br/> • “\_”, “-”, “.”。 |
-| `autoDelete` | String | 否       | 当前成员退出聊天室时是否自动删除该自定义属性。 <br/> • （默认）'DELETE'：是； <br/> • 'NO_DELETE'：否。   |
+| `metaData`   | JSON   | 是       | 聊天室的自定义属性，存储为键值对（key-value）集合，即 Map<String,String>。该集合中最多可包含 10 个键值对，在每个键值对中，key 为属性名称，最多可包含 128 个字符；value 为属性值，不能超过 4096 个字符。每个聊天室最多可有 100 个自定义属性，每个应用的聊天室自定义属性总大小为 10 GB。<br/> key 支持以下字符集：<br/> - 26 个小写英文字母 a-z；<br/> - 26 个大写英文字母 A-Z；<br/> - 10 个数字 0-9；<br/> - “\_”, “-”, “.”。 |
+| `autoDelete` | String | 否       | 当前成员退出聊天室时是否自动删除该自定义属性。 <br/> - （默认）'DELETE'：是； <br/> - 'NO_DELETE'：否。   |
 
 #### HTTP 响应
 
@@ -281,7 +271,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 				"key2": "value2"
     },
     "autoDelete": "DELETE"
- }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1'
+ }' 'https://XXXX/app-id/XXXX/metadata/chatroom/662XXXX13/user/user1'
 ```
 
 ##### 响应示例
@@ -315,7 +305,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 
 ```json
 {
-    "uri": "%s/easemob-demo/chatdemoui/metadata/chatroom",
+    "uri": "https://XXXX/XXXX/XXXX/metadata/chatroom",
     "timestamp": 1720769458528,
     "action": "put",
     "data": {
@@ -335,7 +325,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 #### HTTP 请求
 
 ```http
-POST https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}
+POST https://{host}/app-id/{app_id}/metadata/chatroom/{chatroom_id}
 ```
 
 ##### 路径参数
@@ -379,7 +369,7 @@ POST https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}
 
 curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
     "keys": ["key1","key2"]
- }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13'
+ }' 'https://XXXX/app-id/XXXX/metadata/chatroom/662XXXX13'
 ```
 
 ##### 响应示例
@@ -416,7 +406,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -
 #### HTTP 请求
 
 ```http
-DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}
+DELETE https://{host}/app-id/{app_id}/metadata/chatroom/{chatroom_id}/user/{username}
 ```
 
 ##### 路径参数
@@ -465,7 +455,7 @@ DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user
 
 curl -X DELETE POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
     "keys": ["key1","key2"]
- }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1'
+ }' 'https://XXXX/app-id/XXXX/metadata/chatroom/662XXXX13/user/user1'
 ```
 
 ##### 响应示例
@@ -502,7 +492,7 @@ curl -X DELETE POST -H 'Content-Type: application/json' -H 'Accept: application/
 #### HTTP 请求
 
 ```http
-PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced
+PUT https://{host}/app-id/{app_id}/metadata/chatroom/{chatroom_id}/user/{username}/forced
 ```
 
 ##### 路径参数
@@ -556,7 +546,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 		    "key2": "value2"
     },
     "autoDelete": "DELETE"
- }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1/forced'
+ }' 'https://XXXX/app-id/XXXX/metadata/chatroom/662XXXX13/user/user1/forced'
 ```
 
 ##### 响应示例
@@ -584,7 +574,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 
 ```json
 {
-    "uri": "%s/easemob-demo/chatdemoui/metadata/chatroom",
+    "uri": "https://XXXX/XXXX/XXXX/metadata/chatroom",
     "timestamp": 1720769458528,
     "action": "put",
     "data": {
@@ -608,7 +598,7 @@ curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H
 #### HTTP 请求
 
 ```http
-DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced
+DELETE https://{host}/app-id/{app_id}/metadata/chatroom/{chatroom_id}/user/{username}/forced
 ```
 
 ##### 路径参数
@@ -657,7 +647,7 @@ DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user
 
 curl  -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
     "keys": ["key1","key2"]
- }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1/forced'
+ }' 'https://XXXX/app-id/XXXX/metadata/chatroom/662XXXX13/user/user1/forced'
 ```
 
 ##### 响应示例