diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md index ed4b887a5..9eeaa2279 100644 --- a/docs/document/server-side/account_system.md +++ b/docs/document/server-side/account_system.md @@ -26,12 +26,13 @@ | `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | -| `entities` | JSON | 响应实体。 | +| `entities` | JSON Array | 响应实体。 | | - `uuid` | String | 用户的 UUID。即时通讯服务为该请求中的 app 或用户生成的唯一内部标识，用于生成 User Token。 | | - `type` | String | 对象类型，无需关注。 | | - `created` | Long | 注册用户的 Unix 时间戳，单位为毫秒。 | | - `modified` | Long | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | | - `username` | String | 用户 ID。 | +| - `nickname` | String | 推送消息时，在消息推送通知栏内显示的昵称。 | | - `activated` | Bool | 用户是否为正常状态：
- `true`：用户为正常状态。
- `false`：用户为封禁状态。如要使用已被封禁的用户账户，你需要调用[解禁用户](#账号解禁)方法解除封禁。 | | `data` | JSON | 实际获取的数据详情。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | @@ -86,11 +87,7 @@ POST https://{host}/{org_name}/{app_name}/users 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------ | :----- | :--------------------------------------------- | -| `entities.username` | String | 用户 ID。 | - -其他字段及说明详见 [公共参数](#公共参数)。 +响应字段及说明详见 [公共参数](#公共参数)。 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html)了解可能的原因。 @@ -168,11 +165,7 @@ POST https://{host}/{org_name}/{app_name}/users 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------ | :----- | :---------------------------------------------------------------------------------------------------------- | -| `entities.username` | String | 用户 ID。 | - -其他字段及说明详见 [公共参数](#公共参数)。 +响应字段及描述详见 [公共参数](#公共参数)。 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html)了解可能的原因。 @@ -232,9 +225,9 @@ POST https://{host}/{org_name}/{app_name}/users ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | -| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :------------------ | +| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | ##### 请求 body @@ -243,8 +236,8 @@ POST https://{host}/{org_name}/{app_name}/users 单次请求最多可注册 60 个用户 ID。 ::: -| 参数 | 类型 | 是否必需 | 描述 | -| :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :----------------------------- | | `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：
- 26 个小写英文字母 a-z；
- 26 个大写英文字母 A-Z；
- 10 个数字 0-9；
- “\_”, “-”, “.”。

