From 903283e9b11c0ca7db63a4b0e37300be9b023ed7 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 9 Oct 2023 17:13:50 +0800 Subject: [PATCH 1/2] modify --- docs/document/android/error.md | 52 +++---- docs/document/android/overview.md | 23 ++- docs/document/android/reaction.md | 2 +- docs/document/flutter/overview.md | 20 ++- docs/document/flutter/reaction.md | 2 +- docs/document/ios/error.md | 3 - docs/document/ios/overview.md | 23 ++- docs/document/ios/reaction.md | 2 +- docs/document/react-native/overview.md | 8 +- docs/document/react-native/reaction.md | 2 +- docs/document/unity/error.md | 190 +++++++++++++------------ docs/document/unity/overview.md | 10 +- docs/document/unity/reaction.md | 2 +- docs/document/web/overview.md | 4 + docs/document/web/reaction.md | 2 +- docs/document/windows/overview.md | 8 +- docs/document/windows/reaction.md | 2 +- 17 files changed, 209 insertions(+), 146 deletions(-) diff --git a/docs/document/android/error.md b/docs/document/android/error.md index 9e8216cc0..0748f4388 100644 --- a/docs/document/android/error.md +++ b/docs/document/android/error.md @@ -10,9 +10,10 @@ Android 中错误码的类为 `EMError`。 | 错误码
| 错误信息 | 可能原因 | | :-----: | :----------------------------- | :--------------------------- | -| 0 | EM_NO_ERROR | 提示操作成功。 | -| 1 | GENERAL_ERROR | 默认未区分类型的错误：提示 SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。 | +| 0 | EM_NO_ERROR | 操作成功。 | +| 1 | GENERAL_ERROR | 默认未区分类型的错误：例如，SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。 | 2 | NETWORK_ERROR | 网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。 | +| 3 | `DATABASE_ERROR` | 数据库操作失败。 | | 4 | EXCEED_SERVICE_LIMIT | 超过服务限制：超过服务版本的数量限制，比如创建的用户 ID 数量超过购买服务的限制时提示该错误。 | | 5 | SERVICE_ARREARAGES | 服务欠费，该错误码已废弃。 | | 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。 | @@ -32,7 +33,7 @@ Android 中错误码的类为 `EMError`。 | 204 | USER_NOT_FOUND | 用户不存在：比如登录或者获取用户会话列表时用户 ID 不存在。 | | 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：比如创建用户 ID 时不符合格式要求，或者更新用户属性时用户参数为空等。 | | 206 | USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录：如果未开启多设备登录，则在其他设备登录会将当前登录的设备踢下线，用户会收到此错误。 | -| 207 | USER_REMOVED | 用户已经被注销：如果当前的登录用户 ID 被从管理后台则会收到此错误。 | +| 207 | USER_REMOVED | 用户已经被注销：如果当前的登录用户 ID 从环信控制台删除会收到此错误。 | | 208 | USER_REG_FAILED | 用户注册失败：注册用户 ID 时失败，比如未开启开放注册功能等原因。 | | 209 | USER_UPDATEINFO_FAILED | 更新推送配置错误：用户更新推送昵称或设置免打扰配置时失败。 | | 210 | USER_PERMISSION_DENIED | 用户无权限：例如如果用户被封禁，发送消息时会提示该错误。 | @@ -55,8 +56,8 @@ Android 中错误码的类为 `EMError`。 | 305 | SERVER_SERVICE_RESTRICTED | 当前 app 被禁用：如果 app 因为某种原因被禁用时会返回该错误。 | | 400 | FILE_NOT_FOUND | 文件未找到：当用户获取不到日志文件，或者下载附件失败时提示该错误。 | | 401 | FILE_INVALID | 文件异常：当上传消息附件或者群组共享文件时可能会提示该错误。 | -| 402 | FILE_UPLOAD_FAILED | 上传文件错误：上传消息附件失败时提示该错误。 | -| 403 | FILE_DOWNLOAD_FAILED | 下载文件错误：下载消息附件失败时提示该错误。 | +| 402 | FILE_UPLOAD_FAILED | 上传文件错误：上传消息附件失败时提示该错误。 | +| 403 | FILE_DOWNLOAD_FAILED | 下载文件错误：下载消息附件失败时提示该错误。 | | 404 | FILE_DELETE_FAILED | 删除文件错误：通过 API 获取日志文件时会将旧的日志文件删除，如果删除失败提示该错误。 | | 405 | FILE_TOO_LARGE | 文件太大：消息附件或群共享文件超过文件大小限制时提示该错误。 | | 406 | FILE_CONTENT_IMPROPER | 文件内容不合规：消息附件或群共享文件内容不合规时提示该错误。 | @@ -71,12 +72,16 @@ Android 中错误码的类为 `EMError`。 | 508 | MESSAGE_EXTERNAL_LOGIC_BLOCKED | 消息执行发送前回调，发送的消息被用户自己的服务器定义的规则拦截掉时提示该错误。 | | 509 | MESSAGE_CURRENT_LIMITING | 单个用户 ID 发送消息超出频率限制。默认情况下，SDK 对单个用户 ID 发送群消息未做频率限制。如果你联系了环信商务设置了该限制，一旦在在单聊、群聊或聊天室中单个用户的消息发送频率超过设定的上限，则会提示该错误。 | | 510 | MESSAGE_SIZE_LIMIT | 发送消息时消息体大小超过上限。| +| 511 | MESSAGE_EDIT_FAILED | 消息修改失败。 | | 600 | GROUP_INVALID_ID | 群组 ID 异常：使用群组相关 API，提供的群组 ID 为空时提示该错误。 | | 601 | GROUP_ALREADY_JOINED | 已在该群组中：调用加入群组的 API 时如果已经在该群组中则提示该错误。 | | 602 | GROUP_NOT_JOINED | 未加入该群组：尝试在未加入的群组中发送消息或进行群组操作时提示该错误。 | | 603 | GROUP_PERMISSION_DENIED | 无权限的群组操作：没有权限进行群组操作，比如群组成员不能设置群组管理员。 | | 604 | GROUP_MEMBERS_FULL | 群组已满：群组已经达到人数上限。 | -| 605 | GROUP_NOT_EXIST | 群组不存在：尝试对不存在的群组进行操作时提示该错误。 | +| 605 | GROUP_SHARED_FILE_INVALIDID | 群组共享文件 ID 不合法。| +| 606 | GROUP_NOT_EXIST | 群组不存在：尝试对不存在的群组进行操作时提示该错误。| +| 607 | GROUP_DISABLED | 群组被禁用。 | +| 608 | GROUP_NAME_VIOLATION | 群组名称无效。 | | 609 | GROUP_MEMBER_ATTRIBUTES_REACH_LIMIT | 群组成员自定义属性个数达到上限。 | | 610 | GROUP_MEMBER_ATTRIBUTES_UPDATE_FAILED | 设置群成员自定义属性失败。 | | 611 | GROUP_MEMBER_ATTRIBUTES_KEY_REACH_LIMIT | 设置的群成员自定义属性 key 长度（不能超过 16 字节）超限。 | @@ -85,30 +90,27 @@ Android 中错误码的类为 `EMError`。 | 701 | CHATROOM_ALREADY_JOINED | 已在该聊天室中：调用加入聊天室的 API 时如果已经在该聊天室中则提示该错误。 | | 702 | CHATROOM_NOT_JOINED | 未加入该聊天室：尝试在未加入的聊天室中发送消息或进行聊天室操作时提示该错误。 | | 703 | CHATROOM_PERMISSION_DENIED | 无权限的聊天室操作：没有权限进行聊天室操作，比如聊天室成员不能设置聊天室管理员。 | -| 704 | CHATROOM_MEMBERS_FULL | 聊天室已满：聊天室已经达到人数上限。 | -| 705 | CHATROOM_NOT_EXIST | 聊天室不存在：尝试对不存在的聊天室进行操作时提示该错误。 | -| 900 | USERINFO_USERCOUNT_EXCEED | 获取用户属性的用户个数超过 100。 | +| 704 | CHATROOM_MEMBERS_FULL | 聊天室已满：聊天室已经达到人数上限。 | +| 705 | CHATROOM_NOT_EXIST | 聊天室不存在：尝试对不存在的聊天室进行操作时提示该错误。 | +| 900 | USERINFO_USERCOUNT_EXCEED | 获取用户属性的用户个数超过 100。 | | 901 | USERINFO_DATALENGTH_EXCEED | 设置的用户属性太长。单个用户的所有属性数据不能超过 2 KB，单个 app 所有用户属性数据不能超过 10 GB。 | -| 903 | TRANSLATE_INVALID_PARAMS | 翻译参数无效：调用翻译方法传入的参数无效，请检查传参。 | -| 904 | TRANSLATE_FAIL | 翻译失败：调用翻译方法翻译失败。 | -| 905 | TRANSLATE_NOT_INIT | 翻译服务未初始化：没有初始化翻译模块。 | -| 1000 | CONTACT_ADD_FAILED | 添加联系人失败。 | -| 1001 | CONTACT_REACH_LIMIT | 邀请者的联系人数量已经达到上限。 | -| 1002 | CONTACT_REACH_LIMIT_PEER | 受邀请者联系人达到上限。 | +| 1000 | CONTACT_ADD_FAILED | 添加联系人失败。 | +| 1001 | CONTACT_REACH_LIMIT | 邀请者的联系人数量已经达到上限。 | +| 1002 | CONTACT_REACH_LIMIT_PEER | 受邀者的联系人数量达到上限。 | | 1100 | PRESENCE_PARAM_LENGTH_EXCEED | 参数长度超出限制：调用 Presence 相关方法时参数长度超出限制。 | -| 1101 | PRESENCE_CANNOT_SUBSCRIBE_YOURSELF | 不能订阅你自己的状态。 | -| 1110 | TRANSLATE_PARAM_INVALID | 翻译参数错误。 | -| 1111 | TRANSLATE_SERVICE_NOT_ENABLE | 翻译服务未启用。 | -| 1112 | TRANSLATE_USAGE_LIMIT | 翻译用量达到上限。 | -| 1113 | TRANSLATE_MESSAGE_FAIL | 获取翻译服务失败。 | +| 1101 | PRESENCE_CANNOT_SUBSCRIBE_YOURSELF | 不能订阅你自己的状态。 | +| 1110 | TRANSLATE_PARAM_INVALID | 翻译参数错误。 | +| 1111 | TRANSLATE_SERVICE_NOT_ENABLE | 翻译服务未启用。 | +| 1112 | TRANSLATE_USAGE_LIMIT | 翻译用量达到上限。 | +| 1113 | TRANSLATE_MESSAGE_FAIL | 消息翻译失败。 | | 1200 | MODERATION_FAILED | 第三方内容审核服务的消息审核结果为“拒绝”。 | | 1299 | THIRD_SERVER_FAILED | 除第三方内容审核服务的其他服务的消息审核结果为“拒绝”。 | -| 1300 | REACTION_REACH_LIMIT | Reaction 数量已达到限制。 | -| 1301 | REACTION_HAS_BEEN_OPERATED | Reaction 重复添加。 | +| 1300 | REACTION_REACH_LIMIT | Reaction 数量已达到限制。 | +| 1301 | REACTION_HAS_BEEN_OPERATED | Reaction 重复添加。 | | 1302 | REACTION_OPERATION_IS_ILLEGAL | 用户对该 Reaction 没有操作权限。例如没有添加过该 Reaction 的用户进行删除操作，或者单聊消息非发送者和非接收者进行添加 Reaction 操作。 | -| 1400 | THREAD_NOT_EXIST | 该子区不存在。 | -| 1401 | THREAD_ALREADY_EXIST | 该子区已存在，重复添加子区。 | -| 1402 | THREAD_CREATE_MESSAGE_ILLEGAL | 创建子区的消息无效。 | +| 1400 | THREAD_NOT_EXIST | 该子区不存在。 | +| 1401 | THREAD_ALREADY_EXIST | 该子区已存在，重复添加子区。 | +| 1402 | THREAD_CREATE_MESSAGE_ILLEGAL | 创建子区的消息无效。 | | 1500 | PUSH_NOT_SUPPORT | 第三方推送不支持：如果用户配置的第三方推送在当前设备上不支持，会提示该错误。 | | 1501 | PUSH_BIND_FAILED | 绑定第三方推送 token 失败：如果将第三方推送 token 上传到服务器失败时会返回该错误。 | | 1502 | PUSH_UNBIND_FAILED | 解绑第三方推送 token 失败：如果解绑第三方推送 token 失败会提示该错误。 | \ No newline at end of file diff --git a/docs/document/android/overview.md b/docs/document/android/overview.md index a0e284094..4b8c5ecba 100644 --- a/docs/document/android/overview.md +++ b/docs/document/android/overview.md @@ -47,7 +47,22 @@ EMClient.getInstance().init(context, options); ## 注册用户 -可以使用如下代码创建账号： +目前用户注册方式有以下几种： +- 通过控制台注册。 +- 通过 REST API 接口注册。 +- 调用 SDK 接口注册。 + +### 控制台注册 + +控制台的注册请到 [这里](https://console.easemob.com/app/im-service/operative-service/user)。 + +### REST API 注册 + +请参考 [注册用户](/document/server-side/account_system.html#注册用户)。 + +### SDK 注册 + +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 ```java // 注册失败会抛出 HyphenateException。 @@ -55,10 +70,8 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。 ``` :::notice - -- 以上注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用； -- 正式环境应使用服务器端调用 REST API 接口[注册用户](/document/server-side/account_system.html#注册用户)。 - ::: +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: ## 用户登录 diff --git a/docs/document/android/reaction.md b/docs/document/android/reaction.md index ed399f6dc..ddf0ae5bb 100644 --- a/docs/document/android/reaction.md +++ b/docs/document/android/reaction.md @@ -38,7 +38,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `asyncAddReaction` 在消息上添加 Reaction，在 `onReactionChanged` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `asyncAddReaction` 在消息上添加一条 Reaction，在 `onReactionChanged` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： diff --git a/docs/document/flutter/overview.md b/docs/document/flutter/overview.md index 56ce90ad9..0ffa5764c 100644 --- a/docs/document/flutter/overview.md +++ b/docs/document/flutter/overview.md @@ -30,7 +30,22 @@ await EMClient.getInstance.startCallback(); ## 注册用户 -可以使用如下代码创建账号： +目前用户注册方式有以下几种： +- 通过控制台注册。 +- 通过 REST API 接口注册。 +- 调用 SDK 接口注册。 + +### 控制台注册 + +控制台的注册请到 [这里](https://console.easemob.com/app/im-service/operative-service/user)。 + +### REST API 注册 + +请参考 [注册用户](/document/server-side/account_system.html#注册用户)。 + +### SDK 注册 + +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 ```dart try { @@ -39,8 +54,7 @@ try { ``` :::notice -- 以上注册模式为在客户端注册，主要用于测试，简单方便，但不推荐在正式环境中使用； -- 正式环境应[调用 REST API 接口注册用户](/document/server-side/account_system.html#注册用户)。 +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 ::: ## 用户登录 diff --git a/docs/document/flutter/reaction.md b/docs/document/flutter/reaction.md index 7e1be8e9a..4b61b6229 100644 --- a/docs/document/flutter/reaction.md +++ b/docs/document/flutter/reaction.md @@ -36,7 +36,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `addReaction` 在消息上添加 Reaction，在 `onMessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `addReaction` 在消息上添加 Reaction，在 `onMessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： diff --git a/docs/document/ios/error.md b/docs/document/ios/error.md index cbc232d9c..bedc4479e 100644 --- a/docs/document/ios/error.md +++ b/docs/document/ios/error.md @@ -88,9 +88,6 @@ iOS 的错误码只有当操作出错的时候才会有返回值，否则返回 | 705 | EMErrorChatroomNotExist | 聊天室不存在：要操作的聊天室不存在。 | | 900 | EMErrorUserCountExceed | 获取用户属性的用户个数超过 100。 | | 901 | EMErrorUserInfoDataLengthExceed | 设置的用户属性太长。单个用户的所有属性数据不能超过 2 KB，单个 app 所有用户属性数据不能超过 10 GB。 | -| 903 | EMErrorTranslateParamInvalid | 调用翻译方法传入的参数无效，请检查传参。 | -| 904 | EMErrorTranslateFail | 翻译服务接口返回错误。 | -| 905 | EMErrorTranslateNotInit | 翻译服务未初始化。 | | 1000 | EMErrorContactAddFailed | 添加联系人失败。 | | 1001 | EMErrorContactReachLimit | 邀请者联系人数量已经达到上限。 | | 1002 | EMErrorContactReachLimitPeer | 受邀请者联系人达到上限。 | diff --git a/docs/document/ios/overview.md b/docs/document/ios/overview.md index b2e072a95..be439cd86 100644 --- a/docs/document/ios/overview.md +++ b/docs/document/ios/overview.md @@ -28,7 +28,22 @@ EMOptions *options = [EMOptions optionsWithAppkey:@"<#appkey#>"]; ## 注册用户 -可以使用如下代码创建账号： +目前用户注册方式有以下几种： +- 通过控制台注册。 +- 通过 REST API 接口注册。 +- 调用 SDK 接口注册。 + +### 控制台注册 + +控制台的注册请到 [这里](https://console.easemob.com/app/im-service/operative-service/user)。 + +### REST API 注册 + +请参考 [注册用户](/document/server-side/account_system.html#注册用户)。 + +### SDK 注册 + +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 ```objectivec // 异步方法 @@ -39,10 +54,8 @@ EMOptions *options = [EMOptions optionsWithAppkey:@"<#appkey#>"]; ``` :::notice - -- 以上注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用； -- 正式环境应使用服务器端调用 REST API 接口 [注册用户](/document/server-side/account_system.html#注册用户)。 - ::: +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: ## 用户登录 diff --git a/docs/document/ios/reaction.md b/docs/document/ios/reaction.md index 9004c5168..e272e803a 100644 --- a/docs/document/ios/reaction.md +++ b/docs/document/ios/reaction.md @@ -37,7 +37,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `addReaction` 在消息上添加 Reaction，在 `messageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `addReaction` 在消息上添加 Reaction，在 `messageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： diff --git a/docs/document/react-native/overview.md b/docs/document/react-native/overview.md index 413769d64..624fbe088 100644 --- a/docs/document/react-native/overview.md +++ b/docs/document/react-native/overview.md @@ -71,7 +71,7 @@ ChatClient.getInstance() - 通过控制台注册。 - 通过 REST API 接口注册。 -- 调用 SDK 接口注册。该方法需在 [控制台](https://console.easemob.com/app/im-service/detail) 设置允许 **开放注册**。 +- 调用 SDK 接口注册。 ### 控制台注册 @@ -83,6 +83,8 @@ ChatClient.getInstance() ### SDK 注册 +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 + ```typescript ChatClient.getInstance() .createAccount(username, password) @@ -94,6 +96,10 @@ ChatClient.getInstance() }); ``` +:::notice +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: + ## 用户登录 目前登录服务器有两种方式： diff --git a/docs/document/react-native/reaction.md b/docs/document/react-native/reaction.md index 17e7b40fe..60053e687 100644 --- a/docs/document/react-native/reaction.md +++ b/docs/document/react-native/reaction.md @@ -31,7 +31,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `addReaction` 在消息上添加 Reaction，在 `onMessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `addReaction` 在消息上添加 Reaction，在 `onMessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： diff --git a/docs/document/unity/error.md b/docs/document/unity/error.md index 04811bfee..06028624b 100644 --- a/docs/document/unity/error.md +++ b/docs/document/unity/error.md @@ -31,99 +31,101 @@ SDKClient.Instance.Login(username, passwd, 错误码定义如下： -| 错误码 | 错误信息 | 描述和可能原因 | -| :----- | :-------------------------------------| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 0 | EM_NO_ERROR | 提示操作成功。 | -| 1 | GENERAL_ERROR | 默认未区分类型的错误：提示 SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。 | -| 2 | NETWORK_ERROR | 网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。 | -| 3 | DATABASE_ERROR | 数据库操作失败 | -| 4 | EXCEED_SERVICE_LIMIT | 超过服务限制：超过服务版本的数量限制，比如创建的用户 ID 数量超过购买服务的限制时提示该错误。 | -| 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。 | -| 100 | INVALID_APP_KEY | App Key 不合法：你的 App Key 格式不正确。 | -| 101 | INVALID_USER_NAME | 用户 ID 不正确：一般是用户 ID 为空时提示该错误，比如使用邀请好友 API 时 username 参数为空字符。 | -| 102 | INVALID_PASSWORD | 用户密码不正确：登录时提供的密码为空或不正确。 | -| 104 | INVALID_TOKEN | 登录时提供的 token 为空或不正确。 | -| 105 | USER_NAME_TOO_LONG | 用户名过长：用户名长度限制 64 个字节。 | -| 108 | TOKEN_EXPIRED | 声网 token 已过期：超出声网 token 有效期时间。 | -| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期：超出声网 token 有效期一半时间时会开始回调此错误码。 | -| 200 | USER_ALREADY_LOGIN | 用户已经登录：同一个用户 ID 已经登录。 | -| 201 | USER_NOT_LOGIN | 用户未登录：如果未登录成功时发送消息，或者使用群组操作的 API，SDK 会提示该错误。 | -| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般是 token 鉴权失败或者 token 已经过期。 | -| 203 | USER_ALREADY_EXIST | 用户已经存在：注册用户 ID 时如果该 ID 已经存在会提示该错误。 | -| 204 | USER_NOT_FOUND | 用户不存在：比如登录或者获取用户会话列表时用户 ID 不存在。 | -| 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：比如创建用户 ID 时不符合格式要求， 或者更新用户属性时用户参数为空等。 | -| 206 | USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录：如果未开启多设备登录，则在其他设备登录会将当前登录的设备踢下线，用户会收到此错误。 | -| 207 | USER_REMOVED | 用户已经被注销：如果登录用户被从管理后台删除 ID 则会收到此错误。 | -| 208 | USER_REG_FAILED | 用户注册失败：注册用户 ID 时失败，比如未开启开放注册功能等原因。 | -| 209 | PUSH_UPDATECONFIGS_FAILED | 更新推送配置错误：用户更新推送昵称，设置免推送配置时失败。 | -| 210 | USER_PERMISSION_DENIED | 用户无权限：例如如果用户被封禁，发送消息时会提示该错误。 | -| 213 | USER_BIND_ANOTHER_DEVICE | 用户已经在另外设备登录：如果用户设置为先登录的设备优先，则后登录设备登录失败并提示该错误。 | -| 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制：用户同一 ID 登录设备数量超过限制提示该错误。 | -| 215 | USER_MUTED | 用户在群组聊天室中被禁言：用户被禁言后发送消息时提示该错误。 | -| 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新：当前登录的用户密码被修改后，当前登录会断开并提示该错误。 | -| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线：开启多设备后，如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录，SDK 会提示该错误。 | -| 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录：SDK 未退出登录前又被使用不同的账户登录。 | -| 219 | USER_MUTED_BY_ADMIN | 用户被禁言：用户在当前 app key 被禁言后发送消息时提示该错误。 | -| 220 | USER_DEVICE_CHANGED | 用户登录设备与上次不一致：用户登录设备与上次登录设备不一致，需要用户重新登录，注意：默认会允许用户登录，踢掉另一个设备上的登录，此 error 在打开不踢掉另外设备上的登录开关后才会生效。 | -| 221 | USER_NOT_FRIEND | 非好友禁止发消息：开通非好友禁止发消息后，非好友间发消息提示此错误。该功能可在控制台开通。 | -| 300 | SERVER_NOT_REACHABLE | 请求服务失败：发送或撤回消息时，如果 SDK 与消息服务器未保持连接，会返回该错误；操作群组、好友等请求时，如果因网络连接太差而不成功，也会返回该错误。 | -| 301 | SERVER_TIMEOUT | 请求服务超时：如果调用 API 在特定时间内服务器未响应则返回该错误，一般是 30 秒或者 60 秒。 | -| 302 | SERVER_BUSY | 服务器忙碌：服务器当前忙碌会返回该错误，建议稍后再尝试请求。 | -| 303 | SERVER_UNKNOWN_ERROR | 服务请求的通用错误码：当请求服务器未成功时的默认错误，该错误发生情况较多，需要根据日志进一步排查。 | -| 304 | SERVER_GET_DNSLIST_FAILED | 获取服务器配置信息错误：SDK 获取当前应用的服务器配置时失败。 | -| 305 | SERVER_SERVICE_RESTRICTED | 当前 app 被禁用：如果 app 因为某种原因被禁用时会返回该错误。 | -| 400 | FILE_NOT_FOUND | 文件未找到：当用户获取不到日志文件，或者下载附件失败时提示该错误。 | -| 401 | FILE_INVALID | 文件异常：当上传消息附件或者群组共享文件时可能会提示该错误。 | -| 402 | FILE_UPLOAD_FAILED | 上传文件错误：上传消息附件失败时提示该错误。 | -| 403 | FILE_DOWNLOAD_FAILED | 下载文件错误：下载消息附件失败时提示该错误。 | -| 404 | FILE_DELETE_FAILED | 删除文件错误：通过 API 获取日志文件时会将旧的日志文件删除，如果删除失败提示该错误。 | -| 405 | FILE_TOO_LARGE | 文件太大：消息附件或群共享文件超过文件大小限制时提示该错误。 | -| 406 | FILE_CONTENT_IMPROPER | 文件内容不合规：消息附件或群共享文件内容不合规时提示该错误。 | -| 500 | MESSAGE_INVALID | 消息异常错误：如果要发送的消息为空，或者消息 ID 为空，或者消息的发送方 ID 与当前登录 ID 不同则会提示该错误。 | -| 501 | MESSAGE_INCLUDE_ILLEGAL_CONTENT | 消息含有非法内容：如果消息被过滤系统识别为非法消息时返回该错误。 | -| 502 | MESSAGE_SEND_TRAFFIC_LIMIT | 消息限流：发送消息过快时提示该错误，建议降低频率或者减少消息内容的大小。 | -| 504 | MESSAGE_RECALL_TIME_LIMIT | 消息撤回超时错误：如果超过消息撤回允许的时间尝试撤回时提示该错误。 | -| 505 | SERVICE_NOT_ENABLED | 服务未开启：尝试使用某些未开通的功能时提示该错误。 | -| 506 | MESSAGE_EXPIRED | 消息已过期：发送群组回执时如果已经超过时间限制 (默认 3 天) 会提示该错误。 | -| 507 | MESSAGE_ILLEGAL_WHITELIST | 用户未在白名单中：如果群组聊天室开启全员禁言，且用户未在白名单中发送消息时提示该错误。 | -| 508 | MESSAGE_EXTERNAL_LOGIC_BLOCKED | 消息执行发送前回调，被用户自己的逻辑拦截：发送的消息被用户自己的服务器定义的规则拦截掉时提示该错误。 | +| 错误码 | 错误信息 | 描述和可能原因 | +| :----- | :------------------| :------------------ | +| 0 | EM_NO_ERROR | 操作成功。 | +| 1 | GENERAL_ERROR | 默认未区分类型的错误。例如 SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。 | +| 2 | NETWORK_ERROR | 网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。 | +| 3 | DATABASE_ERROR | 数据库操作失败。 | +| 4 | EXCEED_SERVICE_LIMIT | 超过服务版本的数量限制。例如，创建的用户数量或添加的好友数超过购买的服务版本的限制。 | +| 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。 | +| 100 | INVALID_APP_KEY | App Key 不合法：你的 App Key 格式不正确。 | +| 101 | INVALID_USER_NAME | 用户 ID 不正确。一般情况下，用户 ID 为空时提示该错误，比如使用邀请好友 API 时 username 参数为空字符。 | +| 102 | INVALID_PASSWORD | 用户密码不正确：登录时提供的密码为空或不正确。 | +| 104 | INVALID_TOKEN | 登录时提供的 token 为空或不正确。 | +| 105 | USER_NAME_TOO_LONG | 用户名过长：用户名长度限制 64 个字节。 | +| 108 | TOKEN_EXPIRED | 声网 token 已过期：超出声网 token 有效期。 | +| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期：超出声网 token 的一半有效期时会开始回调此错误码。 | +| 110 | INVALID_PARAM | 参数无效。 | +| 200 | USER_ALREADY_LOGIN | 用户已登录：同一个用户 ID 已经登录。 | +| 201 | USER_NOT_LOGIN | 用户未登录：例如，如果未登录成功时发送消息，或者使用群组操作的 API，SDK 会提示该错误。 | +| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般是 token 鉴权失败或者 token 已过期。 | +| 203 | USER_ALREADY_EXIST | 用户已存在：注册用户时，若传入的用户 ID 已存在会提示该错误。 | +| 204 | USER_NOT_FOUND | 用户不存在：例如，登录或获取用户会话列表时用户 ID 不存在。 | +| 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：例如，创建用户时传入的用户 ID 不符合格式要求，或者更新用户属性时用户参数为空等。 | +| 206 | USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录：如果未开启多设备登录，用户在其他设备登录时会将当前登录的设备踢下线，被踢设备收到此错误。 | +| 207 | USER_REMOVED | 用户已经被注销：如果登录用户被从环信控制台删除 ID 则会收到此错误。 | +| 208 | USER_REG_FAILED | 用户注册失败：注册用户 ID 时失败，比如未开启开放注册功能等原因。 | +| 210 | USER_PERMISSION_DENIED | 用户无权限：例如如果用户被封禁，发送消息时会提示该错误。 | +| 213 | USER_BIND_ANOTHER_DEVICE | 用户已经在另外设备登录：如果用户设置为先登录的设备优先，则后登录设备登录失败并提示该错误。 | +| 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制：该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如，用户最多可同时登录 4 台设备。目前，用户在设备 B、C 和 D 上为登录状态，而在设备 A（实现了自动登录）由于网络原因处于登出状态。手动登录设备 E 后，用户在网络恢复后再次自动登录设备 A 时登录失败，提示该错误。| +| 215 | USER_MUTED | 用户在群组聊天室中被禁言：用户被禁言后发送消息时提示该错误。 | +| 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新：当前登录的用户密码被修改后，当前登录会断开并提示该错误。 | +| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线：开启多设备后，如果用户在其他设备上通过调用 API 或者在环信控制台将当前设备的登录强制下线，SDK 会提示该错误。 | +| 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录：SDK 未退出登录前又被使用不同的账户登录。 | +| 219 | USER_MUTED_BY_ADMIN | 用户被禁言：用户被全局禁言后发送消息时提示该错误。 | +| 220 | USER_DEVICE_CHANGED | 用户登录设备与上次不一致：单设备登录场景下，用户的登录设备与上次的不一致，需要重新登录。注意：默认允许用户登录另一台设备，踢掉当前设备上的登录。该错误在打开登录其他设备时不踢掉当前设备上的登录开关的后才会发生。 | +| 221 | USER_NOT_FRIEND | 非好友禁止发消息：开通非好友禁止发消息后，非好友间发消息提示此错误。该功能可在环信控制台开通。 | +| 300 | SERVER_NOT_REACHABLE | 请求服务失败：例如，发送或撤回消息以及进行群组或好友操作时，如果 SDK 与消息服务器未保持连接，会返回该错误。| +| 301 | SERVER_TIMEOUT | 请求服务超时：如果服务器未在特定时间内对调用 API 作出响应则返回该错误，一般是 30 秒或者 60 秒。 | +| 302 | SERVER_BUSY | 服务器忙碌：服务器当前忙碌会返回该错误，建议稍后再尝试请求。 | +| 303 | SERVER_UNKNOWN_ERROR | 服务请求的通用错误：当请求服务器未成功时的默认错误，该错误发生情况较多，需要根据日志进一步排查。 | +| 304 | SERVER_GET_DNSLIST_FAILED | 获取服务器配置信息失败：SDK 获取当前应用的服务器配置时失败。 | +| 305 | SERVER_SERVICE_RESTRICTED | 当前 app 被禁用：如果 app 因为某种原因被禁用时会返回该错误。 | +| 400 | FILE_NOT_FOUND | 文件未找到：例如，用户获取不到日志文件，或者下载附件失败。 | +| 401 | FILE_INVALID | 文件异常：例如，上传消息附件或者群组共享文件失败。| +| 402 | FILE_UPLOAD_FAILED | 上传文件错误：例如，上传消息附件失败时提示该错误。 | +| 403 | FILE_DOWNLOAD_FAILED | 下载文件错误：例如，下载消息附件失败时提示该错误。 | +| 404 | FILE_DELETE_FAILED | 删除文件错误：通过 API 获取日志文件时会将旧的日志文件删除，如果删除失败提示该错误。 | +| 405 | FILE_TOO_LARGE | 文件太大：消息附件或群共享文件超过文件大小限制时提示该错误。 | +| 406 | FILE_CONTENT_IMPROPER | 文件内容不合规：消息附件或群共享文件内容不合规时提示该错误。 | +| 500 | MESSAGE_INVALID | 消息异常错误：如果要发送的消息为空，或者消息 ID 为空，或者消息的发送方 ID 与当前登录 ID 不同则会提示该错误。 | +| 501 | MESSAGE_INCLUDE_ILLEGAL_CONTENT | 消息含有非法内容：如果消息被过滤系统识别为非法消息时返回该错误。 | +| 502 | MESSAGE_SEND_TRAFFIC_LIMIT | 消息限流：发送消息过快时提示该错误，建议降低频率或者减少消息内容的大小。 | +| 504 | MESSAGE_RECALL_TIME_LIMIT | 消息撤回超时错误：如果超过消息撤回允许的时间尝试撤回时提示该错误。 | +| 505 | SERVICE_NOT_ENABLED | 服务未开启：尝试使用某些未开通的功能时提示该错误。 | +| 506 | MESSAGE_EXPIRED | 消息已过期：发送群组回执时如果已经超过时间限制 (默认 3 天) 会提示该错误。 | +| 507 | MESSAGE_ILLEGAL_WHITELIST | 用户未在白名单中：如果群组聊天室开启全员禁言，且用户未在白名单中发送消息时提示该错误。 | +| 508 | MESSAGE_EXTERNAL_LOGIC_BLOCKED | 消息执行发送前回调，被用户自己的逻辑拦截：发送的消息被用户自己的服务器定义的规则拦截掉时提示该错误。 | | 509 | MESSAGE_CURRENT_LIMITING | 单个用户 ID 发送消息超出频率限制。默认情况下，SDK 对单个用户 ID 发送群消息未做频率限制。如果你联系了环信商务设置了该限制，一旦在在单聊、群聊或聊天室中单个用户的消息发送频率超过设定的上限，则会提示该错误。 | -| 510 | MESSAGE_SIZE_LIMIT | 发送消息时消息体大小超过上限。 | -| 511 | MESSAGE_EDIT_FAILED | 消息编辑失败。 | -| 600 | GROUP_INVALID_ID | 群组 ID 异常：使用群组相关 API，提供的群组 ID 为空时提示该错误。 | -| 601 | GROUP_ALREADY_JOINED | 已在该群组中：调用加入群组的 API 时如果已经在该群组中则提示该错误。 | -| 602 | GROUP_NOT_JOINED | 未加入该群组：尝试在未加入的群组中发送消息或进行群组操作时提示该错误。 | -| 603 | GROUP_PERMISSION_DENIED | 无权限的群组操作：没有权限进行群组操作，比如群组成员不能设置群组管理员。 | -| 604 | GROUP_MEMBERS_FULL | 群组已满：群组已经达到人数上限。 | -| 605 | GROUP_SHARED_FILE_INVALIDID | 共享文件 ID 非法。 | -| 606 | GROUP_NOT_EXIST | 群组不存在：尝试对不存在的群组进行操作时提示该错误。 | -| 607 | GROUP_DISABLED | 群组被禁用。 | -| 608 | GROUP_NAME_VIOLATION | 群组名称非法。 | -| 609 | GROUP_MEMBER_ATTRIBUTES_REACH_LIMIT | 群组成员自定义属性个数达到上限。 | -| 610 | GROUP_MEMBER_ATTRIBUTES_UPDATE_FAILED | 设置群成员自定义属性失败。 | -| 700 | CHATROOM_INVALID_ID | 聊天室 ID 异常：使用聊天室相关 API，提供的聊天室 ID 为空时提示该错误。 | -| 701 | CHATROOM_ALREADY_JOINED | 已在该聊天室中：调用加入聊天室的 API 时如果已经在该聊天室中则提示该错误。 | -| 702 | CHATROOM_NOT_JOINED | 未加入该聊天室：尝试在未加入的聊天室中发送消息或进行聊天室操作时提示该错误。 | -| 703 | CHATROOM_PERMISSION_DENIED | 无权限的聊天室操作：没有权限进行聊天室操作，比如聊天室成员不能设置聊天室管理员。 | -| 704 | CHATROOM_MEMBERS_FULL | 聊天室已满：聊天室已经达到人数上限。 | -| 705 | CHATROOM_NOT_EXIST | 聊天室不存在：尝试对不存在的聊天室进行操作时提示该错误。 | -| 900 | USERINFO_USERCOUNT_EXCEED | 获取用户属性的用户个数超过 100。 | -| 901 | USERINFO_DATALENGTH_EXCEED | 设置的用户属性太长。单个用户的所有属性数据不能超过 2 KB，单个 app 所有用户属性数据不能超过 10 GB。 | -| 1000 | CONTACT_ADD_FAILED | 添加联系人失败。 | -| 1001 | CONTACT_REACH_LIMIT | 邀请者联系人数量已经达到上限。 | -| 1002 | CONTACT_REACH_LIMIT_PEER | 受邀请者联系人达到上限。 | -| 1100 | PRESENCE_PARAM_LENGTH_EXCEED | 调用 Presence 相关方法时参数长度超出限制。 | -| 1101 | PRESENCE_CANNOT_SUBSCRIBE_YOURSELF | 不能订阅你自己的状态。 | -| 1110 | TRANSLATE_PARAM_INVALID | 翻译参数错误。 | -| 1111 | TRANSLATE_SERVICE_NOT_ENABLE | 翻译服务未启用。 | -| 1112 | TRANSLATE_USAGE_LIMIT | 翻译用量达到上限。 | -| 1113 | TRANSLATE_MESSAGE_FAIL | 获取翻译服务失败。 | -| 1200 | THIRD_MODERATION_FAILED | 第三方内容审核服务的消息审核结果为“拒绝”。 | -| 1299 | THIRD_DEFAULT_FAILED | 除第三方内容审核服务的其他服务的消息审核结果为“拒绝”。 | -| 1300 | REACTION_REACH_LIMIT | Reaction 数量已达到限制。 | -| 1301 | REACTION_HAS_BEEN_OPERATED | Reaction 重复添加。 | -| 1302 | REACTION_OPERATION_IS_ILLEGAL | 没有操作权限：用户对该 Reaction 没有操作权限。例如没有添加过该 Reaction 的用户进行删除操作，或者单聊消息非发送者和非接受者进行添加 Reaction 操作。 | -| 1400 | THREAD_NOT_EXIST | 未找到该子区，该子区不存在。 | -| 1401 | THREAD_ALREADY_EXIST | 该消息 ID 下子区已存在，重复添加子区。 | -| 1402 | THREAD_CREATE_MESSAGE_ILLEGAL | 创建子区的消息无效：创建子区时父消息被撤回了，或者无法使用。 | +| 510 | MESSAGE_SIZE_LIMIT | 发送消息时消息体大小超过上限。 | +| 511 | MESSAGE_EDIT_FAILED | 消息编辑失败。 | +| 600 | GROUP_INVALID_ID | 群组 ID 异常：使用群组相关 API，提供的群组 ID 为空时提示该错误。 | +| 601 | GROUP_ALREADY_JOINED | 已在该群组中：调用加入群组的 API 时如果已经在该群组中则提示该错误。 | +| 602 | GROUP_NOT_JOINED | 未加入该群组：尝试在未加入的群组中发送消息或进行群组操作时提示该错误。 | +| 603 | GROUP_PERMISSION_DENIED | 无权限的群组操作：没有权限进行群组操作，比如群组成员不能设置群组管理员。 | +| 604 | GROUP_MEMBERS_FULL | 群组已满：群组已经达到人数上限。 | +| 605 | GROUP_SHARED_FILE_INVALIDID | 共享文件 ID 非法。 | +| 606 | GROUP_NOT_EXIST | 群组不存在：尝试对不存在的群组进行操作时提示该错误。 | +| 607 | GROUP_DISABLED | 群组被禁用。 | +| 608 | GROUP_NAME_VIOLATION | 群组名称非法。| +| 609 | GROUP_MEMBER_ATTRIBUTES_REACH_LIMIT | 群组成员自定义属性个数达到上限。| +| 610 | GROUP_MEMBER_ATTRIBUTES_UPDATE_FAILED | 设置群成员自定义属性失败。 | +| 611 | GROUP_MEMBER_ATTRIBUTES_KEY_REACH_LIMIT | 设置的群成员自定义属性 key 长度（不能超过 16 字节）超限。 | +| 612 | GROUP_MEMBER_ATTRIBUTES_VALUE_REACH_LIMIT | 设置的群成员自定义属性 value 长度（不能超过 512 字节）超限。 | +| 700 | CHATROOM_INVALID_ID | 聊天室 ID 异常：使用聊天室相关 API，提供的聊天室 ID 为空时提示该错误。 | +| 701 | CHATROOM_ALREADY_JOINED | 已在该聊天室中：调用加入聊天室的 API 时如果已经在该聊天室中则提示该错误。 | +| 702 | CHATROOM_NOT_JOINED | 未加入该聊天室：尝试在未加入的聊天室中发送消息或进行聊天室操作时提示该错误。 | +| 703 | CHATROOM_PERMISSION_DENIED | 无权限的聊天室操作：没有权限进行聊天室操作，比如聊天室成员不能设置聊天室管理员。 | +| 704 | CHATROOM_MEMBERS_FULL | 聊天室已满：聊天室已经达到人数上限。 | +| 705 | CHATROOM_NOT_EXIST | 聊天室不存在：尝试对不存在的聊天室进行操作时提示该错误。 | +| 900 | USERINFO_USERCOUNT_EXCEED | 获取用户属性的用户个数超过 100。 | +| 901 | USERINFO_DATALENGTH_EXCEED | 设置的用户属性太长。单个用户的所有属性数据不能超过 2 KB，单个 app 所有用户属性数据不能超过 10 GB。 | +| 1000 | CONTACT_ADD_FAILED | 添加联系人失败。 | +| 1001 | CONTACT_REACH_LIMIT | 邀请者的联系人数量已达到上限。 | +| 1002 | CONTACT_REACH_LIMIT_PEER | 受邀者的联系人数量已达到上限。 | +| 1100 | PRESENCE_PARAM_LENGTH_EXCEED | 调用 Presence 相关方法时参数长度超出限制。 | +| 1101 | PRESENCE_CANNOT_SUBSCRIBE_YOURSELF | 不能订阅你自己的状态。 | +| 1110 | TRANSLATE_PARAM_INVALID | 翻译参数错误。 | +| 1111 | TRANSLATE_SERVICE_NOT_ENABLE | 翻译服务未启用。 | +| 1112 | TRANSLATE_USAGE_LIMIT | 翻译用量达到上限。 | +| 1113 | TRANSLATE_MESSAGE_FAIL | 获取翻译服务失败。 | +| 1200 | THIRD_MODERATION_FAILED | 第三方内容审核服务的消息审核结果为“拒绝”。 | +| 1299 | THIRD_DEFAULT_FAILED | 除第三方内容审核服务的其他服务的消息审核结果为“拒绝”。 | +| 1300 | REACTION_REACH_LIMIT | Reaction 数量已达到限制。 | +| 1301 | REACTION_HAS_BEEN_OPERATED | Reaction 重复添加。 | +| 1302 | REACTION_OPERATION_IS_ILLEGAL | 用户对该 Reaction 没有操作权限。例如，未添加过该 Reaction 的用户尝试将其删除，或者单聊时除消息的发送者和接收者之外的用户尝试添加 Reaction。 | +| 1400 | THREAD_NOT_EXIST | 该子区不存在。 | +| 1401 | THREAD_ALREADY_EXIST | 该消息 ID 下子区已存在，不能重复添加。| +| 1402 | THREAD_CREATE_MESSAGE_ILLEGAL | 创建子区的消息无效。例如，创建子区时父消息被撤回了，或者无法使用。 | diff --git a/docs/document/unity/overview.md b/docs/document/unity/overview.md index c257f68d3..1e8264663 100644 --- a/docs/document/unity/overview.md +++ b/docs/document/unity/overview.md @@ -46,10 +46,10 @@ SDKClient.Instance.InitWithOptions(options); ## 注册用户 -目前注册的方式有以下几种： +目前，用户注册方式有以下几种： - 通过控制台注册。 - 通过 REST API 接口注册。 -- 调用 SDK 接口注册。该方法需在 [控制台](https://console.easemob.com/app/im-service/detail) 设置允许 **开放注册**。 +- 调用 SDK 接口注册。 ### 控制台注册 @@ -61,6 +61,8 @@ SDKClient.Instance.InitWithOptions(options); ### SDK 注册 +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 + ```csharp SDKClient.Instance.CreateAccount(username, password, callback: new CallBack( @@ -76,6 +78,10 @@ SDKClient.Instance.CreateAccount(username, password, ); ``` +:::notice +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: + ## 用户登录 SDK 不支持自动登录，只支持通过以下方式手动登录： diff --git a/docs/document/unity/reaction.md b/docs/document/unity/reaction.md index 0040d9157..41040a4ed 100644 --- a/docs/document/unity/reaction.md +++ b/docs/document/unity/reaction.md @@ -38,7 +38,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `AddReaction` 在消息上添加 Reaction，在 `MessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `AddReaction` 在消息上添加 Reaction，在 `MessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： diff --git a/docs/document/web/overview.md b/docs/document/web/overview.md index cd422d54c..c42f9241e 100644 --- a/docs/document/web/overview.md +++ b/docs/document/web/overview.md @@ -119,6 +119,10 @@ conn }); ``` +:::notice +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: + ## 用户登录 SDK 不支持自动登录，只支持通过以下方式手动登录： diff --git a/docs/document/web/reaction.md b/docs/document/web/reaction.md index b37978ccb..c4b55d0ea 100644 --- a/docs/document/web/reaction.md +++ b/docs/document/web/reaction.md @@ -39,7 +39,7 @@ ### 在消息上添加 Reaction -调用 `addReaction` 在消息上添加 Reaction，在 `onReactionChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `addReaction` 在消息上添加 Reaction，在 `onReactionChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1101。 示例代码如下： diff --git a/docs/document/windows/overview.md b/docs/document/windows/overview.md index ad8605484..aa617f78d 100644 --- a/docs/document/windows/overview.md +++ b/docs/document/windows/overview.md @@ -49,7 +49,7 @@ SDKClient.Instance.InitWithOptions(options); 目前注册的方式有以下几种： - 通过控制台注册。 - 通过 REST API 接口注册。 -- 调用 SDK 接口注册。该方法需在 [控制台](https://console.easemob.com/app/im-service/detail) 设置允许 **开放注册**。 +- 调用 SDK 接口注册。 ### 控制台注册 @@ -61,6 +61,8 @@ SDKClient.Instance.InitWithOptions(options); ### SDK 注册 +若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 + ```csharp SDKClient.Instance.CreateAccount(username, password, callback: new CallBack( @@ -76,6 +78,10 @@ SDKClient.Instance.CreateAccount(username, password, ); ``` +:::notice +该注册模式为在客户端注册，旨在方便测试，并不推荐在正式环境中使用。 +::: + ## 用户登录 SDK 不支持自动登录，只支持通过以下方式手动登录： diff --git a/docs/document/windows/reaction.md b/docs/document/windows/reaction.md index 5321aa96d..6f774f569 100644 --- a/docs/document/windows/reaction.md +++ b/docs/document/windows/reaction.md @@ -38,7 +38,7 @@ Reaction 场景示例如下： ### 在消息上添加 Reaction -调用 `AddReaction` 在消息上添加 Reaction，在 `MessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。 +调用 `AddReaction` 在消息上添加 Reaction，在 `MessageReactionDidChange` 监听事件中会收到这条消息的最新 Reaction 概览。对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。 示例代码如下： From 8685db14ab49115bbb13a47203c2c428d0c19296 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 9 Oct 2023 17:22:59 +0800 Subject: [PATCH 2/2] modify --- docs/uikit/android/overview.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/uikit/android/overview.md b/docs/uikit/android/overview.md index 572314c07..b6a3ce18b 100644 --- a/docs/uikit/android/overview.md +++ b/docs/uikit/android/overview.md @@ -2,7 +2,7 @@ -在您阅读此文档时，我们假定您已经具备了基础的 Android 应用开发经验，并能够理解相关基础概念。此文档是针对导入 EaseIMKit 库的快速集成文档，如果只是导入 SDK 集成使用，请参考 [环信即时通讯 IM Android 快速开始](quickstart.html)。 +在您阅读此文档时，我们假定您已经具备了基础的 Android 应用开发经验，并能够理解相关基础概念。此文档是针对导入 EaseIMKit 库的快速集成文档，如果只是导入 SDK 集成使用，请参考 [环信即时通讯 IM Android 快速开始](/document/android/quickstart.html)。 ## 简介 @@ -35,7 +35,7 @@ EaseIMKit 支持 Gradle 接入和 Module 源码集成 #### Gradle 接入集成 :::notice 重大变动 -远程仓库统一由 JCenter 迁移到 `MavenCentral`，依赖库的域名由 “com.hyphenate” 修改为 “io.hyphenate”，详见 [环信即时通讯 IM Android 快速开始](quickstart.html)。 +远程仓库统一由 JCenter 迁移到 `MavenCentral`，依赖库的域名由 “com.hyphenate” 修改为 “io.hyphenate”，详见 [环信即时通讯 IM Android 快速开始](/document/android/quickstart.html)。 ::: ```gradle @@ -50,7 +50,7 @@ implementation 'io.hyphenate:hyphenate-chat:xxx版本' 1. IM SDK **3.8.0** 版本以后，远程依赖的 `artifactId` 修改为 `hyphenate-chat`，且该版本以后中不再包含音视频相关逻辑。 2. IM SDK **3.8.0** 以下，远程依赖，包含音视频的 `artifactId` 为 `hyphenate-sdk`，不包含音视频的 `artifactId` 为 `hyphenate-sdk-lite`。如果想使用不包含音视频通话的 SDK，用 `implementation 'io.hyphenate:hyphenate-sdk-lite:xxx版本`'。 -版本号参考 [Android SDK 更新日志](releasenote.html)。 +版本号参考 [Android SDK 更新日志](/document/android/releasenote.html)。 ::: #### Module 源码集成 @@ -103,7 +103,7 @@ EaseIMKit 提供了 EaseConversationListFragment，需要将其或者其子类 ![img](@static/images/android/easeim.jpeg) :::notice -要实现自定义头像及昵称，请参考 [设置头像和昵称](userprofile.html#设置当前用户的属性)。 +要实现自定义头像及昵称，请参考 [设置头像和昵称](/document/android/userprofile.html#设置当前用户的属性)。 ::: ### 创建聊天界面 @@ -218,6 +218,7 @@ conversationListLayout.showUnreadDotPosition(EaseConversationSetStyle.UnreadDotP 效果如下图： ![img](@static/images/android/easeim3.jpeg) + 更多样式请参考 EaseContactListLayout 控件。 #### 增加长按菜单项