Merge pull request #1210 from haoxiuwen/doc-v2

haoxiuwen · web-flow · commit db300032a71b · 2025-03-20T14:30:07.000+08:00
Add Complete Fields for Group/Chatroom Creation/Modification Callback Events and Optimize Product Dynamics
diff --git a/docs/document/server-side/callback_group_room_create.md b/docs/document/server-side/callback_group_room_create.md
@@ -68,7 +68,7 @@
 | `payload`       | Object | 事件内容。                                                     |
 | `payload.role` | JSON | 群组角色。若设置了管理员，显示管理员角色，若未设置，则只显示群组角色：<br/> - 用户 ID：`owner`<br/> - 用户 ID：`admin` | 
 | `payload.member`| Array | 创建群组时拉入群的用户。    | 
-| `payload.info`   | JSON | 新群组的相关信息。除了以下参数，其他群组参数详见[创建群组 RESTful API](/document/server-side/group_manage.html#创建群组)。<br/> - `title`：String 类型，群组名称。 <br/> - `disabled` ：Boolean 类型，取值为 `false`，表示群组为非禁用状态，可正常使用。 <br/> - `last_modified`：Long 类型，群组信息的最新修改时间。   |
+| `payload.info`   | JSON | 新群组的相关信息。<br/> - `owner`：String 类型，群主。<br/> - `created`：Long 类型，群组创建时间。<br/> - `custom`：String 类型，群组自定义信息。<br/> - `description`：String 类型，群组描述。<br/> - `mute`：Bool 类型，是否进行全员禁言，`true` 表示是，`false` 表示否。<br/> - `mute_duration`：Long 类型，全员禁言时长，从当前时间开始计算。单位为秒。`0` 表示取消禁言，`-1` 表示永久禁言。<br/> - `avatar`：String，群组头像 URL。<br/> - `title`：String 类型，群组名称。<br/> - `max_users`：群组最大成员数（包括群主）。<br/> - `invite_need_confirm`：Bool 类型，邀请用户入群时是否需要被邀用户同意，`true` 表示需要被邀用户同意，`false` 表示不需要。<br/> - `public`：Bool 类型，是否是公开群, `true` 表示公开群，`false` 表示私有群。<br/> - `allow_user_invites`：Bool 类型，是否允许普通群成员邀请用户加入群组，`true` 表示允许，`false` 表示不允许，只有群主和群管理员才能邀请用户入群。<br/> - `disabled`：Boolean 类型，`true` 表示群组为禁用状态，`false`，表示群组为非禁用状态，可正常使用。 <br/> - `last_modified`：Long 类型，群组信息的最新修改时间。   |
 | `appkey`       | String | 你在环信管理后台注册的应用唯一标识。                                |
 | `id`           | String | 群组/聊天室 ID。                                                 |
 | `type`         | String | 区分群组或聊天室事件：<br/> - `GROUP`：群组 <br/> - `CHATROOM` ：聊天室     |
diff --git a/docs/document/server-side/callback_group_room_info.md b/docs/document/server-side/callback_group_room_info.md
@@ -40,11 +40,20 @@
 	"payload": {
 		"type": "INFO",
 		"info": {
-			"description": "updategroupinfo123",
-			"scale": "large", 
-			"title": "This is Newgroup0912",
-			"last_modified": "1729497138786",
-			"max_users": 2000
+			"owner": "XXXX#XXXX_tst",
+			"created": "1729496598199",
+			"custom": "",
+			"description": "描述",
+			"mute": "false",
+			"mute_duration": -1,
+			"avatar": "https://XXXX/XXXX/XXXX",
+			"title": "测试01",
+			"max_users": "200",
+			"invite_need_confirm": "true",
+			"public": "true",
+			"allow_user_invites": "false",
+			"disabled": "false",
+			"last_modified": "1729496598199"
 		}
 	},
 	"appkey": "XXXX#XXXX",
@@ -67,12 +76,7 @@
 | `security`     | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。|
 | `payload`       | Object | 事件内容。                                                     |
 |  - `type`| String |     | 群组信息修改事件。 |
-|  - `info`   | JSON | 修改后的群组信息。 |
-|  - `info.description`   | String | 群组描述。    |
-|  - `info.scale`   | String | 该字段只对群组信息更新事件有效，对聊天室事件无效。该字段为系统字段，开发者可忽略。若 `maxusers` 超过了普通群的最大人数限制，系统自动将该参数的值设为 `large`。设置后，即使群人数减少，该参数的值仍不变。    | 
-|  - `info.title`   | String | 群组名称。    |
-|  - `info.last_modified`   | Long | 群组的最新修改时间。    |
-|  - `info.max_users`   | Int | 群组最大成员数（包括群主）。    |
+|  - `info`   | JSON | 修改后的群组信息。<br/> - `owner`：String 类型，群主。<br/> - `created`：Long 类型，群组创建时间。<br/> - `custom`：String 类型，群组自定义信息。<br/> - `description`：String 类型，群组描述。<br/> - `mute`：Bool 类型，是否进行全员禁言，`true` 表示是，`false` 表示否。<br/> - `mute_duration`：Long 类型，全员禁言时长，从当前时间开始计算。单位为秒。`0` 表示取消禁言，`-1` 表示永久禁言。<br/> - `avatar`：String，群组头像 URL。<br/> - `title`：String 类型，群组名称。<br/> - `max_users`：群组最大成员数（包括群主）。<br/> - `invite_need_confirm`：Bool 类型，邀请用户入群时是否需要被邀用户同意，`true` 表示需要被邀用户同意，`false` 表示不需要。<br/> - `public`：Bool 类型，是否是公开群, `true` 表示公开群，`false` 表示私有群。<br/> - `allow_user_invites`：Bool 类型，是否允许普通群成员邀请用户加入群组，`true` 表示允许，`false` 表示不允许，只有群主和群管理员才能邀请用户入群。<br/> - `disabled`：Boolean 类型，`true` 表示群组为禁用状态，`false`，表示群组为非禁用状态，可正常使用。 <br/> - `last_modified`：Long 类型，群组信息的最新修改时间。 |
 | `appkey`       | String | 你在环信管理后台注册的应用唯一标识。           |
 | `id`       | String | 群组 ID。                                                 |
 | `type`         | String | 区分群组或聊天室事件：<br/> - `GROUP`：群组 <br/> - `CHATROOM` ：聊天室   |
diff --git a/docs/product/limitationapi.md b/docs/product/limitationapi.md
@@ -216,16 +216,14 @@ API 限流周期按照 UTC 时间计算，即当日的 00:00:00 至次日的 00:
 | 设置推送消息显示昵称 | PUT  | /{org_name}/{app_name}/users/{userId} |
 | 设置推送消息展示方式 | PUT  | /{org_name}/{app_name}/users/{userId} |
 
-
-
 ### 用户属性
 
 | RESTful API 接口 |方法  | 接口 URL| 接口最高调用频率（默认值） | 单个叠加包大小|
 | :-------- | :----- | :---------------- | :--------------------- | :--------------------- |
 | 设置用户属性      | PUT     | /{org_name}/{app_name}/metadata/user/{username}            | 100 次/秒/App Key | 100 次/秒    | 
 | 批量获取用户属性    | POST      | /{org_name}/{app_name}/metadata/user/get           | 100 次/秒/App Key    | 50 次/秒    | 
 | 删除用户属性   | DELETE     | /{org_name}/{app_name}/metadata/user/{username}      | 100 次/秒/App Key  | 100 次/秒    | 
-| 获取指定用户的所有用户属性/获取 app 下的用户属性总大小    | GET     | /{org_name}/{app_name}/metadata/user/{username}//{org_name}/{app_name}/metadata/user/capacity      | 100 次/秒/App Key | 100 次/秒    | 
+| 获取指定用户的所有用户属性/获取 app 下的用户属性总大小    | GET     | <br/> - /{org_name}/{app_name}/metadata/user/{username} <br/> - /{org_name}/{app_name}/metadata/user/capacity      | 100 次/秒/App Key | 100 次/秒    | 
 
 ### 用户在线状态订阅
 
@@ -243,7 +241,7 @@ API 限流周期按照 UTC 时间计算，即当日的 00:00:00 至次日的 00:
 | RESTful API 接口 |方法  | 接口 URL| 接口最高调用频率（默认值） | 单个叠加包大小|
 | :-------- | :----- | :---------------- | :--------------------- | :--------------------- |
 | * 设置用户全局禁言  |  POST      | /{org_name}/{app_name}/mutes         | 100 次/秒/App Key  | 50 次/秒    | 
-| * 查询单个用户 ID 全局禁言 |   GET   | /{org_name}/{appName}/mutes/username  | 100 次/秒/App Key  |  100 次/秒   | 
+| * 查询单个用户 ID 全局禁言 |   GET   | /{org_name}/{appName}/mutes/{username}  | 100 次/秒/App Key  |  100 次/秒   | 
 | * 查询 app 下的所有全局禁言的用户  |   GET  | /{org_name}/{app_name}/mutes        | 100 次/秒/App Key  | 50 次/秒    | 
 
 ### 用户收藏
diff --git a/docs/product/product_dynamics.md b/docs/product/product_dynamics.md
@@ -2,14 +2,30 @@
 
 ## 2025-03
 
- 动态名称   | 动态描述 | 发布时间       | 相关文档          |
+### SDK 发版
+
+| 动态名称   | 动态描述 | 发布时间       | 相关文档          |
 | :----- | :------- | :---------------- | :---------------- |
-| SDK 4.13.0 开发版发布   | **新增特性**：<br/><br/> - 发送后修改消息接口支持修改各类消息：<br/>1. 文本/自定义消息：支持修改消息内容（body）和扩展；<br/>2. 文件/视频/音频/图片/位置/合并转发消息：只支持修改消息扩展字段；<br/>4. 命令消息：不支持修改。<br/><br/> - 小程序 SDK 支持运行到微信小游戏平台。    | 2025-03-12     | <br/> - [Android 4.13.0 更新日志](/document/android/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版)<br/> - [iOS 4.13.0 更新日志](/document/ios/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版)<br/> - [Web 4.13.0 更新日志](/document/web/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版) <br/> - [小程序 4.13.0 更新日志](/document/applet/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版) |
+| SDK 4.13.0 开发版发布   | **新增特性**：<br/><br/> - [发送后修改消息接口支持修改各类消息](/document/android/message_modify.html)：<br/>1. 文本/自定义消息：支持修改消息内容（body）和扩展；<br/>2. 文件/视频/音频/图片/位置/合并转发消息：只支持修改消息扩展字段；<br/>4. 命令消息：不支持修改。<br/><br/> - 小程序 SDK 支持运行到微信小游戏平台。    | 2025-03-12     | <br/> - [Android 4.13.0 更新日志](/document/android/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版)<br/> - [iOS 4.13.0 更新日志](/document/ios/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版)<br/> - [Web 4.13.0 更新日志](/document/web/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版) <br/> - [小程序 4.13.0 更新日志](/document/applet/releasenote.html#版本-v4-13-0-dev-2025-3-12-开发版) |
 
 | 动态名称   | 动态描述 | 发布时间       | 相关文档          |
 | :----- | :------- | :---------------- | :---------------- |
-| HarmonyOS SDK 1.5.2 开发版发布   | **新增特性**：<br/> - 支持[清空聊天记录](/document/harmonyos/message_delete.html#清空聊天记录)：清除当前用户的单聊、群聊和聊天室的消息和会话记录，可选择是否清除服务端的聊天记录。<br/> - 支持检查 SDK 是否连接到环信服务器：自动登录的场景下，登录状态变为已登录时，可能 SDK 未成功连接至服务端，这种情况下与服务器交互的操作会失败，比如发消息。此时，可调用 isConnected() 接口判断 SDK 与服务器的连接状态。    | 2025-03-10     | [HarmonyOS 1.5.2 更新日志](/document/harmonyos/releasenote.html#版本-v1-5-2-dev-2025-3-10-开发版)      |
-| HarmonyOS SDK 1.5.3 开发版发布   | **新增特性**：<br/> - 支持获取本地单个联系人的信息。    | 2025-03-17     | [HarmonyOS 1.5.3 更新日志](/document/harmonyos/releasenote.html#版本-v1-5-3-dev-2025-3-17-开发版)      |
+| HarmonyOS SDK 1.5.2 开发版发布   | **新增特性**：<br/> - 支持 [清空聊天记录](/document/harmonyos/message_delete.html#清空聊天记录)：清除当前用户的单聊、群聊和聊天室的消息和会话记录，可选择是否清除服务端的聊天记录。<br/> - 支持检查 SDK 是否连接到环信服务器：自动登录的场景下，登录状态变为已登录时，可能 SDK 未成功连接至服务端，这种情况下与服务器交互的操作会失败，比如发消息。此时，可调用 `isConnected()` 接口判断 SDK 与服务器的连接状态。    | 2025-03-10     | [HarmonyOS 1.5.2 更新日志](/document/harmonyos/releasenote.html#版本-v1-5-2-dev-2025-3-10-开发版)      |
+| HarmonyOS SDK 1.5.3 开发版发布   | **新增特性**：<br/> - 支持[从本地获取单个好友的用户 ID 和好友备注](/document/harmonyos/user_relationship.html#从本地获取好友列表)。    | 2025-03-17     | [HarmonyOS 1.5.3 更新日志](/document/harmonyos/releasenote.html#版本-v1-5-3-dev-2025-3-17-开发版)      |
+
+### 其他优化
+
+1. 注册用户时用户 ID 建议统一使用小写字母
+
+为了更好地实现服务端与 SDK 的兼容，调用 [RESTful API](/document/server-side/account_system.html#注册用户)和客户端 API 以及 [在环信控制台创建用户](/product/enable_and_configure_IM.html#创建-im-用户)时，建议统一使用小写字母。目前用户 ID 支持以下字符集：
+
+- 26 个小写英文字母 a-z；
+- 10 个数字 0-9；
+- “_”, “-”, “.”。
+
+2. 新增发送后回调事件
+
+因解散群组或聊天室导致的用户退出，环信服务器向你的 App Server 发送的回调请求。详情请参见 [成员离开事件](/document/server-side/callback_group_room_leave.html#因解散群组-聊天室导致的用户退出) 。
 
 ## 2025-01
 