- 该参数不区分大小写，因此 `Aa` 和 `aa` 为相同用户名；
- 请确保同一个 app 下，用户 ID 唯一；
- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。 | | `password` | String | 是 | 用户的登录密码，长度不可超过 64 个字符。 | @@ -254,11 +247,7 @@ POST https://{host}/{org_name}/{app_name}/users 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------ | :----- | :--------------------------------------------- | -| `entities.username` | String | 用户 ID。 | - -其他字段及说明详见 [公共参数](#公共参数)。 +响应字段及描述详见 [公共参数](#公共参数)。 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -386,18 +375,17 @@ GET https://{host}/{org_name}/{app_name}/users/{username} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :-------------------------------------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entities.username` | String | 用户 ID。 | -| `entities.nickname` | String | 推送消息时，在消息推送通知栏内显示的用户昵称。 | -| `entities.notification_display_style` | Int | 消息推送方式：
- `0`：仅通知。推送标题为“您有一条新消息”，推送内容为“请点击查看”；
- `1`：通知以及消息详情。推送标题为“您有一条新消息”，推送内容为发送人昵称和离线消息的内容。
若用户未设置该参数，则响应中不返回。 | -| `entities.notification_no_disturbing` | Bool | 是否开启免打扰。
- `true`：免打扰开启。若用户未设置该参数，则响应中不返回。
- `false`：免打扰关闭。 | -| `entities.notification_no_disturbing_start` | String | 免打扰的开始时间。例如，“8” 代表每日 8:00 开启免打扰。若用户未设该参数，则响应中不返回。 | -| `entities.notification_no_disturbing_end` | String | 免打扰的结束时间。例如，“18” 代表每日 18:00 关闭免打扰。若用户未设该参数，则响应中不返回。 | -| `entities.notification_ignore_63112447328257` | Bool | 是否屏蔽了群组消息的离线推送的设置。参数中的数字，例如 `63112447328257` 表示群组 ID。
-`true`：已屏蔽。
- `false`：未屏蔽。若用户未设该参数，则响应中不返回。 | -| `entities.notifier_name` | String | 客户端推送证书名称。若用户未设置推送证书名称，则响应中不返回。 | -| `entities.device_token` | String | 推送 token。若用户没有推送 token，则响应中不返回。 | -| `count` | Int | 用户数量。 | +| 字段 | 类型 | 描述 | +| :------------ | :----- | :------------ | +| `entities` | JSON Array | 响应实体。 | +| - `notification_display_style` | Int | 消息推送方式：
- `0`：仅通知。推送标题为“您有一条新消息”，推送内容为“请点击查看”；
- `1`：通知以及消息详情。推送标题为“您有一条新消息”，推送内容为发送人昵称和离线消息的内容。
若用户未设置该参数，则响应中不返回。 | +| - `notification_no_disturbing` | Boolean | 是否开启免打扰。
- `true`：免打扰开启。若用户未设置该参数，则响应中不返回。
- `false`：免打扰关闭。 | +| - `notification_no_disturbing_start` | String | 免打扰的开始时间。例如，“8” 代表每日 8:00 开启免打扰。若用户未设该参数，则响应中不返回。 | +| - `notification_no_disturbing_end` | String | 免打扰的结束时间。例如，“18” 代表每日 18:00 关闭免打扰。若用户未设该参数，则响应中不返回。 | +| - `notification_ignore_63112447328257` | Bool | 是否屏蔽了群组消息的离线推送的设置。参数中的数字，例如 `63112447328257` 表示群组 ID。
-`true`：已屏蔽。
- `false`：未屏蔽。若用户未设该参数，则响应中不返回。 | +| - `notifier_name` | String | 客户端推送证书名称。若用户未设置推送证书名称，则响应中不返回。 | +| - `device_token` | String | 推送 token。若用户没有推送 token，则响应中不返回。 | +| `count` | Int | 用户数量。 | 其他字段及说明详见 [公共参数](#公共参数)。 @@ -455,16 +443,16 @@ GET https://{host}/{org_name}/{app_name}/users?limit={N}&cursor={cursor} ##### 查询参数 -| 参数 | 类型 | 是否必需 | 描述 | -| :------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `limit` | Int | 否 | 请求查询用户的数量。取值范围为 [1,100]，默认值为 10。若实际用户数量超过 100，返回 100 个用户。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :------- | :----- | :------- | :--------------- | +| `limit` | Int | 否 | 请求查询用户的数量。取值范围为 [1,100]，默认值为 10。若实际用户数量超过 100，返回 100 个用户。 | | `cursor` | String | 否 | 开始获取数据的游标位置，用于分页显示用户列表。第一次发起批量查询用户请求时若不设置 `cursor`，请求成功后会获得第一页用户列表。从响应 body 中获取 `cursor`，并在下一次请求的 URL 中传入该 `cursor`，直到响应 body 中不再有 `cursor` 字段，则表示已查询到 app 中所有用户。 | ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | -| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :---------------------------- | +| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | #### HTTP 响应 @@ -473,19 +461,18 @@ GET https://{host}/{org_name}/{app_name}/users?limit={N}&cursor={cursor} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :-------------------------------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `entities.username` | String | 用户 ID。 | -| `entities.nickname` | String | 推送消息时，在消息推送通知栏内显示的用户昵称。 | -| `entities.notification_display_style` | Int | 消息推送方式：
- `0`：仅通知。推送标题为“您有一条新消息”，推送内容为“请点击查看”；
- `1`：通知以及消息详情。推送标题为“您有一条新消息”，推送内容为发送人昵称和离线消息的内容。
若用户未设置该参数，则响应中不会返回。 | -| `entities.notification_no_disturbing` | Bool | 是否开启免打扰模式。
- `true`：免打扰开启。若用户未设置改参数，则响应中不返回。
- `false`：代表免打扰关闭。 | -| `entities.notification_no_disturbing_start` | String | 免打扰的开始时间。例如，`8` 代表每日 8:00 开启免打扰。若用户未设该参数，则响应中不返回。 | -| `entities.notification_no_disturbing_end` | String | 免打扰的结束时间。例如，`18` 代表每日 18:00 关闭免打扰。若用户未设该参数，则响应中不返回。 | -| `entities.notification_ignore_63112447328257` | Bool | 是否屏蔽了群组消息的离线推送的设置。数字表示群组 ID。
-`true`：已屏蔽。
- `false`：未屏蔽，没有设置则不会返回。 | -| `entities.notifier_name` | String | 客户端推送证书名称。若用户未设置推送证书名称，则响应中不返回。 | -| `entities.device_token` | String | 推送 token。若用户没有推送 token，则响应中不返回。 | +| 字段 | 类型 | 描述 | +| :-------------------------------------------- | :----- | :------------------------------- | +| `entities`| JSON Array | 响应实体。 | +| - `notification_display_style` | Int | 消息推送方式：
- `0`：仅通知。推送标题为“您有一条新消息”，推送内容为“请点击查看”；
- `1`：通知以及消息详情。推送标题为“您有一条新消息”，推送内容为发送人昵称和离线消息的内容。
若用户未设置该参数，则响应中不会返回。 | +| - `notification_no_disturbing` | Bool | 是否开启免打扰模式。
- `true`：免打扰开启。若用户未设置改参数，则响应中不返回。
- `false`：代表免打扰关闭。 | +| - `notification_no_disturbing_start` | String | 免打扰的开始时间。例如，`8` 代表每日 8:00 开启免打扰。若用户未设该参数，则响应中不返回。 | +| - `notification_no_disturbing_end` | String | 免打扰的结束时间。例如，`18` 代表每日 18:00 关闭免打扰。若用户未设该参数，则响应中不返回。 | +| - `notification_ignore_63112447328257` | Bool | 是否屏蔽了群组消息的离线推送的设置。数字表示群组 ID。
-`true`：已屏蔽。
- `false`：未屏蔽，没有设置则不会返回。 | +| - `notifier_name` | String | 客户端推送证书名称。若用户未设置推送证书名称，则响应中不返回。 | +| - `device_token` | String | 推送 token。若用户没有推送 token，则响应中不返回。 | | `cursor` | String | 游标，用于分页显示用户列表。
第一次发起批量查询用户请求时无需设置 `cursor`，请求成功后，从响应 body 中获取 `cursor`，并在下一次请求的 URL 中传入该 `cursor`，直到响应 body 中不再有 `cursor` 字段，则表示已查询到 app 中所有用户。 | -| `count` | Number | 返回用户数量。 | +| `count` | Number | 返回用户数量。 | 其他字段及说明详见 [公共参数](#公共参数)。 @@ -619,12 +606,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 参数 | 类型 | 描述 | -| :------------------ | :----- | :--------------------- | -| `entities.username` | String | 删除的账号的用户 ID。 | -| `entities.nickname` | String | 删除的账号的用户昵称。 | - -其他字段及说明详见 [公共参数](#公共参数)。 +响应字段及描述详见 [公共参数](#公共参数)。 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -700,12 +682,7 @@ DELETE https://{host}/{org_name}/{app_name}/users?limit={N}&cursor={cursor} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------ | :----- | :--------------------- | -| `entities.username` | String | 删除的账号的用户 ID。 | -| `entities.nickname` | String | 删除的账号的用户昵称。 | - -其他字段及说明详见 [公共参数](#公共参数)。 +响应字段及说明详见 [公共参数](#公共参数)。 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -925,7 +902,7 @@ POST https://{host}/{org_name}/{app_name}/users/batch/status | 字段 | 类型 | 描述 | | :------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------- | | `action` | String | 执行的操作。在该响应中，该参数的值为 `get batch user status`，表示批量获取用户在线状态。 | -| `data` | JSONArray | 查询的用户的在线状态，数据格式为："用户 ID": "当前在线状态"，例如，user1 的在线和离线状态分别为 "user1": "online" 和 "user1": "offline"。 | +| `data` | JSON Array | 查询的用户的在线状态，数据格式为："用户 ID": "当前在线状态"，例如，user1 的在线和离线状态分别为 "user1": "online" 和 "user1": "offline"。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -992,10 +969,10 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/resources | 参数 | 类型 | 描述 | |:---------|:-------|:-----------------| -| data | JSON Array | 已登录设备的列表。 | -| data.res | String | 已登录设备的资源 ID，即服务器分配给每个设备资源的唯一标识符。资源 ID 的格式为 `{device type}_{resource ID}`，其中设备类型 `device type` 可以是 `android`、`ios` 或 `web`，`resource ID` 由 SDK 分配。例如，`android_123423453246`。| -| data.device_uuid | String | 已登录设备的 UUID。 | -| data.device_name | String | 已登录设备的名称。 | +| `data` | JSON Array | 已登录设备的列表。 | +| - `res` | String | 已登录设备的资源 ID，即服务器分配给每个设备资源的唯一标识符。资源 ID 的格式为 `{device type}_{resource ID}`，其中设备类型 `device type` 可以是 `android`、`ios` 或 `web`，`resource ID` 由 SDK 分配。例如，`android_123423453246`。| +| - `device_uuid` | String | 已登录设备的 UUID。 | +| - `device_name` | String | 已登录设备的名称。 | 其他参数及说明详见 [公共参数](#公共参数)。 @@ -1063,19 +1040,19 @@ POST https://{host}/{org_name}/{app_name}/mutes ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | -| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :----------------------------- | +| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | ##### 请求 body -| 参数 | 类型 | 是否必需 | 描述 | -| :---------- | :----- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `username` | String | 是 | 设置全局禁言的用户 ID。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :---------- | :----- | :------- | :----------------------- | +| `username` | String | 是 | 设置全局禁言的用户 ID。 | | `chat` | Int | 否 | 单聊禁言时长，单位为秒，最大值为 `2147483647`。
- > `0`：该用户 ID 的单聊禁言时长。
- `0`：取消该用户的单聊禁言。
- `-1`：该用户被设置永久单聊禁言。
- 其他负值无效。 | -| `groupchat` | Int | 否 | 群组禁言时长，单位为秒，规则同单聊禁言。 | -| `chatroom` | Int | 否 | 聊天室禁言时长，单位为秒，规则同单聊禁言。 | +| `groupchat` | Int | 否 | 群组禁言时长，单位为秒，规则同单聊禁言。 | +| `chatroom` | Int | 否 | 聊天室禁言时长，单位为秒，规则同单聊禁言。 | #### HTTP 响应 @@ -1232,16 +1209,16 @@ GET https://{host}/{org_name}/{app_name}/mutes ##### 响应 body -如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： +如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中的 `data` 字段描述如下： -| 字段 | 类型 | 描述 | -| :-------------------- | :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data.data` | JSONArray | 获取的所有全局禁言的用户的信息。 | -| `data.data.username` | String | 设置禁言的用户 ID。 | -| `data.data.chat` | Int | 单聊消息剩余禁言时间，单位为秒。最大值为 `2147483647`。
- > 0：该用户 ID 具体的单聊消息禁言时长。
- `0`：该用户的单聊消息禁言已取消。
- `-1`：该用户被设置永久单聊消息禁言。 | -| `data.data.groupchat` | Int | 群组消息剩余禁言时长，单位为秒，规则同上。 | -| `data.data.chatroom` | Int | 聊天室消息剩余禁言时长，单位为秒，规则同上。 | -| `data.unixtime` | Long | 当前操作的 Unix 时间戳，单位为毫秒。 | +| 字段 | 类型 | 描述 | +| :-------------------- | :-------- | :---------------------- | +| `data` | JSON Array | 获取的所有全局禁言的用户的信息。 | +| - `username` | String | 设置禁言的用户 ID。 | +| - `chat` | Int | 单聊消息剩余禁言时间，单位为秒。最大值为 `2147483647`。
- > 0：该用户 ID 具体的单聊消息禁言时长。
- `0`：该用户的单聊消息禁言已取消。
- `-1`：该用户被设置永久单聊消息禁言。 | +| - `groupchat` | Int | 群组消息剩余禁言时长，单位为秒，规则同上。| +| - `chatroom` | Int | 聊天室消息剩余禁言时长，单位为秒，规则同上。 | +| - `unixtime` | Long | 当前操作的 Unix 时间戳，单位为毫秒。 | 其他字段及说明详见 [公共参数](#公共参数)。 @@ -1473,8 +1450,6 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/deactivate | 参数 | 类型 | 描述 | | :------------------ | :----- | :--------------------------------------------------------------------------- | | `action` | String | 执行的操作。在该响应中，该参数的值为 `Deactivate user`，表示对账号进行封禁。 | -| `entities.username` | String | 被封禁的用户 ID。 | -| `entities.nickname` | String | 被封禁的用户昵称。 | 其他字段及说明详见[公共参数](#公共参数)。 diff --git a/docs/document/server-side/chatroom.md b/docs/document/server-side/chatroom.md index 348918164..d35424e57 100644 --- a/docs/document/server-side/chatroom.md +++ b/docs/document/server-side/chatroom.md @@ -19,48 +19,48 @@ | 成员角色 | 描述 | 管理权限 | | :----------- | :------------------------------------------------- | :--------------------------------- | -| 普通成员 | 不具备管理权限的聊天室成员。 | 普通成员可以修改自己的聊天室信息。 | -| 聊天室管理员 | 由聊天室创建者授权，协助聊天室管理，具有管理权限。 | 管理员可以管理聊天室内的普通成员。 最多支持添加 99 个管理员。 | +| 普通成员 | 不具备管理权限的聊天室成员。 | 普通成员可以修改自己的聊天室信息。 | +| 聊天室管理员 | 由聊天室创建者授权，协助聊天室管理，具有管理权限。 | 管理员可以管理聊天室内的普通成员。 最多支持添加 99 个管理员。 | | 聊天室所有者 | 聊天室的创建者，具有聊天室最高权限。 | 聊天室所有者可以指定聊天室管理员、解散聊天室、更改聊天室信息、管理聊天室成员。 | ## 公共参数 ### 请求参数 -| 参数 | 类型 | 是否必需 | 描述 | -| :------------ | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :------------ | :----- | :------- | :---------------- | | `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-的信息)。 | -| `chatroom_id` | String | 是 | 聊天室 ID。 | -| `username` | String | 是 | 用户 ID。 | -| `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | -| `description` | String | 是 | 聊天室描述，最大长度为 512 个字符。 | -| `maxusers` | Int | 否 | 聊天室成员数上限，创建聊天室时设置。该参数的默认最大值为 10,000，如需调整请联系商务。 | +| `chatroom_id` | String | 是 | 聊天室 ID。 | +| `username` | String | 是 | 用户 ID。 | +| `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | +| `description` | String | 是 | 聊天室描述，最大长度为 512 个字符。 | +| `maxusers` | Int | 否 | 聊天室成员数上限，创建聊天室时设置。该参数的默认最大值为 10,000，如需调整请联系商务。 | ### 响应参数 -| 参数 | 类型 | 描述 | -| :------------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | String | 请求方法。 | -| `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | -| `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | -| `uri` | String | 请求 URL。 | -| `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | -| `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | -| `entities` | JSON | 响应实体。 | -| `data` | JSON | 数据详情。 | -| `uuid` | String | 系统内为用户或者应用生成的系统内唯一标识，开发者无需关心。 | -| `created` | String | 用户、群组或聊天室的创建时间，Unix 时间戳，单位为毫秒。 | -| `username` | String | 用户 ID。 | -| `affiliations_count` | Int | 聊天室现有成员总数。 | +| 参数 | 类型 | 描述 | +| :------------------- | :----- | :------------ | +| `action` | String | 请求方法。 | +| `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | +| `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | +| `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | +| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `uri` | String | 请求 URL。 | +| `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | +| `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”}。 | -| `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | -| `duration` | Long | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | +| `owner` | String | 聊天室所有者的用户 ID。例如：{“owner”: “13800138001”}。 | +| `member` | String | 聊天室成员的用户 ID，包括聊天室管理员和普通成员的用户 ID。例如：{“member”:”xc6xrnbzci”}。 | +| `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | +| `duration` | Long | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | ## 认证方式 @@ -409,8 +409,8 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/joined_chatrooms?pagen ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :------------- | | `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | @@ -422,8 +422,9 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/joined_chatrooms?pagen | 字段 | 类型 | 描述 | | :---------- | :----- | :-------------------------------------------------------- | -| `data.id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | -| `data.name` | String | 聊天室名称，最大长度为 128 字符。 | +| `data` | JSON Array | 聊天室详情。 | +| - `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | +| - `name` | String | 聊天室名称，最大长度为 128 字符。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -507,20 +508,20 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data.id` | String | 聊天室 ID，聊天室唯一标识符，由环信即时通讯 IM 服务器生成。 | -| `data.name` | String | 聊天室名称。 | -| `data.description` | String | 聊天室描述。 | -| `data.membersonly` | Bool | 加入聊天室是否需要群主或者群管理员审批：
- `true`：是。
- `false`：否。 | +| 字段 | 类型 | 描述 | +| :------------------------ | :----- | :----------------- | +| `data.id` | String | 聊天室 ID，聊天室唯一标识符，由环信即时通讯 IM 服务器生成。 | +| `data.name` | String | 聊天室名称。 | +| `data.description` | String | 聊天室描述。 | +| `data.membersonly` | Bool | 加入聊天室是否需要群主或者群管理员审批：
- `true`：是。
- `false`：否。 | | `data.allowinvites` | Bool | 是否允许聊天室成员邀请其他用户加入该聊天室：
- `true`：允许聊天室成员邀请他人加入该聊天室。
- `false`：仅聊天室所有者和管理员可邀请他人加入该聊天室。 | | `data.maxusers` | Int | 聊天室成员数上限，创建聊天室时设置。 | | `data.owner` | String | 聊天室所有者的用户 ID。例如：{“owner”: “user1”}。 | | `data.created` | Long | 创建聊天室时间，Unix 时间戳，单位为毫秒。 | -| `data.custom` | String | 聊天室扩展信息。 | -| `data.affiliations_count` | Int | 现有聊天室成员总数。 | -| `data.affiliations` | Array | 现有聊天室成员列表，包含聊天室所有者和成员（包括聊天室管理员）。例如：“affiliations”:[{“owner”: “user1”},{“member”:”user2”},{“member”:”user3”}]。 | -| `data.public` | Bool | 预留字段，无需关注。 | +| `data.custom` | String | 聊天室扩展信息。 | +| `data.affiliations_count` | Int | 现有聊天室成员总数。 | +| `data.affiliations` | Array | 现有聊天室成员列表，包含聊天室所有者和成员（包括聊天室管理员）。例如：“affiliations”:[{“owner”: “user1”},{“member”:”user2”},{“member”:”user3”}]。 | +| `data.public` | Bool | 预留字段，无需关注。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -1302,9 +1303,10 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?pagenum={ | 参数 | 类型 | 描述 | | :------------ | :----- | :-------------- | -| `data.owner` | String | 聊天室所有者的用户 ID。例如：{“owner”: “user1”}。 | -| `data.member` | String | 普通聊天室成员或聊天室管理员的用户 ID。例如：{“member”:“user2”}。 | -| `count` | Number | 本次调用获取的聊天室成员数量。 | +| `data` | JSON Array | 聊天室成员信息。 | +| - `owner` | String | 聊天室所有者的用户 ID。例如：{“owner”: “user1”}。 | +| - `member` | String | 普通聊天室成员或聊天室管理员的用户 ID。例如：{“member”:“user2”}。 | +| `count` | Number | 本次调用获取的聊天室成员数量。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -1364,8 +1366,8 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :---------- | | `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | | `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | @@ -1577,8 +1579,8 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{userna ##### 路径参数 -| 参数 | 类型 | 是否必需 | 描述 | -| :--------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------ | +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :------------------ | | `username` | String | 是 | 要移除的一个或多个用户 ID。每次最多可传 100 个用户 ID，用户 ID 之间用英文逗号（","）分隔，逗号在 URL 中转义为 "%2C"。| 其他字段及描述详见 [公共参数](#公共参数)。 @@ -1587,7 +1589,7 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{userna | 参数 | 类型 | 是否必需 | 描述 | | :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | -| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | +| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | #### HTTP 响应 @@ -1598,11 +1600,12 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{userna | 参数 | 类型 | 描述 | | :------------ | :----- | :-------------------------------------------------------------------- | -| `data.result` | Bool | 是否成功批量移除聊天室成员：
- `true`：是；
- `false`：否。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_member`，表示移除成员。 | -| `data.reason` | String | 移除失败的原因。 | -| `data.user` | String | 已删除成员的用户 ID 列表。 | -| `data.id` | String | 聊天室 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 是否成功批量移除聊天室成员：
- `true`：是；
- `false`：否。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_member`，表示移除成员。 | +| - `reason` | String | 移除失败的原因。 | +| - `user` | String | 已删除成员的用户 ID 列表。 | +| - `id` | String | 聊天室 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2007,10 +2010,10 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | -| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | -| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :----------------- | +| `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | +| `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | #### 请求 body @@ -2027,11 +2030,12 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users | 字段 | 类型 | 描述 | | :---------------- | :----- | :-------------------------------------------------------------------------------- | -| `data.result` | Bool | 是否成功批量添加用户至聊天室黑名单：
- `true`：是；
- `false`：否。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `add_blocks`，表示向聊天室黑名单中添加用户。 | -| `data.reason` | String | 添加失败的原因。 | -| `data.user` | String | 添加的用户 ID。 | -| `data.chatroomid` | String | 聊天室 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `result` | Bool | 是否成功批量添加用户至聊天室黑名单：
- `true`：是；
- `false`：否。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `add_blocks`，表示向聊天室黑名单中添加用户。 | +| - `reason` | String | 添加失败的原因。 | +| - `user` | String | 添加的用户 ID。 | +| - `chatroomid` | String | 聊天室 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2184,10 +2188,11 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users | 字段 | 类型 | 描述 | | :---------------- | :----- | :--------------------------------------------------------------------------------- | -| `data.result` | Bool | 是否成功将用户批量移出聊天室黑名单：
- `true`：是；
- `false`：否。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_blocks`，表示将用户移出聊天室黑名单。 | -| `data.user` | String | 被移除的用户 ID。 | -| `data.chatroomid` | String | 聊天室 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `result` | Bool | 是否成功将用户批量移出聊天室黑名单：
- `true`：是；
- `false`：否。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_blocks`，表示将用户移出聊天室黑名单。 | +| - `user` | String | 被移除的用户 ID。 | +| - `chatroomid` | String | 聊天室 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2407,11 +2412,12 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users | 字段 | 类型 | 描述 | | :---------------- | :----- | :-------------------------------------------------------------------------------------- | -| `data.result` | Bool | 是否成功将用户批量添加至聊天室白名单：
- `true`：是；
- `false`：否。 | -| `data.reason` | String | 添加失败的原因。 | -| `data.chatroomid` | String | 聊天室 ID。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `add_user_whitelist`，表示添加用户至聊天室白名单。 | -| `data.user` | String | 添加至聊天室白名单中的用户 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 是否成功将用户批量添加至聊天室白名单：
- `true`：是；
- `false`：否。 | +| - `reason` | String | 添加失败的原因。 | +| - `chatroomid` | String | 聊天室 ID。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `add_user_whitelist`，表示添加用户至聊天室白名单。 | +| - `user` | String | 添加至聊天室白名单中的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2489,10 +2495,11 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/ | 字段 | 类型 | 描述 | | :---------------- | :----- | :----------------------------------------------------------------------------------------- | -| `data.result` | Bool | 是否成功将用户移出聊天室白名单：
- `true`：是；
- `false`：否。 | -| `data.chatroomid` | String | 聊天室 ID。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_user_whitelist`，表示将用户移出聊天室白名单。 | -| `data.user` | String | 移除聊天室白名单的用户 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `result` | Bool | 是否成功将用户移出聊天室白名单：
- `true`：是；
- `false`：否。 | +| - `chatroomid` | String | 聊天室 ID。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_user_whitelist`，表示将用户移出聊天室白名单。 | +| - `user` | String | 移除聊天室白名单的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2569,8 +2576,9 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute | 字段 | 类型 | 描述 | | :------------ | :----- | :----------------------------------- | -| `data.expire` | Long | 禁言到期的 Unix 时间戳，单位为毫秒。 | -| `data.user` | String | 被禁言的用户 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `expire` | Long | 禁言到期的 Unix 时间戳，单位为毫秒。 | +| - `user` | String | 被禁言的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2650,9 +2658,10 @@ POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute | 字段 | 类型 | 描述 | | :------------ | :----- | :---------------------------------------------------------- | -| `data.result` | Bool | 是否成功禁言用户：
- `true`：是；
- `false`：否。 | -| `data.expire` | Long | 禁言到期时间，Unix 时间戳，单位为毫秒。 | -| `data.user` | String | 被禁言的用户 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `result` | Bool | 是否成功禁言用户：
- `true`：是；
- `false`：否。 | +| - `expire` | Long | 禁言到期时间，Unix 时间戳，单位为毫秒。 | +| - `user` | String | 被禁言的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2802,8 +2811,9 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member | 字段 | 类型 | 描述 | | :------------ | :------ | :------------------------------------------------------------------------- | -| `data.result` | Boolean | 是否成功将指定用户移出禁言列表：
- `true`：是；
- `false`：否。 | -| `data.user` | String | 被解除禁言的聊天室成员的用户 ID。 | +| `data` | JSON Array | 响应数据。 | +| - `result` | Boolean | 是否成功将指定用户移出禁言列表：
- `true`：是；
- `false`：否。 | +| - `user` | String | 被解除禁言的聊天室成员的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 diff --git a/docs/document/server-side/group.md b/docs/document/server-side/group.md index 4a6619e3e..04382388d 100644 --- a/docs/document/server-side/group.md +++ b/docs/document/server-side/group.md @@ -421,12 +421,13 @@ GET https://{host}/{org_name}/{app_name}/chatgroups?limit={N}&cursor={cursor} | 字段 | 类型 | 描述 | | :------------------- | :----- | :--------------------------------------- | -| `data.owner` | String | 群主的用户 ID。例如：{“owner”: “user1}。 | -| `data.groupid` | String | 群组 ID。 | -| `data.affiliations` | int | 群组现有成员数。 | -| `data.type` | String | “group” 群组类型。 | -| `data.last_modified` | String | 最近一次修改的时间戳，单位为毫秒。 | -| `data.groupname` | String | 群组名称。 | +| `data` | JSON Array | 响应数据。 | +| - `owner` | String | 群主的用户 ID。例如：{“owner”: “user1}。 | +| - `groupid` | String | 群组 ID。 | +| - `affiliations` | int | 群组现有成员数。 | +| - `type` | String | “group” 群组类型。 | +| - `last_modified` | String | 最近一次修改的时间戳，单位为毫秒。 | +| - `groupname` | String | 群组名称。 | | `count` | Int | 实际获取的群组数量。 | | `cursor` | String | 查询游标，指定下次查询的起始位置。 | @@ -524,17 +525,17 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/user/{username}?pagesize={}& | 参数 | 类型 | 描述 | |:-------------------------|:-------|:----------------------------| | `total` | Int | 用户加入的群组总数。 | -| `entities` | Array | 用户加入的群组列表。 | -| `entities.groupId ` | String | 群组 ID。 | -| `entities.name` | String | 群组名称。 | -| `entities.owner` | String | 群组管理员的用户 ID。 | -| `entities.description` | String | 群组描述。 | -| `entities.disabled` | Bool | 群组是否被禁用：
- `true`：禁用。禁用后不能对群组进行任何修改。
- `false`：未禁用。 | -| `entities.public` | Bool | 是否是公开群：
- `true`：公开群。公开群可以被搜索到，用户可以申请加入公开群。
- `false`：私有群。私有群无法被搜索到，需要群主或群管理员邀请，用户才可以加入。| -| `entities.allowinvites` | Bool | 是否允许普通群成员邀请用户加入群组：
- `true`：普通群成员可拉人入群;
- `false`：只有群主或者管理员才可以拉人入群。 | -| `entities.membersonly` | Bool | 用户申请入群是否需要群主或者群管理员审批。
- `true`：需要；
- `false`：不需要，用户直接进群。 | -| `entities.maxusers` | Int | 群组最大成员数（包括群主）。 | -| `entities.created ` | Long | 群组创建时间戳。 | +| `entities` | JSON Array | 用户加入的群组列表。 | +| - `groupId ` | String | 群组 ID。 | +| - `name` | String | 群组名称。 | +| - `owner` | String | 群组管理员的用户 ID。 | +| - `description` | String | 群组描述。 | +| - `disabled` | Bool | 群组是否被禁用：
- `true`：禁用。禁用后不能对群组进行任何修改。
- `false`：未禁用。 | +| - `public` | Bool | 是否是公开群：
- `true`：公开群。公开群可以被搜索到，用户可以申请加入公开群。
- `false`：私有群。私有群无法被搜索到，需要群主或群管理员邀请，用户才可以加入。| +| - `allowinvites` | Bool | 是否允许普通群成员邀请用户加入群组：
- `true`：普通群成员可拉人入群;
- `false`：只有群主或者管理员才可以拉人入群。 | +| - `membersonly` | Bool | 用户申请入群是否需要群主或者群管理员审批。
- `true`：需要；
- `false`：不需要，用户直接进群。 | +| - `maxusers` | Int | 群组最大成员数（包括群主）。 | +| - `created ` | Long | 群组创建时间戳。 | 其他参数及说明详见 [公共参数](#公共参数)。 @@ -668,23 +669,24 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id} 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :------------------------ | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 字段 | 类型 | 描述 | +| :---------- | :----- | :----------------- | | `count` | Int | 获取详情的群组数量。 | -| `data.id` | String | 群组 ID，群组唯一标识符。 | -| `data.name` | String | 群组名称。 | -| `data.description` | String | 群组描述。 | -| `data.membersonly` | Bool | 加入群组是否需要群主或者群管理员审批。
- `true`：是；
- `false`：否。 | -| `data.allowinvites` | Bool | 是否允许群成员邀请其他用户加入此群。
- `true`：允许群成员邀请其他用户加入此群；
- `false`：只有群主可以邀请其他用户入群。
注：该参数仅对私有群有效，因为公开群不允许群成员邀请其他用户入群。 | -| `data.maxusers` | Int | 群组最大成员数，创建群组的时候设置，可修改。 | -| `data.permission` | String | 群组成员角色：
- `owner`：群主；
- `member`：普通成员。 | -| `data.owner` | String | 群主的用户 ID。例如：{“owner”: “user1”}。 | -| `data.created` | Long | 创建该群组的 Unix 时间戳。 | -| `data.affiliations_count` | int | 群组现有成员总数。 | -| `data.disabled` | Bool | 群组是否为禁用状态：
- `true`：群组被禁用；
- `false`：群组为启用状态。 | -| `data.mute` | Bool | 是否处于全员禁言状态。
- `true`：是；
- （默认）`false`：否。 | -| `data.public` | Bool | 是否是公开群：
- `true`：公开群；
- `false`：私有群。 | -| `data.custom` | String | 群组扩展信息，例如，可以给群组添加业务相关的标记，不要超过 1,024 字符。 | +| `data` | JSON Array | 响应数据。| +| - `id` | String | 群组 ID，群组唯一标识符。 | +| - `name` | String | 群组名称。 | +| - `description` | String | 群组描述。 | +| - `membersonly` | Bool | 加入群组是否需要群主或者群管理员审批。
- `true`：是；
- `false`：否。 | +| - `allowinvites` | Bool | 是否允许群成员邀请其他用户加入此群。
- `true`：允许群成员邀请其他用户加入此群；
- `false`：只有群主可以邀请其他用户入群。
注：该参数仅对私有群有效，因为公开群不允许群成员邀请其他用户入群。 | +| - `maxusers` | Int | 群组最大成员数，创建群组的时候设置，可修改。 | +| - `permission` | String | 群组成员角色：
- `owner`：群主；
- `member`：普通成员。 | +| - `owner` | String | 群主的用户 ID。例如：{“owner”: “user1”}。 | +| - `created` | Long | 创建该群组的 Unix 时间戳。 | +| - `affiliations_count` | int | 群组现有成员总数。 | +| - `disabled` | Bool | 群组是否为禁用状态：
- `true`：群组被禁用；
- `false`：群组为启用状态。 | +| - `mute` | Bool | 是否处于全员禁言状态。
- `true`：是；
- （默认）`false`：否。 | +| - `public` | Bool | 是否是公开群：
- `true`：公开群；
- `false`：私有群。 | +| - `custom` | String | 群组扩展信息，例如，可以给群组添加业务相关的标记，不要超过 1,024 字符。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -976,11 +978,12 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files?pagen | 字段 | 类型 | 描述 | | :---------------- | :----- | :------------------------------------------------------ | -| `data.file_id` | String | 群组共享文件的 ID，若要下载或删除该文件需要使用该参数。 | -| `data.file_name` | String | 群组共享文件名称。 | -| `data.file_owner` | String | 上传群组共享文件的用户 ID。 | -| `data.file_size` | Long | 群组共享文件大小，单位为字节。 | -| `data.created` | Long | 上传群组共享文件的时间。 | +| `data` | JSON Array | 响应数据。 | +| - `file_id` | String | 群组共享文件的 ID，若要下载或删除该文件需要使用该参数。 | +| - `file_name` | String | 群组共享文件名称。 | +| - `file_owner` | String | 上传群组共享文件的用户 ID。 | +| - `file_size` | Long | 群组共享文件大小，单位为字节。 | +| - `created` | Long | 上传群组共享文件的时间。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -1356,8 +1359,8 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{username} ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :------------ | | `Content-Type` | String | 是 | 内容类型。请填 `application/json`。 | | `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | @@ -1590,11 +1593,12 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{members | 字段 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------------------- | -| `data.result` | Bool | 操作结果：
- `true`：移除成功；
- `false`：移除失败。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_member`，表示移除群组成员。 | -| `data.reason` | String | 操作失败的原因。 | -| `data.user` | String | 被移除成员的用户 ID。 | -| `data.groupid` | String | 操作的群组 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 操作结果：
- `true`：移除成功；
- `false`：移除失败。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_member`，表示移除群组成员。 | +| - `reason` | String | 操作失败的原因。 | +| - `user` | String | 被移除成员的用户 ID。 | +| - `groupid` | String | 操作的群组 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2300,11 +2304,12 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users | 字段 | 类型 | 描述 | | :------------- | :----- | :------------------------------------------------------------------------------ | -| `data.result` | Bool | 添加结果：
- `true`：添加成功；
- `false`：添加失败。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `add_blocks`，表示将群成员加入群组黑名单。 | -| `data.reason` | String | 添加失败的原因。 | -| `data.user` | String | 添加的用户 ID。 | -| `data.groupid` | String | 群组 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 添加结果：
- `true`：添加成功；
- `false`：添加失败。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `add_blocks`，表示将群成员加入群组黑名单。 | +| - `reason` | String | 添加失败的原因。 | +| - `user` | String | 添加的用户 ID。 | +| - `groupid` | String | 群组 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2370,8 +2375,8 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{ ##### 请求 header -| 参数 | 类型 | 是否必需 | 描述 | -| :-------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :--------------------- | | `Accept` | String | 是 | 内容类型。请填 `application/json`。 | | `Authorization` | String | 是 | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | @@ -2381,8 +2386,8 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{ 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： -| 字段 | 类型 | 描述 | -| :-------- | :----- | :--------------------------------------------------------------------------------- | +| 字段 | 类型 | 描述 | +| :-------- | :----- | :-------------------- | | `result` | Bool | 移除结果：
- `true`：移除成功；
- `false`：移除失败。 | | `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_blocks`，表示将群成员移出群组黑名单。 | | `user` | String | 添加的用户 ID。 | @@ -2458,10 +2463,11 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{ | 字段 | 类型 | 描述 | | :------------- | :----- | :------------------------------------------------------------------------------------- | -| `data.result` | Bool | 移除结果：
- `true`：移除成功；
- `false`：移除失败。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_blocks`，表示将用户从群组黑名单批量移除。 | -| `data.user` | String | 被移除的用户 ID。 | -| `data.groupid` | String | 群组 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 移除结果：
- `true`：移除成功；
- `false`：移除失败。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_blocks`，表示将用户从群组黑名单批量移除。 | +| - `user` | String | 被移除的用户 ID。 | +| - `groupid` | String | 群组 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2685,11 +2691,12 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users | 字段 | 类型 | 描述 | | :------------- | :----- | :---------------------------------------------------------------------------------- | -| `data.result` | Bool | 添加结果：
- `true`：添加成功；
- `false`：添加失败。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `add_user_whitelist`，表示将成员加入群白名单。 | -| `data.user` | String | 添加的用户 ID。 | -| `data.groupid` | String | 群组 ID。 | -| `data.reason` | String | 添加失败的原因。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 添加结果：
- `true`：添加成功；
- `false`：添加失败。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `add_user_whitelist`，表示将成员加入群白名单。 | +| - `user` | String | 添加的用户 ID。 | +| - `groupid` | String | 群组 ID。 | +| - `reason` | String | 添加失败的原因。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2766,10 +2773,11 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{u | 字段 | 类型 | 描述 | | :------------- | :----- | :--------------------------------------------------------------------------------------- | -| `data.result` | Bool | 移除结果：
- `true`：移除成功；
- `false`：移除失败。 | -| `data.action` | String | 执行的操作。在该响应中，该字段的值为 `remove_user_whitelist`，表示将成员移出群组白名单。 | -| `data.user` | String | 移除群组白名单的用户 ID，多个用户 ID 以英文逗号（","）分隔。 | -| `data.groupid` | String | 群组 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 移除结果：
- `true`：移除成功；
- `false`：移除失败。 | +| - `action` | String | 执行的操作。在该响应中，该字段的值为 `remove_user_whitelist`，表示将成员移出群组白名单。 | +| - `user` | String | 移除群组白名单的用户 ID，多个用户 ID 以英文逗号（","）分隔。 | +| - `groupid` | String | 群组 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2846,8 +2854,9 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/mute | 字段 | 类型 | 描述 | | :------------ | :----- | :--------------------------- | -| `data.expire` | Long | 禁言到期的时间，单位为毫秒。 | -| `data.user` | String | 被禁言用户的 ID。 | +| `data` | JSON Array | 响应数据。| +| - `expire` | Long | 禁言到期的时间，单位为毫秒。 | +| - `user` | String | 被禁言用户的 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -2921,9 +2930,10 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/mute | 字段 | 类型 | 描述 | | :------------ | :----- | :-------------------------------------------------------------- | -| `data.result` | Bool | 操作结果：
- `true`：添加成功；
- `false`：添加失败。 | -| `data.expire` | Long | 禁言到期的时间。该时间为 Unix 时间戳，单位为毫秒。 | -| `data.user` | String | 被禁言用户的 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 操作结果：
- `true`：添加成功；
- `false`：添加失败。 | +| - `expire` | Long | 禁言到期的时间。该时间为 Unix 时间戳，单位为毫秒。 | +| - `user` | String | 被禁言用户的 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -3061,8 +3071,9 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/mute/{member1} | 字段 | 类型 | 描述 | | :------------ | :---- | :-------------------------------------------------------------- | -| `data.result` | Bool | 操作结果：
- `true`：解除成功；
- `false`：解除失败。 | -| `data.user` | Array | 被移出禁言列表的用户 ID。 | +| `data` | JSON Array | 响应数据。| +| - `result` | Bool | 操作结果：
- `true`：解除成功；
- `false`：解除失败。 | +| - `user` | Array | 被移出禁言列表的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -3205,7 +3216,8 @@ GET https://{host}/{org_name}/{app_name}/thread?limit={limit}&cursor={cursor}&so | 字段 | 类型 | 描述 | | :------------------ | :----- | :--------------------------------- | -| `entities.id` | String | 子区 ID。 | +| `entities` | JSON Array | 响应数据。 | +| - `id` | String | 子区 ID。 | | `properties.cursor` | String | 查询游标，指定下次查询的起始位置。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -3279,12 +3291,13 @@ GET https://{host}/{org_name}/{app_name}/threads/user/{username}?limit={limit}&c | 字段 | 类型 | 描述 | | :------------------ | :----- | :--------------------------------------- | -| `entities.name` | String | 子区名称。 | -| `entities.owner` | String | 子区创建者的用户 ID。 | -| `entities.id` | String | 子区 ID。 | -| `entities.msgId` | String | 子区的父消息 ID。 | -| `entities.groupId` | String | 子区所属群组 ID。 | -| `entities.created` | Long | 子区创建时间，Unix 时间戳。 | +| `entities` | JSON Array | 响应数据。 | +| - `name` | String | 子区名称。 | +| - `owner` | String | 子区创建者的用户 ID。 | +| - `entities.id` | String | 子区 ID。 | +| - `entities.msgId` | String | 子区的父消息 ID。 | +| - `entities.groupId` | String | 子区所属群组 ID。 | +| - `entities.created` | Long | 子区创建时间，Unix 时间戳。 | | `properties.cursor` | String | 查询游标，指定服务器下次查询的起始位置。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -3363,13 +3376,14 @@ GET https://{host}/{org_name}/{app_name}/threads/chatgroups/{group_id}/user/{use | 字段 | 描述 | 描述 | | :------------------ | :----- | :-------------------------------------- | -| `entities.name` | String | 子区名称。 | -| `entities.owner` | String | 子区的创建者。 | -| `entities.id` | String | 子区 ID。 | -| `entities.msgId` | String | 子区的父消息 ID。 | -| `entities.groupId` | String | 子区所属群组 ID。 | -| `entities.created` | Long | 子区创建时间，Unix 时间戳，单位为毫秒。 | -| `properties.cursor` | String | 查询游标，指定下次查询的起始位置。 | +| `entities` | JSON Array | 响应数据。 | +| - `name` | String | 子区名称。 | +| - `owner` | String | 子区的创建者。 | +| - `id` | String | 子区 ID。 | +| - `msgId` | String | 子区的父消息 ID。 | +| - `groupId` | String | 子区所属群组 ID。 | +| - `created` | Long | 子区创建时间，Unix 时间戳，单位为毫秒。 | +| - `cursor` | String | 查询游标，指定下次查询的起始位置。 | 其他字段及描述详见 [公共参数](#公共参数)。 @@ -3805,8 +3819,9 @@ DELETE https://{host}/{org_name}/{app_name}/threads/{thread_id}/users | 字段 | 类型 | 描述 | | :------- | :----- | :------------------------------------------------------ | -| `result` | Bool | 操作结果。
- `true`：成功；
- `false`：失败。 | -| `user` | String | 被踢出子区的用户 ID。 | +| `entities` | JSON Array | 响应数据。 | +| - `result` | Bool | 操作结果。
- `true`：成功；
- `false`：失败。 | +| - `user` | String | 被踢出子区的用户 ID。 | 其他字段及描述详见 [公共参数](#公共参数)。 diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md index 0408478fb..5446b5350 100644 --- 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 index f19c4182e..4913e7590 100644 --- 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 index 687f85380..0aab7a5d5 100644 --- 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 | 被订阅用户在多端的状态：
- `0`：离线；
- `1`：在线；
- 其他值：用户可设置其他值自定义在线状态。 | +| - `uid` | String | 被订阅用户在即时通讯服务器的唯一 ID。 | +| - `last_time` | Long | 被订阅用户的最近在线时间，Unix 时间戳，单位为秒。服务端会在被订阅的用户登录和登出时记录该时间。 | +| - `expiry` | Long | 订阅过期的 Unix 时间戳，单位为秒。 | +| - `ext` | String | 被订阅用户的在线状态扩展信息。 | +| - `status` | JSON | 被订阅用户在多端的状态：
- `0`：离线；
- `1`：在线；
- 其他值：用户可设置其他值自定义在线状态。 | 如果返回的 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 | 用户在多个设备上的在线状态：
- `0`： 离线。
- `1`： 在线。
- 其他值：用户自定义的在线状态。 | +| - `uid` | String | 用户在即时通讯服务器的唯一 ID。 | +| - `last_time` | Long | 用户的最近在线时间，Unix 时间戳，单位为秒。 | +| - `ext` | String | 用户的在线状态扩展信息。 | +| - `status` | JSON | 用户在多个设备上的在线状态：
- `0`： 离线。
- `1`： 在线。
- 其他值：用户自定义的在线状态。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](error.html) 了解可能的原因。 diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index 46358799f..2e064d13c 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -14,8 +14,8 @@ ### 请求参数 -| 参数 | 类型 | 是否必需 | 描述 | -| :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :------------------ | | `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-的信息)。 | @@ -252,14 +252,14 @@ PUT https://{host}/{org_name}/{app_name}/users/{username} | 参数 | 类型 | 描述 | | :------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entities` | JSON | 用户在推送通知中显示的昵称以及用户相关信息。 | -| `entities.uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | -| `entities.type` | String | 用户类型，即 `user`。 | -| `entities.created` | Number | 用户注册的 Unix 时间戳，单位为毫秒。 | -| `entities.modified` | Number | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | -| `entities.username` | String | 用户 ID。用户登录的唯一账号。 | -| `entities.activated` | Boolean | 用户是否为活跃状态： | -| `entities.nickname` | String | 推送通知中显示的昵称。 | +| `entities` | JSON Array | 用户在推送通知中显示的昵称以及用户相关信息。 | +| - `uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | +| - `type` | String | 用户类型，即 `user`。 | +| - `created` | Number | 用户注册的 Unix 时间戳，单位为毫秒。 | +| - `modified` | Number | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | +| - `username` | String | 用户 ID。用户登录的唯一账号。 | +| - `activated` | Boolean | 用户是否为活跃状态： | +| - `nickname` | String | 推送通知中显示的昵称。 | 其他参数及说明详见 [公共参数](#公共参数)。 @@ -334,19 +334,19 @@ PUT https://{host}/{org_name}/{app_name}/users/{username} | 参数 | 类型 | 描述 | | :-------------------- | :------ | :------------------------------------------------ | -| `entities` | JSON | 用户的离线推送通知的展示方式以及相关信息。 | -| `entities.uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | -| `entities.type` | String | 用户类型，即 `user`。 | -| `entities.created` | Long | 用户创建的 Unix 时间戳，单位为毫秒。 | -| `entities.modified` | Long | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | -| `entities.username` | String | 用户 ID。用户登录的唯一账号。 | -| `entities.activated` | Boolean | 用户是否为活跃状态： | -| `entities.notification_no_disturbing` | Boolean | 是否设置为免打扰模式： | -| `entities.notification_no_disturbing_start` | Int | 免打扰时间段的开始时间。 | -| `entities.notification_no_disturbing_end` | Int | 免打扰时间段的结束时间。 | -| `entities.notification_display_style` | Int | 离线推送通知的展示方式。 | -| `entities.nickname` | String | 离线推送通知收到时显示的昵称。 | -| `entities.notifier_name` | String | 推送证书名称。 | +| `entities` | JSON Array | 用户的离线推送通知的展示方式以及相关信息。 | +| - `uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | +| - `type` | String | 用户类型，即 `user`。 | +| - `created` | Long | 用户创建的 Unix 时间戳，单位为毫秒。 | +| - `modified` | Long | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | +| - `username` | String | 用户 ID。用户登录的唯一账号。 | +| - `activated` | Boolean | 用户是否为活跃状态： | +| - `notification_no_disturbing` | Boolean | 是否设置为免打扰模式： | +| - `notification_no_disturbing_start` | Int | 免打扰时间段的开始时间。 | +| - `notification_no_disturbing_end` | Int | 免打扰时间段的结束时间。 | +| - `notification_display_style` | Int | 离线推送通知的展示方式。 | +| - `nickname` | String | 离线推送通知收到时显示的昵称。 | +| - `notifier_name` | String | 推送证书名称。 | 其他参数及说明详见 [公共参数](#公共参数)。 @@ -409,9 +409,9 @@ PUT https://{host}/{org_name}/{app_name}/users/{username} #### 请求 header -| 参数 | 类型 | 描述 | 是否必需 | -| :-------------- | :----- | :------------------------------------------------------------------------------------------------------------------- | :------- | -| `Content-Type` | String | 内容类型。请填 `application/json`。 | 是 | +| 参数 | 类型 | 描述 | 是否必需 | +| :-------------- | :----- | :--------- | :------- | +| `Content-Type` | String | 内容类型。请填 `application/json`。 | 是 | | `Authorization` | String | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | 是 | #### 请求 body @@ -438,21 +438,21 @@ PUT https://{host}/{org_name}/{app_name}/users/{username} 如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段： -| 参数 | 类型 | 描述 | -| :------------------------------------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entities` | JSON | 用户的免打扰模式的相关信息。 | -| `entities.uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | -| `entities.type` | String | 用户类型，即 `user`。 | -| `entities.created` | Long | 用户创建的 Unix 时间戳，单位为毫秒。 | -| `entities.modified` | Long | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | -| `entities.username` | String | 用户 ID。用户登录的唯一账号。 | -| `entities.activated` | Boolean | 用户是否为活跃状态： | -| `entities.notification_no_disturbing` | Boolean | 是否设置为免打扰模式： | -| `entities.notification_no_disturbing_start` | Int | 免打扰时间段的开始时间。 | -| `entities.notification_no_disturbing_end` | Int | 免打扰时间段的结束时间。 | -| `entities.notification_display_style` | Int | 离线推送通知的展示方式。 | -| `entities.nickname` | String | 离线推送通知收到时显示的昵称。 | -| `entities.notifier_name` | String | 推送证书名称。 | +| 参数 | 类型 | 描述 | +| :------------------------------------------ | :------ | :------------------------------------- | +| `entities` | JSON Array | 用户的免打扰模式的相关信息。 | +| - `uuid` | String | 用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。 | +| - `type` | String | 用户类型，即 `user`。 | +| - `created` | Long | 用户创建的 Unix 时间戳，单位为毫秒。 | +| - `modified` | Long | 最近一次修改用户信息的 Unix 时间戳，单位为毫秒。 | +| - `username` | String | 用户 ID。用户登录的唯一账号。 | +| - `activated` | Boolean | 用户是否为活跃状态： | +| - `notification_no_disturbing` | Boolean | 是否设置为免打扰模式： | +| - `notification_no_disturbing_start` | Int | 免打扰时间段的开始时间。 | +| - `notification_no_disturbing_end` | Int | 免打扰时间段的结束时间。 | +| - `notification_display_style` | Int | 离线推送通知的展示方式。 | +| - `nickname` | String | 离线推送通知收到时显示的昵称。 | +| - `notifier_name` | String | 推送证书名称。 | 其他参数及说明详见 [公共参数](#公共参数)。 @@ -609,8 +609,8 @@ GET https://{host}/{org}/{app}/users/{username}/notification/{chattype}/{key} #### 路径参数 -| 参数 | 类型 | 描述 | 是否必需 | -| :--------- | :----- | :------------------------------------------------------------------------------------------ | :------- | +| 参数 | 类型 | 描述 | 是否必需 | +| :--------- | :----- | :--------------------------------- | :------- | | `chattype` | String | 对象类型，即会话类型：
- `user`：用户，表示单聊；
- `chatgroup`：群组，表示群聊。 | 是 | | `key` | String | 对象名称：
- 单聊时为对端用户的用户 ID；
- 群聊时为群组 ID。 | 是 | @@ -618,8 +618,8 @@ GET https://{host}/{org}/{app}/users/{username}/notification/{chattype}/{key} #### 请求 header -| 参数 | 类型 | 描述 | 是否必需 | -| :-------------- | :----- | :------------------------------------------------------------------------------------------------------------------- | :------- | +| 参数 | 类型 | 描述 | 是否必需 | +| :-------------- | :----- | :----------------------- | :------- | | `Authorization` | String | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | 是 | ### HTTP 响应 @@ -682,8 +682,8 @@ PUT https://{host}/{org}/{app}/users/{username}/notification/language #### 请求 header -| 参数 | 类型 | 描述 | 是否必需 | -| :-------------- | :----- | :------------------------------------------------------------------------------------------------------------------- | :------- | +| 参数 | 类型 | 描述 +| :-------------- | :----- | :-------------- | :------- | | `Content-Type` | String | 内容类型。请填 `application/json`。 | 是 | | `Authorization` | String | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 | 是 | diff --git a/docs/product/easemob_app_token.md b/docs/product/easemob_app_token.md index 4a3b0bbbb..034fb3b41 100644 --- a/docs/product/easemob_app_token.md +++ b/docs/product/easemob_app_token.md @@ -67,7 +67,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' - "grant_type": "client_credentials", "client_id": "YXA6i-Ak8Ol4Eei2l11ZjV-EAg", "client_secret": "YXA6VunqiNxoB7IwXHInk1cGiXOOJfc", - "ttl": "1024000" + "ttl": 1024000 }' 'http://a1.easemob.com/easemob-demo/testapp/token' ```