diff --git a/docs/.vuepress/public/images/applet/service_overview.png b/docs/.vuepress/public/images/applet/service_overview.png index 064743c47..a61c2ffde 100644 Binary files a/docs/.vuepress/public/images/applet/service_overview.png and b/docs/.vuepress/public/images/applet/service_overview.png differ diff --git a/docs/.vuepress/public/images/common/multidevice_device_count.png b/docs/.vuepress/public/images/common/multidevice_device_count.png index 970ae5f12..0ebd15fe8 100644 Binary files a/docs/.vuepress/public/images/common/multidevice_device_count.png and b/docs/.vuepress/public/images/common/multidevice_device_count.png differ diff --git a/docs/.vuepress/public/images/common/multidevice_device_platform.png b/docs/.vuepress/public/images/common/multidevice_device_platform.png index d75d00028..360e94fd0 100644 Binary files a/docs/.vuepress/public/images/common/multidevice_device_platform.png and b/docs/.vuepress/public/images/common/multidevice_device_platform.png differ diff --git a/docs/.vuepress/sidebar/callkit.ts b/docs/.vuepress/sidebar/callkit.ts index 5b81e3898..e1c32c286 100644 --- a/docs/.vuepress/sidebar/callkit.ts +++ b/docs/.vuepress/sidebar/callkit.ts @@ -56,6 +56,7 @@ const callKitSidebar = [ { text: "常见问题", link: "common_issue.html" }, ] }, + { text: "更新日志", link: "releasenote.html" }, { text: "设计指南", link: "design_guide.html" }, { text: "历史文档", link: "easecallkit.html" } ]; diff --git a/docs/callkit/android/releasenote.md b/docs/callkit/android/releasenote.md new file mode 100644 index 000000000..7d5bddc67 --- /dev/null +++ b/docs/callkit/android/releasenote.md @@ -0,0 +1,20 @@ +# Android CallKit 更新日志 + +## 版本 4.16.0 2025-08-29 + +从该版本开始,Android CallKit 源码使用 Kotlin 语言开发,代码迁移至 [新 repo](https://github.com/easemob/easemob-callkit-android),老版本不再维护。 + +该版本的 CallKit 主要变更如下: +1. 优化了 [单群聊音视频通话的 UI 界面](product_overview.html#界面效果)。 +2. 采用 MVVM 框架设计抽离各个模块的代码,职责分离。 + 功能模块主要包括: + - `RtcManager`: 管理具体音视频 + - `SignalingManager`: 管理信令交互 + - `AudioController`: 管理铃声 + - `FloatWindow` 和 `IncomingCallTopWindow`: 管理悬浮窗 + - `CallKitCache`: 管理缓存 + - `CallKitNotifier`: 管理通知 +3. 合并信令,由原来三个地方合并为一处。解决了 Activity 被回收导致信令不通问题。 +4. 在应用集成了 FCM 推送的设备上,当应用进程被杀死时,支持 [使用 Telecom](telecom.html) 唤起设备,实现系统级丝滑呼叫体验。 +5. [群组通话的邀请界面](integration.html#步骤-5-发起通话) 改为 CallKit 内部实现,不再需要开发者自己实现。 +6. 移除 App Server 的依赖,直接由 CallKit 内部从 SDK 中获取 RTC App ID、rtcToken、UID 和 userID 映射关系等。 \ No newline at end of file diff --git a/docs/callkit/ios/releasenote.md b/docs/callkit/ios/releasenote.md new file mode 100644 index 000000000..365aac531 --- /dev/null +++ b/docs/callkit/ios/releasenote.md @@ -0,0 +1,13 @@ +# iOS CallKit 更新日志 + +## 版本 4.16.0 2025-08-29 + +从该版本开始,iOS CallKit 源码使用 Swift 语言开发,并且支持 iOS 15.0 及以上版本,代码迁移至 [新 repo](https://github.com/easemob/easemob-callkit-iOS)。老版本不再维护。 + +该版本的 CallKit 主要变更如下: +1. 优化了 [单群聊音视频通话的 UI 界面](product_overview.html#界面效果)。 +2. 单人视频通话支持[画中画](picture_in_picture.html)。 +3. 被叫离线时,支持 [使用 LiveCommunicationKit 进行呼叫](livecommunicationkit.html)。 +4. 优化了 [群组通话的呼叫信令交互](signaling.html#群组通话信令交互流程)。 +5. [群组通话的邀请界面](integration.html#发起群组通话) 改为 UIKit 内部实现,不再需要开发者自己实现。 +6. 通话使用的声网 RTC App ID 及 Token 在 CallKit 内部通过 IM SDK 接口获取,不再依赖 App Server。 \ No newline at end of file diff --git a/docs/callkit/web/releasenote.md b/docs/callkit/web/releasenote.md new file mode 100644 index 000000000..3a895012a --- /dev/null +++ b/docs/callkit/web/releasenote.md @@ -0,0 +1,12 @@ +# CallKit 更新日志 + +## 版本 2.0.1 2025-08-29 + +从该版本开始,CallKit 移到 `easemob-chat-uikit` 中,为 UIKit 的中的一个组件,代码迁移至 [新 repo](https://github.com/easemob/easemob-uikit-react),老版本不再维护。 + +该版本的 CallKit 主要变更如下: + +1. 优化了 [单群聊音视频通话的 UI 界面](product_overview.html#界面效果)。 +2. 优化了群组通话的呼叫信令交互。 +3. [群组通话的邀请界面](integration.html#发起群组通话) 改为 UIKit 内部实现,不再需要开发者自己实现。 +4. 通话使用的声网 RTC App ID 及 Token 在 CallKit 内部通过 IM SDK 接口获取,不再依赖 App Server。 \ No newline at end of file diff --git a/docs/document/android/connection.md b/docs/document/android/connection.md index ecf4751b7..292dea488 100644 --- a/docs/document/android/connection.md +++ b/docs/document/android/connection.md @@ -66,4 +66,4 @@ EMClient.getInstance().removeConnectionListener(connectionListener); - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file diff --git a/docs/document/android/error.md b/docs/document/android/error.md index 771f9b780..6bce04efb 100644 --- a/docs/document/android/error.md +++ b/docs/document/android/error.md @@ -16,7 +16,7 @@ Android 中错误码的类为 [EMError](https://sdkdocs.easemob.com/apidoc/andro | 3 | DATABASE_ERROR | 数据库操作失败:打开本地数据库失败。 | 需要根据调用的 API 结合日志分析,如果使用 `EMConversation#updateMessage` 方法更新一条本地不存在的消息,可能返回该错误;在数据库未打开时,调用其他本地数据库操作,也可能返回该错误。| | 4 | EXCEED_SERVICE_LIMIT | 超过服务限制:超过当前服务版本的数量限制,例如,创建的用户 ID 数量超过购买服务的限制时提示该错误;设置和获取用户属性的接口,包括 [设置当前用户的属性](userprofile.html#设置当前用户的所有属性)、[获取用户的所有属性](userprofile.html#获取用户的所有属性) 和 [获取用户的指定属性](userprofile.html#获取用户的指定属性),超过调用频率限制时,会上报该错误。 | 检查调用的 API,若传入 `limit` 参数,可将该参数控制在限制内,如果是限流导致,可以在延后一段时间重新调用。 | | 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限。 | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 | -| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | +| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | | 101 | INVALID_USER_NAME | 用户 ID 不正确:一般情况下,用户 ID 为空时提示该错误,例如,邀请好友时 username 参数为空字符。 | 检查报错的 API 中传入的用户 ID 参数是否为空。| | 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 | 检查调用的 API 中传入的密码参数是否正确。 | | 103 | INVALID_URL | URL 不正确。 | 检查调用 API 时传入的参数是否正确。 | @@ -42,11 +42,11 @@ Android 中错误码的类为 [EMError](https://sdkdocs.easemob.com/apidoc/andro | 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制:该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如,用户最多可同时登录 4 台设备, A(开启了自动登录)、B、C 和 D。最初,用户在这四个设备上均为登录状态,但由于网络连接原因登出了设备 A,然后手动登录了设备 E。这种情况下,设备 A 的网络恢复正常时会自动登录,这时登录失败且提示该错误。 | 可增加同时在线的设备数量,或先使用 `EMClient#kickDeviceWithToken` 踢掉其他设备再登录。 | | 215 | USER_MUTED | 用户在群组或聊天室中被禁言:用户被禁言后发送消息时提示该错误。 | 用户在群组/聊天室内被禁言情况下,不能发送消息,可在 UI 上限制。 | | 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 | 密码更新会收到回调 `EMConnectionListener#onLogout`,需要在收到该回调时,调用 `EMClient#logout` 方法,并回到登录页面。| -| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调 `EMConnectionListener#onLogout`。收到该回调时,需调用 `EMClient#logout` 方法,并回到登录页面。| +| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调 `EMConnectionListener#onLogout`。收到该回调时,需调用 `EMClient#logout` 方法,并回到登录页面。| | 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录:用户在同一台设备上退出登录前又使用另一账户登录。 | 如果在已登录情况下,要登录另一个账号,需要先调用 `EMClient#logout` 退出账号。 | | 219 | USER_MUTED_BY_ADMIN | 用户被禁言:用户被全局禁言后发送消息时提示该错误。 | 在群组/聊天室开启全员禁言的情况下,不能发送消息,可在 UI 上限制。 | | 220 | USER_DEVICE_CHANGED | 用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如,用户自动登录设备 A,之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。 |登录失败的设备会收到 `EMConnectionListener#onLogout` 事件。收到该事件时,需调用 `EMClient#logout` 方法,并回到登录页面。 | -| 221 | USER_NOT_ON_ROSTER | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 服务概览**页面的**设置**区域开启好友关系检查功能。| 需要先调用 `EMContactManager#addContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | +| 221 | USER_NOT_ON_ROSTER | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面开启好友关系检查功能。| 需要先调用 `EMContactManager#addContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | | 300 | SERVER_NOT_REACHABLE | 服务器不可达:例如,发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时因网络不稳定导致失败,也会返回该错误。 | 调用登录 API 返回该错误码,可能是由于网络受限,或域名被封禁,可尝试切换设备网络。如果用户在沙特/菲律宾等地区,需要联系商务,开启 dnsconfig中 TLS 加密。其他操作返回该错误码,一般是网络问题,可在切换网络或延迟一段时间后重新调用。 | | 301 | SERVER_TIMEOUT | 请求服务超时:如果调用 API 在特定时间内服务器未响应则返回该错误,一般为 30 秒或 60 秒。 | 一般是网络问题,可在切换网络或延迟一段时间后重新调用 API。 | | 302 | SERVER_BUSY | 服务器忙碌:服务器当前忙碌会返回该错误,建议稍后再尝试请求。 |检查调用的 API 是否重复调用。如果在上次调用后,结果未返回时重复调用 API,可能返回该错误码。 | diff --git a/docs/document/android/login.md b/docs/document/android/login.md index 1d66de187..d466e6a36 100644 --- a/docs/document/android/login.md +++ b/docs/document/android/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 示例代码如下所示: @@ -17,7 +17,7 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。 ``` -2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: +1. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: 可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 diff --git a/docs/document/android/message_recall.md b/docs/document/android/message_recall.md index 4a8f82e61..92d288352 100644 --- a/docs/document/android/message_recall.md +++ b/docs/document/android/message_recall.md @@ -7,7 +7,7 @@ - 对于单聊会话,只支持发送方撤回发送成功的消息。若消息过期,撤回失败。 - 对于群组/聊天室会话,普通成员只能撤回自己发送的消息,若消息过期,撤回失败。群主/聊天室所有者和管理员可撤回其他用户发送的消息,即使消息过期也能撤回。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/android/message_receipt.md b/docs/document/android/message_receipt.md index c43f473ac..1b08408d2 100644 --- a/docs/document/android/message_receipt.md +++ b/docs/document/android/message_receipt.md @@ -170,7 +170,7 @@ EMClient.getInstance().chatManager().removeMessageListener(msgListener); | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/android/multi_device.md b/docs/document/android/multi_device.md index bb5e89ae6..506def20c 100644 --- a/docs/document/android/multi_device.md +++ b/docs/document/android/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **基础功能** 页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -132,13 +132,13 @@ EMClient.getInstance().chatManager().sendMessage(message); 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK 时,调用 `EMOptions#setCustomOSPlatform` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK 时,调用 `EMOptions#setCustomOSPlatform` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/android/push/push_fcm.md b/docs/document/android/push/push_fcm.md index 442dc99ed..92ef8b474 100644 --- a/docs/document/android/push/push_fcm.md +++ b/docs/document/android/push/push_fcm.md @@ -232,7 +232,7 @@ public class MyFCMMSGService extends FirebaseMessagingService { 可以查看日志或调用[获取用户详情的 RESTful 接口](https://doc.easemob.com/document/server-side/account_system.html#获取单个用户的详情)确认 device token 是否绑定成功。成功后在 `entities` 字段下会有 `pushInfo` 字段,且 `pushInfo` 下会有 `device_Id`、`device_token`、`notifier_name` 等相关信息。 2. 开启应用通知栏权限。 3. 杀掉应用进程。 -4. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)发送测试消息。 +4. 在[环信控制台](https://console.easemob.com/user/login)发送测试消息。 在左侧导航栏中选择 **即时通讯** > **运营服务** > **用户管理**。在**用户管理**页面中,在对应用户 ID 的**操作**栏中点击**更多**,然后选择**发送rest消息**。在弹出的对话框中选择消息类型,输入消息内容,然后点击**发送**。 5. 查看设备是否收到推送通知。 diff --git a/docs/document/android/push/push_honor.md b/docs/document/android/push/push_honor.md index fdd7a8606..4bef9412d 100644 --- a/docs/document/android/push/push_honor.md +++ b/docs/document/android/push/push_honor.md @@ -192,7 +192,7 @@ if (HonorPushClient.getInstance().checkSupportHonorPush(this)){ 1. 设置 `action` 参数。 -在环信即时通讯云控制台的**添加推送证书**对话框中设置 `action` 参数。该参数需要与客户端 `AndroidManifest.xml` 文件中注册启动的 `Activity` 类中 `intent-filter` 标签中设置的 `action` 一致。该配置只能实现跳转到无需前置参数的页面。若启动应用自定义页面需要前置参数,你还需要在消息扩展中添加前置参数。 +在环信控制台的**添加推送证书**对话框中设置 `action` 参数。该参数需要与客户端 `AndroidManifest.xml` 文件中注册启动的 `Activity` 类中 `intent-filter` 标签中设置的 `action` 一致。该配置只能实现跳转到无需前置参数的页面。若启动应用自定义页面需要前置参数,你还需要在消息扩展中添加前置参数。 若推送不同的消息时,接收方收到后点击推送通知栏打开不同应用自定义页面,你可以添加相应的消息扩展属性实现。 diff --git a/docs/document/android/push/push_overview.md b/docs/document/android/push/push_overview.md index dca2e5c1c..004323299 100644 --- a/docs/document/android/push/push_overview.md +++ b/docs/document/android/push/push_overview.md @@ -10,7 +10,7 @@ 客户端断开连接或应用进程被关闭等原因导致用户离线时,即时通讯 IM 会通过第三方消息推送服务向该离线用户的设备推送消息通知。当用户再次上线时,服务器会将离线期间的消息发送给用户(这里角标表示的是离线消息数,并不是实际的未读消息数)。例如,当你离线时,有用户向你发送了消息,你的手机的通知中心会弹出消息通知,当你再次打开 app 并登录成功,即时通讯 IM SDK 会主动拉取你不在线时的消息。 -除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 +除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 **以下两种情况,即时通讯 IM 不会发送离线推送通知:** @@ -77,7 +77,7 @@ SDK 内部会按照以上顺序检测设备的推送支持情况。如果未设 **如果你的 App 有海外使用场景,建议开启 FCM 推送;由于各推送使用条件不同,建议尽可能同时支持各家推送。** -5. 使用消息推送前,需要你在对应的厂商推送服务上注册项目,并将设备的推送证书上传到[环信即时通讯云控制台](https://console.easemob.com/user/login)。 +5. 使用消息推送前,需要你在对应的厂商推送服务上注册项目,并将设备的推送证书上传到[环信控制台](https://console.easemob.com/user/login)。 ## 配置推送接口 diff --git a/docs/document/android/releasenote.md b/docs/document/android/releasenote.md index bd550ade4..5b23e486c 100644 --- a/docs/document/android/releasenote.md +++ b/docs/document/android/releasenote.md @@ -626,7 +626,7 @@ - [IM SDK] 修改 OPPO 推送导致 SDK 偶现 ANR 异常的问题。 - [IM CallKit] 修复发起语音通话时,若在对方接听前返回桌面,对方无法点击接听或挂断的问题。 - [IM UIKit] 修复部分机型拍照后的图片旋转问题。 -- [IM SDK] 适配 Android 12,修复依赖环信即时通讯云 SDK 的 APK 在 Android 12 版本的部分手机上第一次安装后打开时出现异常弹框的问题。 +- [IM SDK] 适配 Android 12,修复依赖环信即时通讯 IM SDK 的 APK 在 Android 12 版本的部分手机上第一次安装后打开时出现异常弹框的问题。 - [IM SDK] 修复某些场景下调用 `updateMessage` 方法导致的内存与数据库消息不一致问题。 ## 版本 V3.9.7 Dev 2022-9-30 diff --git a/docs/document/applet/alipay.md b/docs/document/applet/alipay.md index 54a526767..6293a3f98 100644 --- a/docs/document/applet/alipay.md +++ b/docs/document/applet/alipay.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 +开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 ### 搭建支付宝小程序开发环境 @@ -46,7 +46,7 @@ wss://im-api-alipay.easemob.com/websocket | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-alipay-41.easemob.com 或 im-api-alipay-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-alipay-71.easemob.com 或 im-api-alipay-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台 > **即时通讯** > **服务概览**中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/applet/baidu.md b/docs/document/applet/baidu.md index 1bbb98df9..99f6e0b4b 100644 --- a/docs/document/applet/baidu.md +++ b/docs/document/applet/baidu.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 +开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 ### 搭建百度小程序开发环境 @@ -50,7 +50,7 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK) | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台 > **即时通讯** > **服务概览**中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/applet/bytedance.md b/docs/document/applet/bytedance.md index 965783a99..16525bced 100644 --- a/docs/document/applet/bytedance.md +++ b/docs/document/applet/bytedance.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 +开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 ### 搭建抖音小程序开发环境 @@ -51,7 +51,7 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK) | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台 > **即时通讯** > **服务概览**中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/applet/connection.md b/docs/document/applet/connection.md index e377b82c3..cd8017695 100644 --- a/docs/document/applet/connection.md +++ b/docs/document/applet/connection.md @@ -48,5 +48,5 @@ conn.addEventHandler("connectionListener", { - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 diff --git a/docs/document/applet/initialization.md b/docs/document/applet/initialization.md index ad0dcc5e8..fa5e7800b 100644 --- a/docs/document/applet/initialization.md +++ b/docs/document/applet/initialization.md @@ -31,6 +31,6 @@ const conn = new EC.connection({ | `deviceId` | String | 否 | 设备 ID,为默认随机值。 | | `useOwnUploadFun` | Bool | 否 | 是否支持通过自己的路径将图片、文件上传到自己的服务器。
-`true`:支持,需要指定路径;
-(默认)`false`:关闭,通过消息服务器上传下载文件。 | | `autoReconnectNumMax` | Int | 否 | 最大重连次数。 | -| `apiUrl` | String | 是 | 指定的 REST 服务器。在未开启 DNS 的情况下使用,一般适用于开发者要实现数据隔离、特别注重数据安全的场景。要获取该服务器地址,需在环信控制台的**即时通讯 > 服务概览**页面,查看**域名配置**表格中的 **Rest Api** 设置。| -| `url` | String | 是 | 指定的消息服务器。在未开启 DNS 的情况下使用,一般适用于开发者要实现数据隔离、特别注重数据安全的场景。 要获取该服务器地址,需在环信控制台的**即时通讯 > 服务概览**页面,查看**域名配置**表格中的**微信小程序**或**支付宝小程序**设置。 | +| `apiUrl` | String | 是 | 指定的 REST 服务器。在未开启 DNS 的情况下使用,一般适用于开发者要实现数据隔离、特别注重数据安全的场景。要获取该服务器地址,需在环信控制台的 **应用概览**页面的 **开发配置信息** 区域看域名配置。| +| `url` | String | 是 | 指定的消息服务器。在未开启 DNS 的情况下使用,一般适用于开发者要实现数据隔离、特别注重数据安全的场景。要获取该服务器地址,需在环信控制台的 **应用概览**页面的 **开发配置信息** 区域看域名配置。 | diff --git a/docs/document/applet/login.md b/docs/document/applet/login.md index 65fa16eb3..5b503ffd6 100644 --- a/docs/document/applet/login.md +++ b/docs/document/applet/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/applet/qq.md b/docs/document/applet/qq.md index 72cd85a9b..23ba2f2a8 100644 --- a/docs/document/applet/qq.md +++ b/docs/document/applet/qq.md @@ -6,7 +6,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html),来获取唯一 appKey,SDK 初始化时需要配置 appKey。 +开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 appKey,SDK 初始化时需要配置 appKey。 ## 实现步骤 @@ -54,7 +54,7 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK) | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台 > **即时通讯** > **服务概览**中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/applet/serverconfig.md b/docs/document/applet/serverconfig.md index 54dbf9bb2..e9dc43654 100644 --- a/docs/document/applet/serverconfig.md +++ b/docs/document/applet/serverconfig.md @@ -25,7 +25,7 @@ ![img](/images/applet/config5.png) -7. 登陆环信后台获取 socket 域名,进入即时通讯-服务概览页,即可看到如图的域名展示。 +1. 登陆环信控制台获取 socket 域名,进入 **应用概览** 页,即可看到如图的域名展示。 :::tip 抖音小程序、QQ 小程序、百度小程序、uniapp 全平台等同微信小程序的域名一致,使用微信小程序栏的域名即可。 diff --git a/docs/document/applet/uniapp.md b/docs/document/applet/uniapp.md index e6b5daa05..c1797b52c 100644 --- a/docs/document/applet/uniapp.md +++ b/docs/document/applet/uniapp.md @@ -61,7 +61,7 @@ | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台>应用信息中查看:Console 中查看请求域名 +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/applet/wechat.md b/docs/document/applet/wechat.md index a14929a8a..16ede9f45 100644 --- a/docs/document/applet/wechat.md +++ b/docs/document/applet/wechat.md @@ -8,7 +8,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 +开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。 ### 搭建微信小程序开发环境 @@ -73,7 +73,7 @@ downloadFile 合法域名: | 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com | | 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com | -应用所在数据中心可以在环信用户管理后台>应用信息中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/flutter/connection.md b/docs/document/flutter/connection.md index ac01288d5..53f25596d 100644 --- a/docs/document/flutter/connection.md +++ b/docs/document/flutter/connection.md @@ -47,4 +47,4 @@ EMClient.getInstance.removeConnectionEventHandler('Identifier'); - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file diff --git a/docs/document/flutter/login.md b/docs/document/flutter/login.md index e0a6f97be..9f4a32d73 100644 --- a/docs/document/flutter/login.md +++ b/docs/document/flutter/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/flutter/message_recall.md b/docs/document/flutter/message_recall.md index 53b071f3a..fd4a12ab9 100644 --- a/docs/document/flutter/message_recall.md +++ b/docs/document/flutter/message_recall.md @@ -4,7 +4,7 @@ 发送方可以撤回一条发送成功的消息,包括已经发送的历史消息,离线消息或漫游消息。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/flutter/message_receipt.md b/docs/document/flutter/message_receipt.md index 1d48cd5e2..1bad78415 100644 --- a/docs/document/flutter/message_receipt.md +++ b/docs/document/flutter/message_receipt.md @@ -128,7 +128,7 @@ EMClient.getInstance.chatManager.addEventHandler( | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/flutter/multi_device.md b/docs/document/flutter/multi_device.md index 2f3a0449c..45830770c 100644 --- a/docs/document/flutter/multi_device.md +++ b/docs/document/flutter/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -120,13 +120,13 @@ EMClient.getInstance.addConnectionEventHandler( 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK 时,调用 `EMOptions#osType` 方法自定义设置登录设备的平台。确保该方法中的 `osType` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK 时,调用 `EMOptions#osType` 方法自定义设置登录设备的平台。确保该方法中的 `osType` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/flutter/overview.md b/docs/document/flutter/overview.md index dfae22d95..0328cd9a2 100644 --- a/docs/document/flutter/overview.md +++ b/docs/document/flutter/overview.md @@ -6,7 +6,7 @@ ## 前提条件 -开始前,请注册有效的环信即时通讯 IM 开发者账号和取得 App key,见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +开始前,请注册有效的环信即时通讯 IM 开发者账号和取得 App key,见 [环信控制台](https://console.easemob.com/user/login)。 ## 集成环境 @@ -45,7 +45,7 @@ await EMClient.getInstance.startCallback(); ### SDK 注册 -若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 ```dart try { diff --git a/docs/document/flutter/push/push_easemob_console.md b/docs/document/flutter/push/push_easemob_console.md index af1e1b824..d33dace8c 100644 --- a/docs/document/flutter/push/push_easemob_console.md +++ b/docs/document/flutter/push/push_easemob_console.md @@ -31,7 +31,7 @@ ```dart try { - // notifierName: 对应平台在环信后台的推送证书名称 + // notifierName: 对应平台在环信控制台的推送证书名称 // deviceToken: 推送token EMClient.getInstance.pushManager.bindDeviceToken( notifierName: notifierName, diff --git a/docs/document/harmonyos/connection.md b/docs/document/harmonyos/connection.md index 350a1b99e..64d514b51 100644 --- a/docs/document/harmonyos/connection.md +++ b/docs/document/harmonyos/connection.md @@ -53,4 +53,4 @@ ChatClient.getInstance().removeConnectionListener(connectionListener); - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 diff --git a/docs/document/harmonyos/error.md b/docs/document/harmonyos/error.md index 624e6c9b8..79f432f8c 100644 --- a/docs/document/harmonyos/error.md +++ b/docs/document/harmonyos/error.md @@ -17,7 +17,7 @@ HarmonyOS 中错误码的类为 `ChatError`。 | 4 | EXCEED_SERVICE_LIMIT | 超过服务限制:超过当前服务版本的数量限制,例如以下场景会提示该错误:
- 创建的用户 ID 数量超过购买服务的限制时提示该错误。
- 用户属性相关 API 超过调用频率限制,包括[设置当前用户的属性、获取单个或多个用户的用户属性和获取指定用户的指定用户属性的接口](userprofile.html)。 | | 7 | PARTIAL_SUCCESS | 服务请求返回成功,但有一些错误,例如,设置多个参数,有一些设置成功,另一些失败。 | | 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限。 | -| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。 | +| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看 App Key。 | | 101 | INVALID_USER_NAME | 用户 ID 不正确:一般情况下,用户 ID 为空时提示该错误,例如,邀请好友时 username 参数为空字符。 | | 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 | | 104 | INVALID_TOKEN | 用户 token 不正确:登录时提供的 token 为空或不正确。 | @@ -40,11 +40,11 @@ HarmonyOS 中错误码的类为 `ChatError`。 | 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制:该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如,用户最多可同时登录 4 台设备, A(开启了自动登录)、B、C 和 D。最初,用户在这四个设备上均为登录状态,但由于网络连接原因登出了设备 A,然后手动登录了设备 E。这种情况下,设备 A 的网络恢复正常时会自动登录,这时登录失败且提示该错误。 | | 215 | USER_MUTED | 用户在群组或聊天室中被禁言:用户被禁言后发送消息时提示该错误。 | | 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 | -| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | +| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | | 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录:用户在同一台设备上退出登录前又使用另一账户登录。 | | 219 | USER_MUTED_BY_ADMIN | 用户被禁言:用户被全局禁言后发送消息时提示该错误。 | | 220 | USER_DEVICE_CHANGED | 用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如,用户自动登录设备 A,之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。 | -| 221 | USER_NOT_ON_ROSTER | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 服务概览**页面的**设置**区域开启好友关系检查功能。| +| 221 | USER_NOT_ON_ROSTER | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面开启好友关系检查功能。| | 300 | SERVER_NOT_REACHABLE | 服务器不可达:例如,发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时因网络不稳定导致失败,也会返回该错误。 | | 301 | SERVER_TIMEOUT | 请求服务超时:如果调用 API 在特定时间内服务器未响应则返回该错误,一般为 30 秒或 60 秒。 | | 302 | SERVER_BUSY | 服务器忙碌:服务器当前忙碌会返回该错误,建议稍后再尝试请求。 | diff --git a/docs/document/harmonyos/login.md b/docs/document/harmonyos/login.md index 0792cafdc..110826798 100644 --- a/docs/document/harmonyos/login.md +++ b/docs/document/harmonyos/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/harmonyos/message_recall.md b/docs/document/harmonyos/message_recall.md index b51a0d286..bc235a89e 100644 --- a/docs/document/harmonyos/message_recall.md +++ b/docs/document/harmonyos/message_recall.md @@ -7,7 +7,7 @@ - 对于单聊会话,只支持发送方撤回发送成功的消息。若消息过期,撤回失败。 - 对于群组/聊天室会话,普通成员只能撤回自己发送的消息,若消息过期,撤回失败。群主/聊天室所有者和管理员可撤回其他用户发送的消息,即使消息过期也能撤回。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/harmonyos/message_receipt.md b/docs/document/harmonyos/message_receipt.md index 0f37a3c2f..b5c87ce42 100644 --- a/docs/document/harmonyos/message_receipt.md +++ b/docs/document/harmonyos/message_receipt.md @@ -142,7 +142,7 @@ ChatClient.getInstance().chatManager()?.addMessageListener(msgListener); | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/harmonyos/multi_device.md b/docs/document/harmonyos/multi_device.md index 17ff3bf02..51114aa3a 100644 --- a/docs/document/harmonyos/multi_device.md +++ b/docs/document/harmonyos/multi_device.md @@ -10,7 +10,7 @@ - 好友和群组相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -110,13 +110,13 @@ ChatClient.getInstance().addConnectionListener({ 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK 时,调用 `ChatOptions#setCustomOSPlatform` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK 时,调用 `ChatOptions#setCustomOSPlatform` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/harmonyos/overview.md b/docs/document/harmonyos/overview.md index 289e883af..f324cc2bb 100644 --- a/docs/document/harmonyos/overview.md +++ b/docs/document/harmonyos/overview.md @@ -6,7 +6,7 @@ ## 前提条件 -开始前,请注册有效的环信即时通讯 IM 开发者账号并取得 App key,见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +开始前,请注册有效的环信即时通讯 IM 开发者账号并取得 App key,见 [环信控制台](https://console.easemob.com/user/login)。 ## 集成环境 @@ -58,7 +58,7 @@ ChatClient.getInstance().init(context, options); ### SDK 注册 -若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 ```typescript ChatClient.getInstance().createAccount(userId, pwd).then(()=> { diff --git a/docs/document/harmonyos/push/push_template.md b/docs/document/harmonyos/push/push_template.md index b3fc0aa91..ac16a3fc8 100644 --- a/docs/document/harmonyos/push/push_template.md +++ b/docs/document/harmonyos/push/push_template.md @@ -137,7 +137,7 @@ export class PushTemplate { // 下面以文本消息为例,其他类型的消息设置方法相同。 const message = ChatMessage.createTextSendMessage(conversationId, "消息内容"); if (message) { - // 设置推送模板名称。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 + // 设置推送模板名称。设置前需在环信控制台或调用 REST 接口创建推送模板。 // 若为默认模板,无需传入模板名称。 // 若为自定义模板,需传入模板名称。 let templateName = "自定义推送模板名称"; @@ -200,9 +200,9 @@ export class PushTemplate { // 下面以文本消息为例,其他类型的消息设置方法相同。 const message = ChatMessage.createTextSendMessage(conversationId, "消息内容"); if (message) { - // 设置推送模板名称。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 + // 设置推送模板名称。设置前需在环信控制台或调用 REST 接口创建推送模板。 // 设置填写模板标题的 value 数组。 - let titleArgs = ["您","消息,"]; + let titleArgs = ["您","消息,"]; // 设置填写模板内容的 value 数组。 let contentArgs = ["请","查看"]; let templateName = "push"; // 此处 `push` 为已在创建的推送模板名称。 diff --git a/docs/document/ios/connection.md b/docs/document/ios/connection.md index f36f4bc10..c83aeecac 100644 --- a/docs/document/ios/connection.md +++ b/docs/document/ios/connection.md @@ -61,4 +61,4 @@ extension ViewController: EMClientDelegate { - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file diff --git a/docs/document/ios/error.md b/docs/document/ios/error.md index 0bfa6cf17..9c404e5fc 100644 --- a/docs/document/ios/error.md +++ b/docs/document/ios/error.md @@ -18,7 +18,7 @@ iOS 的错误码只有当操作出错的时候才会有返回值,否则返回 | 3 | EMErrorDatabaseOperationFailed | 数据库操作失败:打开本地数据库失败。 | 需要根据调用的 API 结合日志分析,如果使用 `EMConversation#updateMessage` 方法更新一条本地不存在的消息,可能返回该错误;在数据库未打开时,调用其他本地数据库操作,也可能返回该错误。 | | 4 | EMErrorExceedServiceLimit | 超过服务限制:超过当前服务版本的数量限制,例如,创建的用户 ID 数量超过购买服务的限制时提示该错误;设置和获取用户属性的接口,包括[设置当前用户的属性](userprofile.html#设置当前用户的所有属性)、[获取单个或多个用户的用户属性](userprofile.html#获取用户的所有属性)和[获取指定用户的指定用户属性](userprofile.html#获取用户的指定属性),超过调用频率限制时,会上报该错误。| 检查调用的 API,若传入 `limit` 参数,可将该参数控制在上限内,若是限流导致,可以在延后一段时间重新调用。 | | 8 | EMAppActiveNumbersReachLimitation | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限。 | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 | -| 100 | EMErrorInvalidAppkey | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | +| 100 | EMErrorInvalidAppkey | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | | 101 | EMErrorInvalidUsername | 用户 ID 不正确:一般情况下,用户 ID 为空时提示该错误,例如,邀请好友时 username 参数为空字符。 | 检查报错API 中传入的用户 ID 参数是否为空。 | | 102 | EMErrorInvalidPassword | 用户密码不正确:登录时提供的密码为空或不正确。 | 检查调用的 API 中传的密码参数是否正确。 | | 103 | EMErrorInvalidURL | URL 不正确。 | 检查调用 API 时传入的参数是否正确。 | @@ -43,11 +43,11 @@ iOS 的错误码只有当操作出错的时候才会有返回值,否则返回 | 214 | EMErrorUserLoginTooManyDevices | 用户登录设备数超过限制:该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如,用户最多可同时登录 4 台设备, A(开启了自动登录)、B、C 和 D。最初,用户在这四个设备上均为登录状态,但由于网络连接原因登出了设备 A,然后手动登录了设备 E。这种情况下,设备 A 的网络恢复正常时会自动登录,这时登录失败且提示该错误。 | 可增加同时在线的设备数量,或先使用 `EMClient#kickDevice` 踢掉其他设备再登录。 | | 215 | EMErrorUserMuted | 用户在群组聊天室中被禁言:用户被禁言后发送消息时提示该错误。 | 用户在群组/聊天室内被禁言情况下,不能发送消息,可在 UI 上限制。 | | 216 | EMErrorUserKickedByChangePassword | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 | 密码更新会收到回调`EMClientDelegate#userAccountDidForcedToLogout`,需要在收到该回调时,调用 `EMClient#logout` 方法,并回到登录页面。| -| 217 | EMErrorUserKickedByOtherDevice | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`EMClientDelegate#userAccountDidForcedToLogout`。收到该回调时,需调用`EMClient#logout` 方法,并回到登录页面。 | +| 217 | EMErrorUserKickedByOtherDevice | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`EMClientDelegate#userAccountDidForcedToLogout`。收到该回调时,需调用`EMClient#logout` 方法,并回到登录页面。 | | 218 | EMErrorUserAlreadyLoginAnother | 其他用户已登录:用户在同一台设备上退出登录前又使用另一账户登录。 | 如果在已登录情况下,要登录另一个账号,需要先调用`EMClient#logut` 退出账号。 | | 219 | EMErrorUserMutedByAdmin | 用户被禁言:用户在群组/聊天室开启全员禁言时发送消息时提示该错误。 | 在群组/聊天室开启全员禁言的情况下,不能发送消息,可在 UI 上限制。 | | 220 | EMErrorUserDeviceChanged | 用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如,用户自动登录设备 A,之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。 | 登录失败的设备会收到 EMClientDelegate#userAccountDidLoginFromOtherDevice 事件。收到该事件时,需调用 `EMClient#logout` 方法,并回到登录页面。 | -| 221 | EMErrorUserNotOnRoster | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 服务概览**页面的**设置**区域开启好友关系检查功能。 | 需要先调用 `EMContactManager#addContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | +| 221 | EMErrorUserNotOnRoster | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 开启好友关系检查功能。 | 需要先调用 `EMContactManager#addContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | | 300 | EMErrorServerNotReachable | 服务器不可达:例如,发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时因网络不稳定导致失败,也会返回该错误 | 调用登录 API 返回该错误码,可能是由于网络受限,或域名被封禁,可尝试切换设备网络。如果用户在沙特/菲律宾等地区,需要联系商务,开启 dnsconfig中 TLS 加密。其他操作返回该错误码,一般是网络问题,可在切换网络或延迟一段时间后重新调用。 | | 301 | EMErrorServerTimeout | 请求服务超时:如果调用 API 在特定时间内服务器未响应则返回该错误,一般为 30 秒或 60 秒。| 一般是网络问题,可在切换网络或延迟一段时间后重新调用 API。 | | 302 | EMErrorServerBusy | 服务器忙碌:服务器当前忙碌,建议稍后重试。 | 检查调用的 API 是否重复调用。如果在上次调用后,结果未返回时重复调用 API,可能返回该错误码。 | diff --git a/docs/document/ios/login.md b/docs/document/ios/login.md index 29cce3c51..7f9171bc1 100644 --- a/docs/document/ios/login.md +++ b/docs/document/ios/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/ios/message_recall.md b/docs/document/ios/message_recall.md index 6dff31daf..d7bc572c4 100644 --- a/docs/document/ios/message_recall.md +++ b/docs/document/ios/message_recall.md @@ -7,7 +7,7 @@ - 对于单聊会话,只支持发送方撤回发送成功的消息。若消息过期,撤回失败。 - 对于群组/聊天室会话,普通成员只能撤回自己发送的消息,若消息过期,撤回失败。群主/聊天室所有者和管理员可撤回其他用户发送的消息,即使消息过期也能撤回。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/ios/message_receipt.md b/docs/document/ios/message_receipt.md index e3385aed0..e555793c1 100644 --- a/docs/document/ios/message_receipt.md +++ b/docs/document/ios/message_receipt.md @@ -160,7 +160,7 @@ EMChatManagerDelegate | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/ios/multi_device.md b/docs/document/ios/multi_device.md index eb2bfd742..b274a9624 100644 --- a/docs/document/ios/multi_device.md +++ b/docs/document/ios/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -114,13 +114,13 @@ option.customDeviceName = @"XXX的iPad"; 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击**新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在 **多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK 时,调用 `initializeSDKWithOptions` 方法设置 `EMOptions#customOSType` 属性添加自定义平台。确保该属性的值与环信控制台的**新增自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK 时,调用 `initializeSDKWithOptions` 方法设置 `EMOptions#customOSType` 属性添加自定义平台。确保该属性的值与环信控制台的 **新增自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/ios/push/push_overview.md b/docs/document/ios/push/push_overview.md index ad01ca260..b6fdd0fa3 100644 --- a/docs/document/ios/push/push_overview.md +++ b/docs/document/ios/push/push_overview.md @@ -8,7 +8,7 @@ 客户端断开连接或应用进程被关闭等原因导致用户离线时,即时通讯 IM 会通过 APNs 消息推送服务向该离线用户的设备推送消息通知,暂时保存这些消息。当用户再次上线时,服务器会将离线期间的消息发送给用户(这里角标表示的是离线消息数,并不是实际的未读消息数)。例如,当你离线时,有用户向你发送了消息,你的手机的通知中心会弹出消息通知,当你再次打开 app 并登录成功,即时通讯 IM SDK 会主动拉取你不在线时的消息。 -除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 +除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 **以下两种情况,即时通讯 IM 不会发送离线推送通知:** diff --git a/docs/document/ios/push/push_template.md b/docs/document/ios/push/push_template.md index 45968f588..6258e419b 100644 --- a/docs/document/ios/push/push_template.md +++ b/docs/document/ios/push/push_template.md @@ -128,7 +128,7 @@ //下面以文本消息为例,其他类型的消息设置方法相同。 EMTextMessageBody *body = [[EMTextMessageBody alloc]initWithText:@"test"]; EMChatMessage *message = [[EMChatMessage alloc]initWithConversationID:@"conversationId" from:@"currentUsername" to:@"conversationId" body:body ext:nil]; -//设置推送模板。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 +//设置推送模板。设置前需在环信控制台或调用 REST 接口创建推送模板。 NSDictionary *pushObject = @{ //设置推送模板名称。 //若为默认模板 `default` 或 `detail`,无需传入模板名称。若为自定义模板,需传入模板名称。 @@ -183,7 +183,7 @@ EMChatMessage *message = [[EMChatMessage alloc]initWithConversationID:@"conversa //设置推送模板。设置前需在环信控制台上创建推送模板。 NSDictionary *pushObject = @{ //设置推送模板名称。若不指定,设置默认推送模板的信息。 - //设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 + //设置前需在环信控制台或调用 REST 接口创建推送模板。 @"name":@"templateName", @"title_args":@[@"您",@"消息"],//设置填写模板标题的 value 数组。 @"content_args":@[@"请",@"查看"]//设置填写模板内容的 value 数组。 diff --git a/docs/document/react-native/connection.md b/docs/document/react-native/connection.md index 9066a5b6b..0e01861f8 100644 --- a/docs/document/react-native/connection.md +++ b/docs/document/react-native/connection.md @@ -78,4 +78,4 @@ ChatClient.getInstance().addConnectionListener({ - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 diff --git a/docs/document/react-native/login.md b/docs/document/react-native/login.md index 3d4297733..134dd26b0 100644 --- a/docs/document/react-native/login.md +++ b/docs/document/react-native/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/react-native/message_recall.md b/docs/document/react-native/message_recall.md index 5c665ae89..1dc127285 100644 --- a/docs/document/react-native/message_recall.md +++ b/docs/document/react-native/message_recall.md @@ -4,7 +4,7 @@ 发送方可以撤回一条发送成功的消息,包括已经发送的历史消息,离线消息或漫游消息。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/react-native/message_receipt.md b/docs/document/react-native/message_receipt.md index 1fe9e042a..2f0bbc713 100644 --- a/docs/document/react-native/message_receipt.md +++ b/docs/document/react-native/message_receipt.md @@ -133,7 +133,7 @@ ChatClient.getInstance().chatManager.addMessageListener({ | 使用限制 | 默认 | 描述 | | :------------------- | :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/react-native/multi_device.md b/docs/document/react-native/multi_device.md index a9860e9aa..b5033625b 100644 --- a/docs/document/react-native/multi_device.md +++ b/docs/document/react-native/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -139,13 +139,13 @@ ChatClient.getInstance() 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 -**设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 +**设备平台** 的取值范围为 [1,100],**设备数量** 的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK。确保该方法中的 `customOSType` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK。确保该方法中的 `customOSType` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/react-native/overview.md b/docs/document/react-native/overview.md index ba7d7a956..27db949a9 100644 --- a/docs/document/react-native/overview.md +++ b/docs/document/react-native/overview.md @@ -6,7 +6,7 @@ ## 前提条件 -开始前,请注册有效的环信即时通讯 IM 开发者账号和取得 App key,见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +开始前,请注册有效的环信即时通讯 IM 开发者账号和取得 App key,见 [环信控制台](https://console.easemob.com/user/login)。 ## 集成环境 @@ -83,7 +83,7 @@ ChatClient.getInstance() ### SDK 注册 -若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 ```typescript ChatClient.getInstance() diff --git a/docs/document/react-native/push/push_overview.md b/docs/document/react-native/push/push_overview.md index 299ff215c..1715b98b3 100644 --- a/docs/document/react-native/push/push_overview.md +++ b/docs/document/react-native/push/push_overview.md @@ -8,7 +8,7 @@ 客户端断开连接或应用进程被关闭等原因导致用户离线时,即时通讯 IM 会通过第三方消息推送服务向该离线用户的设备推送消息通知。当用户再次上线时,服务器会将离线期间的消息发送给用户(这里角标表示的是离线消息数,并不是实际的未读消息数)。例如,当你离线时,有用户向你发送了消息,你的手机的通知中心会弹出消息通知,当你再次打开 app 并登录成功,即时通讯 IM SDK 会主动拉取你不在线时的消息。 -除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 +除了满足用户离线条件外,要使用第三方离线推送,你还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息,例如,对于华为推送,需配置**证书名称**和**推送密钥**,并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 **以下两种情况,即时通讯 IM 不会发送离线推送通知:** diff --git a/docs/document/react-native/push/push_send_token_to_server.md b/docs/document/react-native/push/push_send_token_to_server.md index f580bbdfa..1cd83efeb 100644 --- a/docs/document/react-native/push/push_send_token_to_server.md +++ b/docs/document/react-native/push/push_send_token_to_server.md @@ -27,7 +27,7 @@ yarn add react-native-chat-sdk import { getPlatform, getDeviceType } from "react-native-push-collection"; import { ChatClient, ChatOptions, ChatPushConfig } from "react-native-chat-sdk"; -// 从环信即时通讯云控制台获取推送 ID、pushId +// 从环信控制台获取推送 ID、pushId const pushId = ""; // 设置推送类型 diff --git a/docs/document/react-native/releasenote.md b/docs/document/react-native/releasenote.md index ff56a39cb..1e773a1a7 100644 --- a/docs/document/react-native/releasenote.md +++ b/docs/document/react-native/releasenote.md @@ -330,7 +330,7 @@ - 修复极端情况下 SDK 崩溃的问题。 - 修复某些场景下调用 `updateMessage` 方法导致的内存与数据库中的消息不一致问题。 -- 适配 Android 12,修复依赖环信即时通讯云 SDK 的 APK 在 Android 12 版本的部分手机上第一次安装后打开时出现异常弹框的问题。 +- 适配 Android 12,修复依赖环信即时通讯 IM SDK 的 APK 在 Android 12 版本的部分手机上第一次安装后打开时出现异常弹框的问题。 ## 版本 V1.0.10 Dev 2022-10-13 diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md index ed4b103ce..cb2982519 100644 --- a/docs/document/server-side/account_system.md +++ b/docs/document/server-side/account_system.md @@ -62,7 +62,7 @@ - 开放注册指用户可以在登录客户端 SDK 后自行通过账号密码注册账号。 - 一般在体验 Demo 和测试开发环境时使用。 -- 使用前需先在[环信即时通讯云控制后台](https://console.easemob.com/user/login)打开相应应用的开放注册开关,即在控制台首页的 **应用列表** 下点击目标应用的 **操作** 一栏中的 **管理**,然后选择 **即时通讯** > **服务概览**,在页面的 **设置** 区域中将 **用户注册模式** 设置为 **开放注册**。 +- 使用前需先在[环信控制台](https://console.easemob.com/user/login)打开相应应用的开放注册开关,即在控制台的 **应用管理** 页面点击目标应用的 **操作** 一栏中的 **管理**,然后选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 - 调用该 API 无需传入 token。 - 注册用户时,需满足用户 ID 和密码的设置要求。 @@ -157,7 +157,7 @@ curl -X POST -i "https://XXXX.com/XXXX-demo/XXXX/users" -d '{"username":"user1", - 授权注册模式指注册环信即时通讯 IM 账号时携带管理员身份认证信息,即 App Token。 - 要使用该注册方式,你需要在环信控制台进行如下配置: -在控制台首页的 **应用列表** 下点击目标应用的 **操作** 一栏中的 **管理**,然后选择 **即时通讯** > **服务概览**,在页面的 **设置** 区域中将**用户注册模式**设置**授权注册**,然后单击**保存**。 +在控制台的 **应用管理** 页面点击目标应用的 **操作** 一栏中的 **管理**,然后选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为**授权注册**。 - 推荐使用该模式,因为该模式较为安全,可防止已获取了注册 URL 和了解注册流程的某些人恶意向服务器大量注册垃圾用户。 - 注册用户时,需满足用户 ID 和密码的设置要求。 diff --git a/docs/document/server-side/callback_contact.md b/docs/document/server-side/callback_contact.md index f39bbc1ce..59bbcb626 100644 --- a/docs/document/server-side/callback_contact.md +++ b/docs/document/server-side/callback_contact.md @@ -44,7 +44,7 @@ | `payload.reason` | object | / | | `payload.operation` | String | `add`:添加好友。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | @@ -85,7 +85,7 @@ | `payload.roster_ver` | String | 好友列表的版本号。 | | `payload.operation` | String | `remove`:删除好友。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | @@ -126,7 +126,7 @@ | `payload.roster_ver` | String | 好友列表的版本号。 | | `payload.operation` | String | `accept`:同意好友申请。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | @@ -169,7 +169,7 @@ | `payload.roster_ver` | String | 好友列表的版本号。 | | `payload.operation` | String | `decline`:拒绝好友申请。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | @@ -213,7 +213,7 @@ | `payload.status` | object | 包含 `error_code`。 | | `payload.status.error_code` | String | 操作失败对应的错误码。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | @@ -258,7 +258,7 @@ | `payload.status` | object | 包含 `error_code`。 | | `payload.status.error_code` | String | 操作失败对应的错误码。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发起方,格式为 `App Key_发起方用户 ID@easemob.com`。 | | `to` | String | 接收方用户 ID。 | | `eventType` | String |
- `chat`:上行消息
- `chat_offline`:离线消息。 | diff --git a/docs/document/server-side/callback_group_ban.md b/docs/document/server-side/callback_group_ban.md index 0f718de1a..ddb8b5dc9 100644 --- a/docs/document/server-side/callback_group_ban.md +++ b/docs/document/server-side/callback_group_ban.md @@ -43,7 +43,7 @@ | `paylod` | Object | 事件内容。 | | - `disabled`| Boolean |
- `true`:封禁
- `false`:解禁 | | - `type` | String | `DISABLE`:封禁或解禁操作。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件。由于聊天室无封禁或解禁事件,本次事件仅对群组有效,因此值只能为 `GROUP`。 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_block.md b/docs/document/server-side/callback_group_block.md index afc5ad4ab..aa00f4cbd 100644 --- a/docs/document/server-side/callback_group_block.md +++ b/docs/document/server-side/callback_group_block.md @@ -43,7 +43,7 @@ | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.type` | String | 屏蔽群组事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -86,7 +86,7 @@ | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.type` | String | 解除屏蔽群组事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_read_ack.md b/docs/document/server-side/callback_group_read_ack.md index 3c582d691..8ba1bbd70 100644 --- a/docs/document/server-side/callback_group_read_ack.md +++ b/docs/document/server-side/callback_group_read_ack.md @@ -55,7 +55,7 @@ | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `payload` | object | 包括:
- `ext`:消息扩展字段
- `ack_message_id`:消息 ID
- `msg_config.allow_group_ack`:是否需要群消息已读回执
- `type`:`read_ack` 表示消息已读回执。| | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发送已读回执的用户 ID。 | | `to` | String | 群组 ID。 | | `msg_id` | String | 该回执消息的消息 ID。 | diff --git a/docs/document/server-side/callback_group_room_admin.md b/docs/document/server-side/callback_group_room_admin.md index bd97ef778..198feee88 100644 --- a/docs/document/server-side/callback_group_room_admin.md +++ b/docs/document/server-side/callback_group_room_admin.md @@ -51,7 +51,7 @@ | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 添加为群组/聊天室管理员的用户 ID。 | | `payload.type` | String | 添加群组/聊天室管理员的事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -103,7 +103,7 @@ | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 被移除的群组/聊天室管理员的用户 ID。 | | `payload.type` | String | 移除群组/聊天室管理员的事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_allowlist.md b/docs/document/server-side/callback_group_room_allowlist.md index 308476983..8d533cbba 100644 --- a/docs/document/server-side/callback_group_room_allowlist.md +++ b/docs/document/server-side/callback_group_room_allowlist.md @@ -48,7 +48,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | Array | 被加入白名单的成员的用户 ID。 | | `payload.type` | String | 将群组/聊天室成员加入白名单的事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -97,7 +97,7 @@ | `paylod` | Object | 事件内容。 | | `payload.member` | JSON | 被移出白名单的成员的用户 ID。 | | `payload.type` | String | 将群组/聊天室成员移出白名单的事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_announcement.md b/docs/document/server-side/callback_group_room_announcement.md index cc3f2bc7c..ca46ac610 100644 --- a/docs/document/server-side/callback_group_room_announcement.md +++ b/docs/document/server-side/callback_group_room_announcement.md @@ -45,7 +45,7 @@ | `paylod` | Object | 事件内容。 | | - `type` | String | 公告更新事件。 | | - `announcement` | String | 新公告内容。若删除了公告内容,则该字段不存在。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_blocklist.md b/docs/document/server-side/callback_group_room_blocklist.md index 0f8875eff..92209d631 100644 --- a/docs/document/server-side/callback_group_room_blocklist.md +++ b/docs/document/server-side/callback_group_room_blocklist.md @@ -54,7 +54,7 @@ | `payload.member` | Array | 被加入或移出群组/聊天室黑名单的用户 ID。 | | `payload.expire_timestamp` | Long | 用户在黑名单中的过期时间。用户加入黑名单后,系统会自动分配该参数的值。 | | `payload.type` | String | 事件类型。`ADD` 表示将用户加入群组/聊天室黑名单。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -103,7 +103,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | Array | 被移出群组/聊天室黑名单的用户 ID。 | | `payload.type` | Array | 将用户移出群组/聊天室黑名单的事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_create.md b/docs/document/server-side/callback_group_room_create.md index 4d5ed25a9..ae32a9330 100644 --- a/docs/document/server-side/callback_group_room_create.md +++ b/docs/document/server-side/callback_group_room_create.md @@ -70,7 +70,7 @@ | `payload.role` | JSON | 群组角色。若设置了管理员,显示管理员角色,若未设置,则只显示群组角色:
- 用户 ID:`owner`
- 用户 ID:`admin` | | `payload.member`| Array | 创建群组时拉入群的用户。 | | `payload.info` | JSON | 新群组的相关信息。
- `owner`:String 类型,群主。
- `created`:Long 类型,群组创建时间。
- `custom`:String 类型,群组自定义信息。
- `description`:String 类型,群组描述。
- `mute`:Bool 类型,是否进行全员禁言,`true` 表示是,`false` 表示否。
- `mute_duration`:Long 类型,全员禁言时长,从当前时间开始计算。单位为秒。`0` 表示取消禁言,`-1` 表示永久禁言。
- `avatar`:String,群组头像 URL。
- `title`:String 类型,群组名称。
- `max_users`:群组最大成员数(包括群主)。
- `invite_need_confirm`:Bool 类型,邀请用户入群时是否需要被邀用户同意,`true` 表示需要被邀用户同意,`false` 表示不需要。
- `public`:Bool 类型,是否是公开群, `true` 表示公开群,`false` 表示私有群。
- `allow_user_invites`:Bool 类型,是否允许普通群成员邀请用户加入群组,`true` 表示允许,`false` 表示不允许,只有群主和群管理员才能邀请用户入群。
- `disabled`:Boolean 类型,`true` 表示群组为禁用状态,`false`,表示群组为非禁用状态,可正常使用。
- `last_modified`:Long 类型,群组信息的最新修改时间。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_delete.md b/docs/document/server-side/callback_group_room_delete.md index 75e2ed6da..f40ec553f 100644 --- a/docs/document/server-side/callback_group_room_delete.md +++ b/docs/document/server-side/callback_group_room_delete.md @@ -38,7 +38,7 @@ | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识,格式为 `App Key_UUID`。 | | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_info.md b/docs/document/server-side/callback_group_room_info.md index ffcf7bffa..bb4a05144 100644 --- a/docs/document/server-side/callback_group_room_info.md +++ b/docs/document/server-side/callback_group_room_info.md @@ -77,7 +77,7 @@ | `payload` | Object | 事件内容。 | | - `type`| String | | 群组信息修改事件。 | | - `info` | JSON | 修改后的群组信息。
- `owner`:String 类型,群主。
- `created`:Long 类型,群组创建时间。
- `custom`:String 类型,群组自定义信息。
- `description`:String 类型,群组描述。
- `mute`:Bool 类型,是否进行全员禁言,`true` 表示是,`false` 表示否。
- `mute_duration`:Long 类型,全员禁言时长,从当前时间开始计算。单位为秒。`0` 表示取消禁言,`-1` 表示永久禁言。
- `avatar`:String,群组头像 URL。
- `title`:String 类型,群组名称。
- `max_users`:群组最大成员数(包括群主)。
- `invite_need_confirm`:Bool 类型,邀请用户入群时是否需要被邀用户同意,`true` 表示需要被邀用户同意,`false` 表示不需要。
- `public`:Bool 类型,是否是公开群, `true` 表示公开群,`false` 表示私有群。
- `allow_user_invites`:Bool 类型,是否允许普通群成员邀请用户加入群组,`true` 表示允许,`false` 表示不允许,只有群主和群管理员才能邀请用户入群。
- `disabled`:Boolean 类型,`true` 表示群组为禁用状态,`false`,表示群组为非禁用状态,可正常使用。
- `last_modified`:Long 类型,群组信息的最新修改时间。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_join.md b/docs/document/server-side/callback_group_room_join.md index 4ba2b5a9a..e5d26d98c 100644 --- a/docs/document/server-side/callback_group_room_join.md +++ b/docs/document/server-side/callback_group_room_join.md @@ -58,7 +58,7 @@ | `payload.member` | JSON |
- 创建群组或聊天室时,被拉入进群/聊天室的用户 ID。
- 用户主动加入聊天室时,该用户的 ID。 | | `payload.options.ext` | JSON | 扩展信息。该字段只适用于加入聊天室事件,不适用于加群事件。 | | `payload.type` | Array | 加入方式:`DIRECT` 表示创建群组或聊天室时拉人进入或用户主动加入聊天室。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -109,7 +109,7 @@ | `payload` | Object | 事件内容。 | | `payload.member`| JSON | 被邀请的用户 ID。 | | `payload.type` | Array | 入群方式:`INVITE` 表示邀请用户入群。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室
由于聊天室无此事件,因此该参数只能为 `GROUP`。 | | `event` | String | 群组操作事件,值为 `group_op_event`。 | @@ -160,7 +160,7 @@ | `paylod` | Object | 事件内容。 | | `payload.member` | JSON | 申请加入的用户 ID。 | | `payload.type`| Array | 加入方式:`APPLY` 表示申请入群。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_leave.md b/docs/document/server-side/callback_group_room_leave.md index 6e957e175..a3a1cb86f 100644 --- a/docs/document/server-side/callback_group_room_leave.md +++ b/docs/document/server-side/callback_group_room_leave.md @@ -77,7 +77,7 @@ | `payload.member` | JSON | 退出群组/聊天室的用户 ID。 | | `payload.action` | JSON | 该字段只适用于退出聊天室事件,不适用于退出群组事件:
- `user_quit`:退出聊天室的用户 ID。
- `user_offline`:因离线退出聊天室。 | | `payload.type` | Array | 退出方式:`QUIT` 表示主动退出群组或聊天室或者因离线退出聊天室。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -130,7 +130,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被踢出群组/聊天室的用户 ID。 | | `payload.type` | Array | 退群方式:`KICK` 表示将用户踢出群组/聊天室。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -184,7 +184,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被加入群组/聊天室黑名单后离开的用户 ID。 | | `payload.type` | Array | 退群方式:`BLOCK` 表示加入群组/聊天室黑名单后离开群组/聊天室。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -239,7 +239,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 群组/聊天室被解散后离开的用户 ID。 | | `payload.type` | Array | 退群方式:`DELETE` 表示群组/聊天室被解散后,用户离开群组/聊天室。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | | `timestamp` | Long | 操作完成的时间戳。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | diff --git a/docs/document/server-side/callback_group_room_mute.md b/docs/document/server-side/callback_group_room_mute.md index 33f30b484..e8739940c 100644 --- a/docs/document/server-side/callback_group_room_mute.md +++ b/docs/document/server-side/callback_group_room_mute.md @@ -51,7 +51,7 @@ | `payload.member` | JSON | 被加入禁言列表的成员的用户 ID。 | | `payload.expire_timestamp` | LONG | 禁言过期时间。将群组或聊天室成员禁言后,系统会自动分配一个禁言过期时间戳。 | | `payload.type` | String | 将成员加入禁言列表的事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM`:聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -100,7 +100,7 @@ | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被移出禁言列表的成员的用户 ID。 | | `payload.type` | String | 将成员移出禁言列表的事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_muteall.md b/docs/document/server-side/callback_group_room_muteall.md index 7b1664c16..4c8fbd18d 100644 --- a/docs/document/server-side/callback_group_room_muteall.md +++ b/docs/document/server-side/callback_group_room_muteall.md @@ -47,7 +47,7 @@ | `paylod` | Object | 事件内容。 | | `payload.mute` | JSON | 全员禁言或解除全员禁言:
- `true`:全员禁言
- `false`:解除全员禁言 | | `payload.type` | String | 全员禁言/解除全员禁言事件,值为 `MUTE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_room_owner.md b/docs/document/server-side/callback_group_room_owner.md index 8c448e149..efe6e11d3 100644 --- a/docs/document/server-side/callback_group_room_owner.md +++ b/docs/document/server-side/callback_group_room_owner.md @@ -51,7 +51,7 @@ | - `owner`| String | 原群主。 | | - `new_owner` | String | 新群主。 | | - `type` | String | 值为 `OWNER`,表示操作类型为变更群主。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_group_shared_file.md b/docs/document/server-side/callback_group_shared_file.md index 7e2730612..515a860f0 100644 --- a/docs/document/server-side/callback_group_shared_file.md +++ b/docs/document/server-side/callback_group_shared_file.md @@ -48,7 +48,7 @@ | `payload` | Object | 事件内容。 | | - `share_file`| String | 上传的群组共享文件。 | | - `type` | String | 群组共享文件上传事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -96,7 +96,7 @@ | `payload` | Object | 事件内容。 | | - `share_file`| String | 删除的群组共享文件。 | | - `type` | String | 群组共享文件删除事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 群组 ID。 | | `type` | String | 区分群组或聊天室事件:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_login_logout.md b/docs/document/server-side/callback_login_logout.md index 5615c45b5..29908996b 100644 --- a/docs/document/server-side/callback_login_logout.md +++ b/docs/document/server-side/callback_login_logout.md @@ -33,7 +33,7 @@ app 用户状态分为在线和离线两种,即用户已连接到环信即时 | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `user` | String | 登录用户识别号,格式为 `{app key_username@easemob.com/device operating system_device ID}`,其中 `@easemob.com` 为固定字符串,`device ID` 由 SDK 随机生成。 | | `version` | String | SDK 版本号。 | | `timestamp` | long | 登录请求到环信 IM 服务器的 Unix 时间戳,单位为 ms。 | @@ -69,7 +69,7 @@ app 用户状态分为在线和离线两种,即用户已连接到环信即时 | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `user` | String | 登录用户识别号,格式为 `{app key_username@easemob.com/device operating system_device ID}`,其中 `@easemob.com` 为固定字符串,`device ID` 由 SDK 随机生成。 | | `version` | String | SDK 版本号。 | | `timestamp` | long | 请求到环信 IM 服务器的 Unix 时间戳,单位为 ms。 | @@ -105,7 +105,7 @@ app 用户状态分为在线和离线两种,即用户已连接到环信即时 | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `user` | String | 登录用户识别号,格式为 `{app key_username@easemob.com/device operating system_device ID}`,其中 `@easemob.com` 为固定字符串,`device ID` 由 SDK 随机生成。 | | `version` | String | SDK 版本号。 | | `timestamp` | long | 请求到环信 IM 服务器的 Unix 时间戳,单位为毫秒 。 | diff --git a/docs/document/server-side/callback_message_modify.md b/docs/document/server-side/callback_message_modify.md index 53ca84d26..f7beaf5fc 100644 --- a/docs/document/server-side/callback_message_modify.md +++ b/docs/document/server-side/callback_message_modify.md @@ -74,7 +74,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -144,7 +144,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -223,7 +223,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -297,7 +297,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -373,7 +373,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -445,7 +445,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -522,7 +522,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | @@ -600,7 +600,7 @@ | `eventType` | String | `chat` 上行消息、`chat_offline` 离线消息。 | | `chat_type` | String | `edit`,表示修改消息。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [配置环信控制台回调规则](callback_postsending.html#发送后回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 消息发送方的用户 ID。 | | `to` | String | 消息接收方。
- 单聊为接收方用户 ID;
- 群聊为群组 ID;
- 聊天室聊天为聊天室 ID。 | | `msg_id` | String | 该消息修改事件消息的 ID。 | diff --git a/docs/document/server-side/callback_message_recall.md b/docs/document/server-side/callback_message_recall.md index 4e94a7545..66300dfac 100644 --- a/docs/document/server-side/callback_message_recall.md +++ b/docs/document/server-side/callback_message_recall.md @@ -20,7 +20,7 @@ | `payload` | object | 事件内容,与通过 REST API 发送过来的一致,查看 [历史消息内容](message_historical.html#历史消息记录的内容)。 | | `securityVersion` | String | 安全校验版本,目前为 1.0.0。忽略此参数,以后会改成 Console 后台做设置。 | | `security` | String | 签名,格式如下: MD5(callId+secret+timestamp)。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `host` | String | 服务器名称。 | payload 中字段含义: diff --git a/docs/document/server-side/callback_message_send.md b/docs/document/server-side/callback_message_send.md index 3bd8887b7..381d73b6f 100644 --- a/docs/document/server-side/callback_message_send.md +++ b/docs/document/server-side/callback_message_send.md @@ -15,7 +15,7 @@ | `payload` | object | 事件内容,与通过 REST API 发送过来的一致,查看 [历史消息内容](message_historical.html#历史消息记录的内容)。 | | `securityVersion` | String | 安全校验版本,目前为 1.0.0。忽略此参数,以后会改成 Console 后台做设置。 | | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。 Secret 见 Console 后台回调规则。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `host` | String | 服务器名称。 | | `content_type` | String | 消息类型:
- `chat:user:*`:单聊消息
- `chat:group:*`:群组消息
- `chat:room:*`:聊天室消息
文本、图片、音视频等消息对应的参数值,详见[发送单聊消息](#发送单聊消息)、[发送群组消息](#发送群组消息)和[发送聊天室消息](#发送聊天室消息)章节。 | diff --git a/docs/document/server-side/callback_overview.md b/docs/document/server-side/callback_overview.md index 7053f3446..af07a3322 100644 --- a/docs/document/server-side/callback_overview.md +++ b/docs/document/server-side/callback_overview.md @@ -4,7 +4,7 @@ ## 概述 -环信即时通讯云支持回调功能,即会在事件发生之前或之后,环信 IM 服务器会以 HTTP POST 请求的形式向你的应用服务器发送通知。根据是否干预消息投递,回调分为两类: +环信即时通讯 IM 支持回调功能,即会在事件发生之前或之后,环信 IM 服务器会以 HTTP POST 请求的形式向你的应用服务器发送通知。根据是否干预消息投递,回调分为两类: - **发送前回调**:旨在让 app 后台干预该事件的处理逻辑,环信服务器会根据响应中的返回值确定后续处理流程。**该类回调仅适用于从你的客户端应用发送的消息。** diff --git a/docs/document/server-side/callback_postsending.md b/docs/document/server-side/callback_postsending.md index c20acf052..1f4ab27cd 100644 --- a/docs/document/server-side/callback_postsending.md +++ b/docs/document/server-side/callback_postsending.md @@ -130,11 +130,11 @@ GET https://{host}/{org_name}/{app_name}/callbacks/storage/info | `path` | string | 请求路径。 | | `uri` | string | 请求路径的 URI。 | | `timestamp` | long | 环信 IM 服务器接收到此消息的 Unix 时间戳,单位为毫秒。 | -| `organization` | string | 你在环信 IM 管理后台注册的组织唯一标识。 | -| `application` | string | 你在环信 IM 管理后台注册的 App 唯一标识。 | +| `organization` | string | 你在环信控制台注册的组织唯一标识。 | +| `application` | string | 你在环信控制台注册的 App 唯一标识。 | | `action` | string | 请求方法。 | | `duration` | long | 请求耗时,单位为毫秒。 | -| `applicationName` | string | 你在环信 IM 管理后台注册的 App 名称。 | +| `applicationName` | string | 你在环信控制台注册的 App 名称。 | | `data` | object | 响应数据内容。包括以下三个参数:`date`、`size` 和 `retry`。 | | - `date` | String | 当前的 date key,即每 10 分钟内的消息和事件。key 为 10 分钟的起点。 | | - `size` | Int | 该 date key 内的消息数量。 | @@ -222,7 +222,7 @@ POST https://{host}/{org_name}/{app_name}/callbacks/storage/retry | `uri` | String | 请求路径的 URI。 | | `timestamp` | long | 环信 IM 服务器接收到此消息的 Unix 时间戳,单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司(组织)分配的唯一标识,与请求参数 `org_name` 相同。 | -| `application` | String | 你在环信 IM 管理后台注册的 app 唯一标识。 | +| `application` | String | 你在环信控制台注册的 app 唯一标识。 | | `action` | String | 请求方法。 | | `data` | Bool | - `success`:成功;
- `failure`:失败。 | | `duration` | long | 请求耗时,单位为毫秒。 | diff --git a/docs/document/server-side/callback_room_superadmin.md b/docs/document/server-side/callback_room_superadmin.md index d1dbbb781..2e3bb0c86 100644 --- a/docs/document/server-side/callback_room_superadmin.md +++ b/docs/document/server-side/callback_room_superadmin.md @@ -47,7 +47,7 @@ | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 添加的聊天室超级管理员的用户 ID。 | | `payload.type` | String | 添加聊天室超级管理员的事件,值为 `ADD`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 聊天室 ID。 | | `type` | String | 区分群组或聊天室事件。本事件仅对聊天室有效,因此该参数的值只能为 `CHATROOM`:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | @@ -95,7 +95,7 @@ | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 移除的聊天室超级管理员的用户 ID。 | | `payload.type` | String | 移除聊天室超级管理员的事件,值为 `REMOVE`。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `id` | String | 聊天室 ID。 | | `type` | String | 区分群组或聊天室事件。本事件仅对聊天室有效,因此该参数的值只能为 `CHATROOM`:
- `GROUP`:群组
- `CHATROOM` :聊天室 | | `event` | String | 对于群组和聊天室,该参数的值固定为 `group_op_event`。接收方可按此字段区分是否是群组/聊天室操作事件。 | diff --git a/docs/document/server-side/callback_single_conversation_ack.md b/docs/document/server-side/callback_single_conversation_ack.md index 6c0cb0108..da59778c9 100644 --- a/docs/document/server-side/callback_single_conversation_ack.md +++ b/docs/document/server-side/callback_single_conversation_ack.md @@ -14,7 +14,7 @@ | `payload.ack_message_id` | String | 会话中消息的消息 ID。 | | `payload.type` | String | 会话已读回执类型。 | | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发送已读回执的用户。| | `to` | String | 接收已读回执的用户。 | | `msg_id` | String | 已读回执的消息 ID。 | diff --git a/docs/document/server-side/callback_single_read_ack.md b/docs/document/server-side/callback_single_read_ack.md index a4c4c8077..1ce317d0f 100644 --- a/docs/document/server-side/callback_single_read_ack.md +++ b/docs/document/server-side/callback_single_read_ack.md @@ -49,7 +49,7 @@ | `security` | String | 签名,格式如下: `MD5(callId+secret+timestamp)`。 Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `payload` | object | 包括:
- `ext`:消息扩展字段
- `ack_message_id`:消息 ID
- `bodies`:消息体内容。 | | `host` | String | 服务器名称。 | -| `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | +| `appkey` | String | 你在环信控制台注册的应用唯一标识。 | | `from` | String | 发送已读回执用户 ID。 | | `to` | String | 接收已读回执用户 ID。 | | `eventType` | String | `chat`:表示上行消息。 | diff --git a/docs/document/server-side/java_server_sdk.md b/docs/document/server-side/java_server_sdk.md index 026dfef0e..b3dfdedac 100644 --- a/docs/document/server-side/java_server_sdk.md +++ b/docs/document/server-side/java_server_sdk.md @@ -12,7 +12,7 @@ Server SDK 提供了用户、消息、群组、聊天室等资源的操作管理 - Java 1.8 - [Reactor](https://projectreactor.io/)(io.projectreactor:reactor-bom:2020.0.4) -- 有效的环信即时通讯 IM 开发者账号和 App Key、Client ID、ClientSecret,登录 [环信管理后台](https://console.easemob.com/user/login) 到“应用列表” → 点击“查看”即可获取到 App Key、Client ID、ClientSecret。 +- 有效的环信即时通讯 IM 开发者账号和 App Key、Client ID、ClientSecret,登录 [环信控制台](https://console.easemob.com/user/login) 到“应用列表” → 点击“查看”即可获取到 App Key、Client ID、ClientSecret。 ## 实现方法 diff --git a/docs/document/server-side/java_server_sdk_2.0.md b/docs/document/server-side/java_server_sdk_2.0.md index 7a18278dd..d6927e477 100644 --- a/docs/document/server-side/java_server_sdk_2.0.md +++ b/docs/document/server-side/java_server_sdk_2.0.md @@ -11,7 +11,7 @@ Server SDK 2.0 提供了用户、消息、群组、聊天室等资源的操作 ## 前提条件 - Java 1.8 -- 有效的环信即时通讯 IM 开发者账号和 App Key、Client ID、ClientSecret、BasePath (对应的 RESTful API 域名,详见环信控制台的**即时通讯 > 服务概览**页面下的**域名配置区域**),登录 [环信管理后台](https://console.easemob.com/user/login) 到“应用列表” → 点击“查看”即可获取到 App Key、Client ID、ClientSecret,到"即时通讯" → 点击"服务概览"获取到 "Rest api" 的服务器域名。 +- 有效的环信即时通讯 IM 开发者账号和 App Key、Client ID、ClientSecret、BasePath (对应的 RESTful API 域名,详见环信控制台的 **应用概览**页面下的 **开发配置信息** 区域)。 ## 实现方法 diff --git a/docs/document/server-side/keyword_add.md b/docs/document/server-side/keyword_add.md index afb62e6c0..0c944a650 100644 --- a/docs/document/server-side/keyword_add.md +++ b/docs/document/server-side/keyword_add.md @@ -3,7 +3,7 @@ ## 功能说明 - 添加关键词。 -- 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 100,000 个词条。 +- 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 1,000,000 个词条。 **调用频率上限**:100 次/秒/App Key @@ -164,7 +164,7 @@ curl -X POST 'https://XXXX/XXXX/XXXX/moderation/text/list/{list_id}/word/batch' | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 | | :----------- | :--- | :------------- | :----------- | :----------- | | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法,可能过期或 token 错误。 | 使用新的 token 访问。 | -| 400 | Bad Request | The text count exceeds the maximum number | 关键词数量超限。 | 减少关键词数量。每个名单最多可添加 10,000 个关键词,每个应用最多可配置 100,000 个词条。| +| 400 | Bad Request | The text count exceeds the maximum number | 关键词数量超限。 | 减少关键词数量。每个名单最多可添加 10,000 个关键词,每个应用最多可配置 1,000,000 个词条。| | 400 | Bad Request | request data is empty | 新增名单为空。 | 添加关键词名单。 | | 400 | Bad Request | textList data is empty | 不存在关键词名单。 | 先创建名单,再操作。 | | 400 | Bad Request | The textList already contains the text | 关键词重复。 | 去除重复关键词。 | diff --git a/docs/document/server-side/keyword_list_create.md b/docs/document/server-side/keyword_list_create.md index abf7bf2e4..b3897f6fc 100644 --- a/docs/document/server-side/keyword_list_create.md +++ b/docs/document/server-side/keyword_list_create.md @@ -5,7 +5,7 @@ - 创建关键词名单。 - 关键词名单为增值服务,在 [文本审核规则](/product/moderation/moderation_rule_config.html#设置审核规则) 中应用。使用前,你需要开通 [文本审核服务](/product/moderation/moderation_enable.html), 配置 [文本审核规则](/product/moderation/moderation_rule_config.html#设置审核规则),并开通 [关键词名单服务](/product/moderation/moderation_keyword#使用关键词审核)。 - 创建的名单会在环信控制台的 **关键词名单** 列表(**即时通讯** > **内容审核** > **文本审核** > **关键词名单**)中展示。你可以在环信控制台编辑、删除名单或进行添加/删除关键词等操作。 -- 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 100,000 个词条。 +- 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 1,000,000 个词条。 **调用频率上限**:100 次/秒/App Key @@ -176,7 +176,7 @@ curl -X POST 'https://XXXX/XXXX/XXXX/moderation/text/list' \ | 400 | Bad Request | The text count exceeds the maximum number | 关键词数量超过上限。 | 减少关键词数量。 | | 400 | Bad Request | The textList already exists | 关键词名单名称已存在。 | 修改关键词名单名称。 | | 400 | Bad Request | moderation org data is empty | 你未开通内容审核服务。 | 开通内容审核服务。 | -| 400 | Bad Request | the number of words exceeds the limit | 应用下面的关键词总数超过上限。每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 100,000 个词条。| 减少关键词数量。 | +| 400 | Bad Request | the number of words exceeds the limit | 应用下面的关键词总数超过上限。每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 1,000,000 个词条。| 减少关键词数量。 | | 400 | MODERATION_002 | "request param is empty | 若未设置必填参数,例如 `name` 或 `scope`,会提示该错误。 | 请传入必填参数。 | 关于其他错误,你可以参考 [错误码页面](error.html) 了解可能的原因。 \ No newline at end of file diff --git a/docs/document/server-side/message_delete.md b/docs/document/server-side/message_delete.md index d06a38a5d..b96e92ad0 100644 --- a/docs/document/server-side/message_delete.md +++ b/docs/document/server-side/message_delete.md @@ -231,7 +231,7 @@ curl -X DELETE 'https://XXXX/XXXX/XXXX/rest/message/roaming/group/user/XXXX?grou - 清空单个用户当前时间及之前的所有漫游消息。 - 单向删除消息: - - 调用该接口后,该用户的漫游消息会从服务器和本地清空,该用户无法从服务端拉取到漫游消息,而且该用户的所有会话也会被清除,也拉不到会话列表。不过, + - 调用该接口后,该用户的漫游消息会从服务器和本地清空,该用户无法从服务端拉取到漫游消息,而且该用户的所有会话也会被清除,也拉不到会话列表。 - 会话中的其他用户不受影响,仍然可以拉取与该用户的漫游消息和会话。 **调用频率上限**:100 次/秒/App Key diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md index 22b6b4307..fa34a2b86 100644 --- a/docs/document/server-side/message_download.md +++ b/docs/document/server-side/message_download.md @@ -87,8 +87,8 @@ POST https://{host}/{org_name}/{app_name}/chatfiles | `Content-Type` | String | 是 | 内容类型: `multipart/form-data`。 | | `Authorization` | String | 否 | App 管理员的鉴权 token,格式为 `Bearer YourAppToken`,其中 `Bearer` 为固定字符,后面为英文空格和获取到的 app token。 | | `restrict-access` | Bool | 否 | 是否限制访问该文件:
- `true`:是。用户需要通过响应 body 中获取的文件访问密钥(`share-secret`)才能下载该文件。
- `false`:否。表示不限制访问。用户可以直接下载该文件。
要使用文件访问限制功能,请联系商务开通。| -| `thumbnail-height` | Int | 否 | 缩略图的高度,单位为像素。
- 若上传的原图或视频缩略图小于 10 KB,上传的图片即为缩略图。
- 若上传的图片超过 10 KB,缩略图的高度取决于该参数的设置。
- 若不传该参数,缩略图的高度默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 `服务概览` 页面的 `设置` 区域修改该默认值。 | -| `thumbnail-width` | Int | 否 | 缩略图的宽度,单位为像素。
- 若上传的原图或视频缩略图小于 10 KB,图片原图即为缩略图。
- 若上传的图片超过 10 KB,缩略图的宽度取决于该参数的设置。
- 若不传该参数,缩略图的宽度默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 `服务概览` 页面的 `设置` 区域修改该默认值。 | +| `thumbnail-height` | Int | 否 | 缩略图的高度,单位为像素。
- 若上传的原图或视频缩略图小于 10 KB,上传的图片即为缩略图。
- 若上传的图片超过 10 KB,缩略图的高度取决于该参数的设置。
- 若不传该参数,缩略图的高度默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **消息** 页面修改该默认值。 | +| `thumbnail-width` | Int | 否 | 缩略图的宽度,单位为像素。
- 若上传的原图或视频缩略图小于 10 KB,图片原图即为缩略图。
- 若上传的图片超过 10 KB,缩略图的宽度取决于该参数的设置。
- 若不传该参数,缩略图的宽度默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **消息** 页面修改该默认值。 | #### 请求 body diff --git a/docs/document/server-side/message_recall.md b/docs/document/server-side/message_recall.md index 89a3e3cb3..562025dc6 100644 --- a/docs/document/server-side/message_recall.md +++ b/docs/document/server-side/message_recall.md @@ -8,7 +8,7 @@ - 调用该 API 后,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会撤销。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 - 支持设置是否将单聊消息撤回同步给消息发送方的所有在线设备(`sync_device` 参数)。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在 [环信控制台](https://console.easemob.com/user/login)的**功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在 [环信控制台](https://console.easemob.com/user/login)的**功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 支持强制撤回消息,即撤回已过期的消息。 - 撤回消息会触发发送后回调,请参见 [回调事件文档](callback_message_recall.html)。 - 撤回消息前,需要通过调用 [获取历史消息记录 API](message_historical.html) 或 [消息回调](callback_overview.html) 获取要撤回的消息 ID。 @@ -165,10 +165,10 @@ curl -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json | 400 | message_recall_error | can’t find msg to | 未找到撤回消息的接收⽅。 | 需传入正确的消息接收方。 | | 403 | message_recall_error | exceed recall time limit | 消息撤回超时。 | 消息撤回时长默认为消息发送后的 2 分钟。 | | 403 | message_recall_error | not_found msg | 消息因过期在服务端删除或消息已被撤回。 | 若撤回过期的消息,你需要开启强制撤回,即将 `force` 设置为 `true`。这种情况下,会撤回接收方在本地保存的消息,但发送方本地消息仍存在。
若消息已被撤回,则无需重复撤回。 | -| 403 | forbidden_op | message recall service is unopened | 消息撤回服务未在环信即时通讯云管理后台开通。| 请先在环信即时通讯云管理后台开通该服务。 | +| 403 | forbidden_op | message recall service is unopened | 消息撤回服务未在环信控制台开通。| 请先在环信控制台开通该服务。 | | 500 | | internal error | 后端服务出现异常。 | | -例如,消息撤回服务未在环信即时通讯云管理后台开通,返回示例如下: +例如,消息撤回服务未在环信控制台开通,返回示例如下: ```json { diff --git a/docs/document/server-side/overview.md b/docs/document/server-side/overview.md index 73883037f..90c682b90 100644 --- a/docs/document/server-side/overview.md +++ b/docs/document/server-side/overview.md @@ -43,7 +43,7 @@ 环信不同数据中心的 REST API 请求域名 {host}: -应用所在数据中心可以在环信用户管理后台 > 应用列表找到对应的 App Key 点击 **管理** > **即时通讯** > **服务概览** 中查看: +应用所在数据中心可以在环信控制台的应用列表找到对应的 App Key,点击 **管理**,在 **应用概览** 中查看: ![img](/images/applet/service_overview.png) diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index 7c4947d85..b5f2b8e7c 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -4,10 +4,6 @@ 本文展示如何调用环信即时通讯 RESTful API 实现离线推送,包括设置离线推送通知显示的昵称、推送通知方式及免打扰模式。调用以下方法前,请先参考 [接口频率限制](limitationapi.html) 了解即时通讯 RESTful API 的调用频率限制。 -:::tip -若要使用离线推送的高级功能,即设置推送通知模式、免打扰模式和自定义推送模板,你需要在[环信即时通讯云控制后台](https://console.easemob.com/user/login)中点击你的应用后选择 **即时通讯** > **功能配置** > **功能配置总览** 开通离线推送高级功能。 -::: - ## 公共参数 以下表格列举了即时通讯 RESTful API 的公共请求参数和响应参数: @@ -854,24 +850,23 @@ curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ ## 使用推送模板 -你可以使用推送模板设置推送标题和内容,即调用以下 REST API 配置默认推送模板 `default` 和自定义推送模板。除此之外,你也可以在[环信控制台](https://console.easemob.com/user/login)设置推送模板,详见 [推送模板配置文档](/document/android/push/push_template.html)。 - -**对于群组消息,你可以使用定向模板向某些用户推送与其他用户不同的离线通知。** +你可以使用推送模板设置推送标题和内容,即调用以下 REST API 配置默认推送模板 **default**、**detail** 和自定义推送模板。除此之外,你也可以在 [环信控制台](https://console.easemob.com/user/login)设置推送模板,详见 [推送模板配置文档](/document/android/push/push_template.html)。 -使用推送模板有以下优势: - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式。 +推送模板的特点如下: +1. 推送模板的优先级高于 [调用 API 设置通知栏的推送内容](push_display_attribute.html)。 +2. 实现自定义修改环信服务端默认推送内容。 +3. 对于群组消息,你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 +4. 接收方可以决定使用哪个模板。 +5. 按优先级选择模板使用方式: + - 使用自定义推送模板的优先级高于默认推送模板。 + - 若发送方发消息时设置了推送模板,接收方即使设置了推送模板,收到推送通知后也按照发送方设置的推送模板显示。 **推送通知栏内容设置的使用优先级** 通知栏中显示的推送标题和内容可通过以下方式设置,优先级为由低到高: 1. 发送消息时使用默认的推送标题和内容:设置推送通知的展示方式 `notification_display_style`。推送标题为“您有一条新消息”,推送内容为“请点击查看”。 -2. 发送消息时使用默认模板:若有默认模板 `default`,发消息时无需指定。 +2. 发送消息时使用默认模板:若有默认模板 **default** 和 **detail**,发消息时无需指定。 3. 发送消息时使用扩展字段自定义要显示的推送标题和推送内容,即 `em_push_title` 和 `em_push_content`。 4. 接收方设置了推送模板。 5. 发送消息时通过消息扩展字段指定模板名称。 @@ -880,9 +875,9 @@ curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ #### 功能说明 -创建离线推送消息模板,包括默认模板 `default` 和自定模板。你可以通过 [环信控制台](https://console.easemob.com/user/login) 创建推送模板,详见 [推送模板配置文档](/document/android/push/push_template.html#开通服务)。 +创建离线推送消息模板,包括默认模板 **default**、**detail** 和自定义模板。你可以通过 [环信控制台](https://console.easemob.com/user/login) 创建推送模板,详见 [推送模板配置文档](/document/android/push/push_template.html#开通服务)。 -若使用默认模板 **default**,消息推送时自动使用默认模板,创建消息时无需传入模板名称。 +若使用默认模板 **default** 和 **detail**,消息推送时自动使用默认模板,创建消息时无需传入模板名称。 **调用频率上限**:10 次/秒/App Key diff --git a/docs/document/server-side/push_result_statistics.md b/docs/document/server-side/push_result_statistics.md index 20b7cb05f..47c325e70 100644 --- a/docs/document/server-side/push_result_statistics.md +++ b/docs/document/server-side/push_result_statistics.md @@ -7,7 +7,7 @@ 你可以通过以下方式查询离线推送的结果: - 在[环信控制台](https://console.easemob.com/user/login)上查看 IM 消息投递查询: - - 在 **应用列表** 中点击目标应用的 **操作** 栏中的 **管理** 按钮,进入 **应用详情** 页面。 + - 在 **应用列表** 中点击目标应用的 **操作** 栏中的 **管理** 按钮,进入 **应用概览** 页面。 - 选择 **即时通讯 > 实时查询 > IM消息投递查询**,查看推送结果记录,如下图所示: ![img](/images/server-side/message_delivery_query.png) diff --git a/docs/document/server-side/user_favorite.md b/docs/document/server-side/user_favorite.md index 841bdfc9f..886d95a59 100644 --- a/docs/document/server-side/user_favorite.md +++ b/docs/document/server-side/user_favorite.md @@ -1,6 +1,6 @@ # 用户收藏 -环信即时通讯云 IM 支持你收藏聊天过程中发送成功的各类消息或你的其他自定义内容。这些收藏的内容永久保存,你可以随时查看。例如,你若收藏指定的消息附件,可[将消息附件设置为永久存储](message_attachment_storage.html),然后再收藏,即可随时查看这些附件内容。 +环信即时通讯 IM IM 支持你收藏聊天过程中发送成功的各类消息或你的其他自定义内容。这些收藏的内容永久保存,你可以随时查看。例如,你若收藏指定的消息附件,可[将消息附件设置为永久存储](message_attachment_storage.html),然后再收藏,即可随时查看这些附件内容。 ## 公共参数 diff --git a/docs/document/unity/connection.md b/docs/document/unity/connection.md index 472132b54..2afa9b962 100644 --- a/docs/document/unity/connection.md +++ b/docs/document/unity/connection.md @@ -81,4 +81,4 @@ SDKClient.Instance.DeleteConnectionDelegate(connectionDelegate); - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file diff --git a/docs/document/unity/error.md b/docs/document/unity/error.md index e5a9aecb0..ff44a3c4a 100644 --- a/docs/document/unity/error.md +++ b/docs/document/unity/error.md @@ -39,7 +39,7 @@ SDKClient.Instance.Login(username, passwd, | 3 | DATABASE_ERROR | 数据库操作失败:打开本地数据库失败。 | 需要根据调用的 API 结合日志分析,如果使用 `Conversation#UpdateMessage` 方法更新一条本地不存在的消息,可能返回该错误;在数据库未打开时,调用其他本地数据库操作,也可能返回该错误。 | | 4 | EXCEED_SERVICE_LIMIT | 超过服务限制:超过当前服务版本的数量限制,例如,创建的用户 ID 数量超过购买服务的限制时提示该错误;设置和获取用户属性的接口,包括[设置当前用户的属性](userprofile.html#设置当前用户的属性)和[获取单个或多个用户的用户属性](userprofile.html#获取用户属性),超过调用频率限制时,会上报该错误。 | 检查调用的 API,若传入 `limit` 参数,可将该参数控制在上限内,若是限流导致,可以在延后一段时间重新调用。 | | 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限。 | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 | -| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | +| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | | 101 | INVALID_USER_NAME | 用户 ID 不正确:一般情况下,用户 ID 为空时提示该错误,例如,邀请好友时 username 参数为空字符。 | 检查报错 API 中传入的用户 ID 参数是否为空。 | | 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 | 检查调用的 API 中传的密码参数是否正确。 | | 103 | INVALID_URL | URL 不正确。 | 检查调用 API 时传入的参数是否正确。 | @@ -62,11 +62,11 @@ SDKClient.Instance.Login(username, passwd, | 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制:该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如,用户最多可同时登录 4 台设备, A(开启了自动登录)、B、C 和 D。最初,用户在这四个设备上均为登录状态,但由于网络连接原因登出了设备 A,然后手动登录了设备 E。这种情况下,设备 A 的网络恢复正常时会自动登录,这时登录失败且提示该错误。 | 可增加同时在线的设备数量,或先使用 `SDKClient#KickDevice` 踢掉其他设备再登录。 | | 215 | USER_MUTED | 用户在群组或聊天室中被禁言:用户被禁言后发送消息时提示该错误。 | 用户在群组/聊天室内被禁言情况下,不能发送消息,可在 UI 上限制。 | | 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 | 密码更新会收到回调`IConnectionDelegate#OnChangedIMPwd`,需要在收到该回调时,调用 `SDKClient#Logout` 方法,并回到登录页面。 | -| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`IConnectionDelegate#OnKickedByOtherDevice`。收到该回调时,需调用`SDKClient#Logout` 方法,并回到登录页面。 | +| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`IConnectionDelegate#OnKickedByOtherDevice`。收到该回调时,需调用`SDKClient#Logout` 方法,并回到登录页面。 | | 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录:用户在同一台设备上退出登录前又使用另一账户登录。 | 如果在已登录情况下,要登录另一个账号,需要先调用`SDKClient#Logout` 退出账号。 | | 219 | USER_MUTED_BY_ADMIN | 用户被禁言:用户在群组/聊天室开启全员禁言的情况下发送消息时提示该错误。 | 在群组/聊天室开启全员禁言的情况下,不能发送消息,可在 UI 上限制。 | | 220 | USER_DEVICE_CHANGED | 用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如,用户自动登录设备 A,之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。 | 登录失败的设备会收到 `IConnectionDelegate#OnLoggedOtherDevice` 事件。收到该事件时,需调用 `Client#Logout` 方法,并回到登录页面。 | -| 221 | USER_NOT_FRIEND | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 服务概览**页面的**设置**区域开启好友关系检查功能。 | 需要先调用 `ContactManager#AddContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | +| 221 | USER_NOT_FRIEND | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面开启好友关系检查功能。 | 需要先调用 `ContactManager#AddContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | | 300 | SERVER_NOT_REACHABLE | 服务器不可达:例如,发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时因网络不稳定导致失败,也会返回该错误。 | 调用登录 API 返回该错误码,可能是由于网络受限,或域名被封禁,可尝试切换设备网络。如果用户在沙特/菲律宾等地区,需要联系商务,开启 dnsconfig中 TLS 加密。其他操作返回该错误码,一般是网络问题,可在切换网络或延迟一段时间后重新调用。 | | 301 | SERVER_TIMEOUT | 请求服务超时:如果调用 API 在特定时间内服务器未响应则返回该错误,一般为 30 秒或 60 秒。 | 一般是网络问题,可在切换网络或延迟一段时间后重新调用 API。 | | 302 | SERVER_BUSY | 服务器忙碌:服务器当前忙碌会返回该错误,建议稍后再尝试请求。 | 检查调用的 API 是否重复调用。如果在上次调用后,结果未返回时重复调用 API,可能返回该错误码。 | diff --git a/docs/document/unity/login.md b/docs/document/unity/login.md index b6cc5a1f5..4ba53d3a3 100644 --- a/docs/document/unity/login.md +++ b/docs/document/unity/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/unity/message_recall.md b/docs/document/unity/message_recall.md index 0fe8299ea..8bd05c818 100644 --- a/docs/document/unity/message_recall.md +++ b/docs/document/unity/message_recall.md @@ -4,7 +4,7 @@ 发送方可以撤回一条发送成功的消息,包括已经发送的历史消息,离线消息或漫游消息。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/unity/message_receipt.md b/docs/document/unity/message_receipt.md index b2425c7c5..b38712723 100644 --- a/docs/document/unity/message_receipt.md +++ b/docs/document/unity/message_receipt.md @@ -195,7 +195,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate); | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/unity/multi_device.md b/docs/document/unity/multi_device.md index a33b97069..3a4c658d9 100644 --- a/docs/document/unity/multi_device.md +++ b/docs/document/unity/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -169,13 +169,13 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(adelegate); 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 -**设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 +**设备平台** 的取值范围为 [1,100],**设备数量** 的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -1. 初始化 SDK 时,利用 `Options#CustomOSType` 自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +1. 初始化 SDK 时,利用 `Options#CustomOSType` 自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/unity/overview.md b/docs/document/unity/overview.md index 5d6f3c098..31b9c951e 100644 --- a/docs/document/unity/overview.md +++ b/docs/document/unity/overview.md @@ -6,7 +6,7 @@ ## 前提条件 -开始前,请注册有效的环信即时通讯 IM 开发者账号和获取 App key,参见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +开始前,请注册有效的环信即时通讯 IM 开发者账号和获取 App key,参见 [环信控制台](https://console.easemob.com/user/login)。 ## 集成环境 @@ -61,7 +61,7 @@ SDKClient.Instance.InitWithOptions(options); ### SDK 注册 -若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册,需登录 [环信控制台](https://console.easemob.com/user/login),选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 ```csharp SDKClient.Instance.CreateAccount(username, password, diff --git a/docs/document/unity/quickstart.md b/docs/document/unity/quickstart.md index c5bb19a8f..66c0364ea 100644 --- a/docs/document/unity/quickstart.md +++ b/docs/document/unity/quickstart.md @@ -32,7 +32,7 @@ | macOS | macOS 10.0 或以上 | Xcode 9.0 或以上,Visual Studio for Mac 2019 或以上 | | Windows | Windows 10 或以上 | Microsoft Visual Studio 2019 或以上 | -- 有效的环信即时通讯 IM 开发者账号和 App Key,见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key,见 [环信控制台](https://console.easemob.com/user/login)。 - 如果你的网络环境部署了防火墙,请联系环信技术支持设置白名单。 ## 项目设置 diff --git a/docs/document/web/connection.md b/docs/document/web/connection.md index f144f20e4..3a07bedef 100644 --- a/docs/document/web/connection.md +++ b/docs/document/web/connection.md @@ -50,4 +50,4 @@ conn.addEventHandler("connectionListener", { - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 diff --git a/docs/document/web/error.md b/docs/document/web/error.md index d71a4488e..e0d2461dc 100644 --- a/docs/document/web/error.md +++ b/docs/document/web/error.md @@ -34,11 +34,11 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error` | 204 | USER_NOT_FOUND | 用户不存在,如创建群拉人时不存在的用户报错。 | 检查 userId 是否正确。| | 205 | MESSAGE_PARAMETER_ERROR | 消息参数错误。如撤回消息时未传消息 ID 或者发送消息时未传消息接收方的用户 ID。|确保消息⾥包含消息 ID 和接收方用户 ID,即 `id` 和 `to`。 | | 206 | WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录:如果没有开启多设备登录,则在其他设备登录会将当前登录的设备踢下线,用户会收到此错误。若开启了多设备登录并配置了支持的设备数量,设备间的互踢策略与 `ConnectionParameters#isFixedDeviceId` 参数有关,详见[多设备文档](multi_device.html)。 | 开启多设备功能,详见 [多设备⽂档](https://doc.easemob.com/document/web/multi_device.html)。 | -| 207 | WEBIM_CONNCTION_USER_REMOVED | 用户已经被注销:如果登录用户的 ID 被管理员从管理后台删除则会收到此错误。 | 提示⽤户被注销。| +| 207 | WEBIM_CONNCTION_USER_REMOVED | 用户已经被注销:如果登录用户的 ID 被管理员从环信控制台删除则会收到此错误。 | 提示⽤户被注销。| | 208 | WEBIM_USER_ALREADY_LOGIN | 已经登录,又重复登录。 | 不能重复登录。 | | 216 | WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 |提示密码已经修改,请重新登录。| -| 217 | WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备登录后,如果用户在其他设备上调用 API 或者通过管理后台踢出当前设备登录的 ID,SDK 会提示该错误。 | 提示被踢下线。| -| 219 | USER_MUTED_BY_ADMIN | 用户被全局禁言:在管理后台禁言了此用户后,该用户发送消息时会提示该错误。 | 提示⽤户已被禁⾔。| +| 217 | WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备登录后,如果用户在其他设备上调用 API 或者通过环信控制台踢出当前设备登录的 ID,SDK 会提示该错误。 | 提示被踢下线。| +| 219 | USER_MUTED_BY_ADMIN | 用户被全局禁言:在环信控制台禁言了此用户后,该用户发送消息时会提示该错误。 | 提示⽤户已被禁⾔。| | 221 | USER_NOT_FRIEND | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。该功能可在控制台开通。 | 提示⽤户⾮对⽅好友。| | 500 | SERVER_BUSY | 服务器忙碌。 | 提示服务忙,请重试。| | 501 | MESSAGE_INCLUDE_ILLEGAL_CONTENT | 消息含有非法内容:如果消息被过滤系统识别为非法消息时返回该错误。 | 提示消息发送失败,包含敏感词等⾮法内容。 | diff --git a/docs/document/web/login.md b/docs/document/web/login.md index 8a398bd67..60050bb36 100644 --- a/docs/document/web/login.md +++ b/docs/document/web/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信云控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/web/message_recall.md b/docs/document/web/message_recall.md index 492166a35..73f121550 100644 --- a/docs/document/web/message_recall.md +++ b/docs/document/web/message_recall.md @@ -7,7 +7,7 @@ - 对于单聊会话,只支持发送方撤回发送成功的消息。若消息过期,撤回失败。 - 对于群组/聊天室会话,普通群成员只能撤回自己发送的消息,若消息过期,撤回失败。群主/聊天室所有者和管理员可撤回其他用户发送的消息,即使消息过期也能撤回。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/web/message_receipt.md b/docs/document/web/message_receipt.md index 35a8eded8..7a107c689 100644 --- a/docs/document/web/message_receipt.md +++ b/docs/document/web/message_receipt.md @@ -129,7 +129,7 @@ conn.addEventHandler("customEvent", { | 使用限制 | 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。若使用前未开通,SDK 提示 503 "group ack not open" 错误。| +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。若使用前未开通,SDK 提示 503 "group ack not open" 错误。| | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改,此时普通成员发送消息要求已读回执时,SDK 会提示 "group ack msg permission denied" 错误。| | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天。你可以联系商务提上该上限。若已读回执的发送时间超过该限制,服务器不记录阅读该条消息的群组成员,也不会发送已读回执,SDK 会提示 "group ack msg not found" 错误。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/web/message_send.md b/docs/document/web/message_send.md index 1c507410e..b0dc0e55d 100644 --- a/docs/document/web/message_send.md +++ b/docs/document/web/message_send.md @@ -130,7 +130,7 @@ function sendPrivateAudio() { ### 发送图片消息 -对于图片消息,服务器会根据用户设置的 `thumbnailHeight` 和 `thumbnailWidth` 参数自动生成图片的缩略图。若这两个参数未传,则图片的高度和宽度均默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 `服务概览` 页面的 `设置` 区域修改该默认值。 +对于图片消息,服务器会根据用户设置的 `thumbnailHeight` 和 `thumbnailWidth` 参数自动生成图片的缩略图。若这两个参数未传,则图片的高度和宽度均默认为 170 像素。你也可以在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **消息** 页面修改该默认值。 创建和发送图片消息,示例代码如下所示: diff --git a/docs/document/web/multi_device.md b/docs/document/web/multi_device.md index 05f0ef99f..880007192 100644 --- a/docs/document/web/multi_device.md +++ b/docs/document/web/multi_device.md @@ -11,7 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -62,7 +62,7 @@ conn.getSelfIdsOnOtherPlatform().then((res) => { 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的 **功能配置 > 功能配置总览** 页面,点击 **基础功能** 页签,然后点击 **多端多设备在线** 对应的设置。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台** 的取值范围为 [1,100],**设备数量** 的取值范围为 [0,4]。 diff --git a/docs/document/windows/connection.md b/docs/document/windows/connection.md index 472132b54..2afa9b962 100644 --- a/docs/document/windows/connection.md +++ b/docs/document/windows/connection.md @@ -81,4 +81,4 @@ SDKClient.Instance.DeleteConnectionDelegate(connectionDelegate); - 用户在另一设备登录,将当前设备上登录的用户踢出,提示错误码 206。 - 用户登录设备数量超过限制,提示错误码 214。 - 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限,提示错误码 8。 -- 开启多设备服务后,用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file +- 开启多设备服务后,用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录(错误码 217)。 \ No newline at end of file diff --git a/docs/document/windows/error.md b/docs/document/windows/error.md index 84ecc2993..387dd2662 100644 --- a/docs/document/windows/error.md +++ b/docs/document/windows/error.md @@ -39,7 +39,7 @@ SDKClient.Instance.Login(username, passwd, | 3 | DATABASE_ERROR | 数据库操作失败:打开本地数据库失败。 | 需要根据调用的 API 结合日志分析,如果使用 `Conversation#UpdateMessage` 方法更新一条本地不存在的消息,可能返回该错误;在数据库未打开时,调用其他本地数据库操作,也可能返回该错误。 | | 4 | EXCEED_SERVICE_LIMIT | 超过服务限制:超过当前服务版本的数量限制,例如,创建的用户 ID 数量超过购买服务的限制时提示该错误;设置和获取用户属性的接口,包括[设置当前用户的属性](userprofile.html#设置当前用户的属性)和[获取单个或多个用户的用户属性](userprofile.html#获取用户属性),超过调用频率限制时,会上报该错误。 | 检查调用的 API,若传入 `limit` 参数,可将该参数控制在上限内,若是限流导致,可以在延后一段时间重新调用。 | | 8 | APP_ACTIVE_NUMBER_REACH_LIMITATION | 应用程序的日活跃用户数量(DAU)或月活跃用户数量(MAU)达到上限。 | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 | -| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | +| 100 | INVALID_APP_KEY | App Key 不合法:用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看 App Key。 | 使用正确的 App Key 进行初始化。 | | 101 | INVALID_USER_NAME | 用户 ID 不正确:一般情况下,用户 ID 为空时提示该错误,例如,邀请好友时 username 参数为空字符。 | 检查报错API 中传入的用户 ID 参数是否为空。 | | 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 | 检查调用的 API 中传的密码参数是否正确。 | | 103 | INVALID_URL | URL 不正确。 | 检查调用 API 时传入的参数是否正确。 | @@ -62,11 +62,11 @@ SDKClient.Instance.Login(username, passwd, | 214 | USER_LOGIN_TOO_MANY_DEVICES | 用户登录设备数超过限制:该错误在多设备自动登录场景中且打开不踢掉其他设备上的登录的开关时超过登录设备数量的限制才会出现。例如,用户最多可同时登录 4 台设备, A(开启了自动登录)、B、C 和 D。最初,用户在这四个设备上均为登录状态,但由于网络连接原因登出了设备 A,然后手动登录了设备 E。这种情况下,设备 A 的网络恢复正常时会自动登录,这时登录失败且提示该错误。 | 可增加同时在线的设备数量,或先使用 `SDKClient#KickDevice` 踢掉其他设备再登录。 | | 215 | USER_MUTED | 用户在群组或聊天室中被禁言:用户被禁言后发送消息时提示该错误。 | 用户在群组/聊天室内被禁言情况下,不能发送消息,可在 UI 上限制。 | | 216 | USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 | 密码更新会收到回调`IConnectionDelegate#OnChangedIMPwd`,需要在收到该回调时,调用 `SDKClient#Logout` 方法,并回到登录页面。 | -| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者管理后台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`IConnectionDelegate#OnKickedByOtherDevice`。收到该回调时,需调用`SDKClient#Logout` 方法,并回到登录页面。 | +| 217 | USER_KICKED_BY_OTHER_DEVICE | 用户被踢下线:开启多设备服务后,如果用户在其他设备上通过调用 API 或者环信控制台将当前设备登录的 ID 强制退出登录,SDK 会提示该错误。 | 被踢设备会收到回调`IConnectionDelegate#OnKickedByOtherDevice`。收到该回调时,需调用`SDKClient#Logout` 方法,并回到登录页面。 | | 218 | USER_ALREADY_LOGIN_ANOTHER | 其他用户已登录:用户在同一台设备上退出登录前又使用另一账户登录。 | 如果在已登录情况下,要登录另一个账号,需要先调用`SDKClient#Logout` 退出账号。 | | 219 | USER_MUTED_BY_ADMIN | 用户被禁言:用户被全局禁言后发送消息时提示该错误。 | 在群组/聊天室开启全员禁言的情况下,不能发送消息,可在 UI 上限制。 | | 220 | USER_DEVICE_CHANGED | 用户的登录设备与上次不一致。该错误在单设备自动登录场景中且打开不踢掉其他设备上的登录的开关时才会出现。例如,用户自动登录设备 A,之后手动登录设备 B。用户再次自动登录设备 A 时登录失败且提示该错误。 | 登录失败的设备会收到 `IConnectionDelegate#OnLoggedOtherDevice` 事件。收到该事件时,需调用 `Client#Logout` 方法,并回到登录页面。 | -| 221 | USER_NOT_FRIEND | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 服务概览**页面的**设置**区域开启好友关系检查功能。 | 需要先调用 `ContactManager#AddContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | +| 221 | USER_NOT_FRIEND | 非好友禁止发消息:开通非好友禁止发消息后,非好友间发消息提示此错误。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面开启好友关系检查功能。 | 需要先调用 `ContactManager#AddContact` 方法添加好友。对方同意好友请求后,才能发送消息。 | | 300 | SERVER_NOT_REACHABLE | 服务器不可达:例如,发送或撤回消息时,如果 SDK 与消息服务器未保持连接,会返回该错误;操作群组、好友等请求时因网络不稳定导致失败,也会返回该错误。 | 调用登录 API 返回该错误码,可能是由于网络受限,或域名被封禁,可尝试切换设备网络。如果用户在沙特/菲律宾等地区,需要联系商务,开启 dnsconfig中 TLS 加密。其他操作返回该错误码,一般是网络问题,可在切换网络或延迟一段时间后重新调用。 | | 301 | SERVER_TIMEOUT | 请求服务超时:如果调用 API 在特定时间内服务器未响应则返回该错误,一般为 30 秒或 60 秒。 | 一般是网络问题,可在切换网络或延迟一段时间后重新调用 API。 | | 302 | SERVER_BUSY | 服务器忙碌:服务器当前忙碌会返回该错误,建议稍后再尝试请求。 | 检查调用的 API 是否重复调用。如果在上次调用后,结果未返回时重复调用 API,可能返回该错误码。 | diff --git a/docs/document/windows/login.md b/docs/document/windows/login.md index 80741613b..2f291f8c1 100644 --- a/docs/document/windows/login.md +++ b/docs/document/windows/login.md @@ -6,9 +6,9 @@ 1. 可通过以下两种方式调用接口创建用户: -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能** > **用户** 页面,将 **用户注册模式** 设置为 **开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: diff --git a/docs/document/windows/message_recall.md b/docs/document/windows/message_recall.md index 0fe8299ea..8bd05c818 100644 --- a/docs/document/windows/message_recall.md +++ b/docs/document/windows/message_recall.md @@ -4,7 +4,7 @@ 发送方可以撤回一条发送成功的消息,包括已经发送的历史消息,离线消息或漫游消息。 - **除了透传消息,其他各类型的消息都支持撤回**。 -- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。 +- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息** 页面设置消息撤回时长,该时长不超过 7 天。 - 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。 - 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。 diff --git a/docs/document/windows/message_receipt.md b/docs/document/windows/message_receipt.md index cc2db401a..83a37fd6d 100644 --- a/docs/document/windows/message_receipt.md +++ b/docs/document/windows/message_receipt.md @@ -195,7 +195,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate); | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/document/windows/multi_device.md b/docs/document/windows/multi_device.md index 22fbab5e9..398f58b39 100644 --- a/docs/document/windows/multi_device.md +++ b/docs/document/windows/multi_device.md @@ -11,9 +11,7 @@ - 子区相关操作; - 会话相关操作。 -多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。 - -你可以在环信控制台的**功能配置** > **功能配置总览**页面的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量: +多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **功能配置 > 基础功能** > **用户** 页面,在弹出的对话框中设置各端设备的数量: ![img](/images/common/multidevice_device_count.png) @@ -171,13 +169,13 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(adelegate); 你可以按照以下步骤设置登录设备所属的平台: -1. 在环信控制台的**功能配置** > **功能配置总览**页面,点击**基础功能**页签,然后点击**多端多设备在线**对应的**设置**。在弹出的对话框中点击 **新增自定义平台**,在**添加自定义平台**对话框中设置**设备平台**和**设备数量**。 +1. 在环信控制台的 **功能配置** > **基础功能** > **用户** 页面,在**多端多设备** 区域,点击 **设置**。在弹出的对话框中点击 **新增自定义平台**,在 **添加自定义平台** 对话框中设置 **设备平台** 和 **设备数量**。 **设备平台**的取值范围为 [1,100],**设备数量**的取值范围为 [0,4]。 ![img](/images/common/multidevice_device_platform.png) -2. 初始化 SDK 时,调用 `Options#CustomOSType` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的**添加自定义平台**对话框中设置的**设备平台**的值相同。 +2. 初始化 SDK 时,调用 `Options#CustomOSType` 方法自定义设置登录设备的平台。确保该方法中的 `platform` 参数的值与环信控制台的 **添加自定义平台** 对话框中设置的 **设备平台** 的值相同。 :::tip 登录成功后才会将该设置发送到服务器。 diff --git a/docs/document/windows/overview.md b/docs/document/windows/overview.md index e8f9d465e..b2b8129ca 100644 --- a/docs/document/windows/overview.md +++ b/docs/document/windows/overview.md @@ -6,7 +6,7 @@ ## 前提条件 -开始前,请注册有效的环信即时通讯 IM 开发者账号和获取 App key,参见 [环信即时通讯云管理后台](https://console.easemob.com/user/login)。 +开始前,请注册有效的环信即时通讯 IM 开发者账号和获取 App key,参见 [环信控制台](https://console.easemob.com/user/login)。 ## 集成环境 @@ -61,7 +61,7 @@ SDKClient.Instance.InitWithOptions(options); ### SDK 注册 -若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册,需登录[环信控制台](https://console.easemob.com/user/login),选择 **功能配置 > 基础功能** > **用户**,将 **用户注册模式** 设置为 **开放注册**。 ```csharp SDKClient.Instance.CreateAccount(username, password, diff --git a/docs/product/aigc/aigc_rest_api.md b/docs/product/aigc/aigc_rest_api.md index 3df99684f..15684eb19 100644 --- a/docs/product/aigc/aigc_rest_api.md +++ b/docs/product/aigc/aigc_rest_api.md @@ -1,6 +1,6 @@ # AI 智能 -环信即时通讯云提供 REST API 获取 app 下的机器人列表。**如果需要该功能相关的其他 REST API,请联系环信商务。** +环信即时通讯 IM 提供 REST API 获取 app 下的机器人列表。**如果需要该功能相关的其他 REST API,请联系环信商务。** ## 前提条件 @@ -63,7 +63,7 @@ GET https://{host}/{org_name}/{app_name}/robot/rule?&page={page}&size={size} | `entities` | JSONArray | app 下的机器人详情。 | | - `id` | String | 机器人 ID。 | | - `name` | String | 机器人名称。 | -| - `appkey` | String | 应用的唯一标识,由 `Orgname` 和 `Appname` 组成,生成后不允许修改。在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 | +| - `appkey` | String | 应用的唯一标识,由 `Orgname` 和 `Appname` 组成,生成后不允许修改。在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看。 | | - `robotId` | String | robot ID。 | | - `robotAppId` | String | robot ID 对应的 robot app ID。 | | - `msgType` | String | 消息类型,目前固定值为 `txt`,即文本消息。 | diff --git a/docs/product/aigc/aigc_run_through_demo_server.md b/docs/product/aigc/aigc_run_through_demo_server.md index 8f9161aa4..5608b863c 100644 --- a/docs/product/aigc/aigc_run_through_demo_server.md +++ b/docs/product/aigc/aigc_run_through_demo_server.md @@ -41,7 +41,7 @@ src/main/resources/application.yml #### 2. 获取 app 信息 -选中创建的应用,点击**管理**,进入**应用详情**页面,获取 **App Key**、**ClientID** 及**ClientSecret**。 +选中创建的应用,点击**管理**,进入**应用概览**页面,获取 **App Key**、**ClientID** 及**ClientSecret**。 ```yaml logging: @@ -50,9 +50,9 @@ logging: server: port: 80 #修改启动端口,只能为数字(请确保该端口没有被占用) easemob: - appkey: {appkey} # 创建应用获取到的 App Key,可通过环信控制台的 “应用详情” 页面上的 “APPKEY” 字段获取。 - clientId:{clientId} # App 的 client_id,可通过环信控制台的 “应用详情” 页面上的 “Client ID” 字段获取。 - clientSecret:{clientSecret} # App 的 client_secret,可通过环信控制台的 “应用详情” 页面上的 “ClientSecret” 字段获取。 + appkey: {appkey} # 创建应用获取到的 App Key,可通过环信控制台的 “应用概览” 页面上的 “APPKEY” 字段获取。 + clientId:{clientId} # App 的 client_id,可通过环信控制台的 “应用概览” 页面上的 “Client ID” 字段获取。 + clientSecret:{clientSecret} # App 的 client_secret,可通过环信控制台的 “应用概览” 页面上的 “ClientSecret” 字段获取。 ``` ![img](/images/aigc/app_detail.png) diff --git a/docs/product/aigc/aigc_selection.md b/docs/product/aigc/aigc_selection.md index 64f4e7a53..4fee231bb 100644 --- a/docs/product/aigc/aigc_selection.md +++ b/docs/product/aigc/aigc_selection.md @@ -3,7 +3,7 @@ 本文提供两种方案供你接入环信 AI 聊天服务,实现与机器人的聊天功能: - **方案一**:利用服务器回调服务,在 IM 中引入 AI 服务。 -- **方案二**:使用环信即时通讯云提供的 AI 智能功能。 +- **方案二**:使用环信即时通讯 IM 提供的 AI 智能功能。 ## 方案一 diff --git a/docs/product/data_center.md b/docs/product/data_center.md index f2491936b..03138fe0a 100644 --- a/docs/product/data_center.md +++ b/docs/product/data_center.md @@ -27,7 +27,7 @@ ![img](/images/product/data_center_selection.png) -应用所在数据中心可以在环信控制台的 **即时通讯>服务概览** 页面中查看: +应用所在数据中心可以在环信控制台的 **应用概览** 页面中查看: ![img](/images/product/data_center.png) diff --git a/docs/product/easemob_app_token.md b/docs/product/easemob_app_token.md index 2418dfea4..42cb7c7d5 100644 --- a/docs/product/easemob_app_token.md +++ b/docs/product/easemob_app_token.md @@ -40,8 +40,8 @@ POST https://{host}/{org_name}/{app_name}/token | 参数 | 类型 | 是否必需 | 描述 | | :-------------- | :----- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `grant_type` | String | 是 | 授权方式。该参数设置为固定字符串 `client_credentials`,即客户端凭证模式。 | -| `client_id` | String | 是 | App 的 `client_id`,用于生成 app token 调用 REST API。详见 [环信控制台](https://console.easemob.com/user/login/)的`应用详情`页面。 | -| `client_secret` | String | 是 | App 的 `client_secret`,用于生成 app token 调用 REST API。详见 [环信控制台](https://console.easemob.com/user/login/)的`应用详情`页面。 | +| `client_id` | String | 是 | App 的 `client_id`,用于生成 app token 调用 REST API。详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面。 | +| `client_secret` | String | 是 | App 的 `client_secret`,用于生成 app token 调用 REST API。详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面。 | | `ttl` | Long | 否 | token 有效期,单位为秒。
- 若传入该参数,token 有效期以传入的值为准。
- 若不传该参数,以 [环信控制台](https://console.easemob.com/user/login/)的 **用户管理** 页面的 token 有效期的设置为准。
- 若设置为 `0`,则 token 永久有效。
注意:VIP 5 集群该参数单位为毫秒。| ### HTTP 响应 @@ -87,8 +87,8 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' - | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 | | :---------- | :-------- | :-------------- | :------------ | :----| -| 400 | illegal_argument | client_id must be provided. | 请求 body 中没有传 `client_id`。| 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用详情** 页面中 app key 对应的 **Client ID** 参数。 | -| 400 | illegal_argument | client_secret must be provided | 请求 body 中没有传 `client_secret`。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用详情** 页面中 app key 对应的 **ClientSecret** 参数。 | -| 400 | invalid_grant | client_id does not match | app key 对应的 `client_id` 与请求 body 中传入的 `client_id` 不匹配。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用详情** 页面中 app key 对应的 **Client ID** 参数,确保请求 body 中传入的与该参数一致。 | -| 400 | invalid_grant | client_secret does not match | app key 对应的 `client_secret` 与请求 body 中传入的 `client_secret` 不匹配。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用详情** 页面中 app key 对应的 **ClientSecret** 参数,确保请求 body 中传入的与该参数一致。 | +| 400 | illegal_argument | client_id must be provided. | 请求 body 中没有传 `client_id`。| 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面中 app key 对应的 **Client ID** 参数。 | +| 400 | illegal_argument | client_secret must be provided | 请求 body 中没有传 `client_secret`。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面中 app key 对应的 **Client Secret** 参数。 | +| 400 | invalid_grant | client_id does not match | app key 对应的 `client_id` 与请求 body 中传入的 `client_id` 不匹配。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面中 app key 对应的 **Client ID** 参数,确保请求 body 中传入的与该参数一致。 | +| 400 | invalid_grant | client_secret does not match | app key 对应的 `client_secret` 与请求 body 中传入的 `client_secret` 不匹配。 | 详见 [环信控制台](https://console.easemob.com/user/login/)的 **应用概览** 页面中 app key 对应的 **Client Secret** 参数,确保请求 body 中传入的与该参数一致。 | | 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](/product/console/app_create.html)。 | diff --git a/docs/product/enable_and_configure_IM.md b/docs/product/enable_and_configure_IM.md index 1a86c279f..e69e81ee1 100644 --- a/docs/product/enable_and_configure_IM.md +++ b/docs/product/enable_and_configure_IM.md @@ -28,7 +28,7 @@ ## 购买服务 -1. 创建应用后,在 **应用列表** 中点击所创建应用的 **操作** 栏中的 **管理** 按钮,进入 **应用详情** 页面。 +1. 创建应用后,在 **应用列表** 中点击所创建应用的 **操作** 栏中的 **管理** 按钮,进入 **应用概览** 页面。 ![img](/images/product/app-setting.png) @@ -74,9 +74,9 @@ | 应用信息 | 描述 | 如何查看 | | :--------- | :----- | :------- | -| `Orgname` | 环信即时通讯 IM 为每个公司(组织)分配的唯一标识。该参数是 `APPKEY` 的一部分。 | 在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 | -| `Appname` | 你在[环信控制台](https://console.easemob.com/user/login)创建应用时填入的应用名称。该参数是 `AppKey` 的一部分。| 在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 | -| `APPKEY` | 应用的唯一标识,由 `Orgname` 和 `Appname` 组成,生成后不允许修改。 | 在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 | +| `Orgname` | 环信即时通讯 IM 为每个公司(组织)分配的唯一标识。该参数是 `APPKEY` 的一部分。 | 在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看。 | +| `Appname` | 你在[环信控制台](https://console.easemob.com/user/login)创建应用时填入的应用名称。该参数是 `AppKey` 的一部分。| 在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看。 | +| `APPKEY` | 应用的唯一标识,由 `Orgname` 和 `Appname` 组成,生成后不允许修改。 | 在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看。 | | 服务器域名(`host`) | RESTful API 请求域名。环信为应用提供的 REST API 和 WebSocket 的请求域名。 | 在[环信控制台](https://console.easemob.com/user/login)的 **服务概览** 页面查看。 | | 数据中心 | 环信 IM 提供的分布在全球的多个数据中心:
- 国内数据中心:北京 1 区和北京 Vip6 区
- 海外数据中心:新加坡 1 区、 法兰克福(法国)和弗吉尼亚(美国) | 在[环信控制台](https://console.easemob.com/user/login)的 **服务概览** 页面查看。 | @@ -95,7 +95,7 @@ ## 设置消息撤回(REST & 客户端) -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到消息撤回(REST&客户端),单击右侧的 **设置**(已开通状态下)。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到消息撤回(REST&客户端),单击右侧的 **设置**(已开通状态下)。 2. 在弹出的 **消息撤回时间设置** 对话框中,设置消息可撤回时长。端消息撤回时长和 REST 消息撤回时长均不能超过 7 天。 3. 单击 **确定** 保存配置。 @@ -105,7 +105,7 @@ 群聊消息的已读回执使用前,需要开通该功能。 -在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到**消息已读回执(群聊)**开通功能。 +在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到**消息已读回执(群聊)**开通功能。 ![img](/images/product/message/message_receipt.png) @@ -113,7 +113,7 @@ 通过 RESTful 接口发送的消息默认不写入会话列表,若需要此类消息写入会话列表,需要开通。 -在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到**rest发消息写会话列表**,然后点击**设置**。 +在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签下,搜索找到**rest发消息写会话列表**,然后点击**设置**。 ![img](/images/product/enable_and_configure/message_rest_conversation.png) @@ -311,7 +311,7 @@ 1. 开通消息举报功能。 -在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到 **消息举报**,进行开通。 +在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到 **消息举报**,进行开通。 对于专业版,消息举报为增值服务,你需要点击 **增值服务** 单独付费开通,如下图所示。 @@ -329,7 +329,7 @@ ## 敏感词设置 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到敏感词,单击右侧的 **设置**(已开通状态下),打开敏感词配置页面。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到敏感词,单击右侧的 **设置**(已开通状态下),打开敏感词配置页面。 2. 在敏感词配置页面,单击 **服务设置** 旁边的 **编辑**,在弹出的 **敏感词服务** 对话框中,按需求选择对应设置。 3. 单击 **确定** 保存配置。 @@ -339,7 +339,7 @@ ### 添加 IP 白名单 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到 **REST-IP 白名单**,单击右侧的 **设置**(已开通状态下),打开**安全配置**页面。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **功能配置总览**。在 **功能配置总览** 页面的 **基础功能** 页签中搜索找到 **REST-IP 白名单**,单击右侧的 **设置**(已开通状态下),打开**安全配置**页面。 2. 在 **安全配置** 页面,单击 **添加IP**,在弹出的 **添加 IP** 对话框中,输入 IP 地址。 :::tip 1. 每次只能输入 1 个 IP 地址,最多可添加 8 个。 @@ -354,7 +354,7 @@ 如果你不再允许某个 IP 地址继续发送 REST 消息,可以在 IP 白名单中将其删除。如果你删除了 IP 白名单中所有 IP,即白名单列表为空,则默认所有 IP 地址均可发送 REST 消息。 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **功能配置** > **安全配置**。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **功能配置** > **安全配置**。 2. 在 **IP白名单** 列表中,单击目标 IP 右侧的 **删除**。 @@ -366,14 +366,14 @@ 环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要按以下步骤开启好友关系检查。 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **服务概览**。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯** > **服务概览**。 2. 在 **设置** 区域,点击 **好友关系检查**对应的 **打开**,则该功能的状态为**已开启**。若关闭该功能,点击 **关闭**。 该功能开启后,SDK 会在用户发起单聊时检查好友关系,若用户向陌生人发送单聊消息,SDK 会提示错误码 221。 ## 创建 IM 用户 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯 > 运营服务 > 用户管理**。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯 > 运营服务 > 用户管理**。 2. 在 **用户管理** 页面,点击 **创建IM用户** 按钮,在弹出的对话框中填写用户 ID、推送昵称和密码,然后点击 **保存**。 @@ -387,7 +387,7 @@ ## 创建群组 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯 > 运营服务 > 群组管理**。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯 > 运营服务 > 群组管理**。 2. 在 **群组管理** 页面,点击 **创建群组**,在弹出的对话框中设置群组名称、描述、群主、最大人数、群组类型、申请入群方式、邀请方式和被邀请用户是否需要确认,然后点击 **创建**。 @@ -403,7 +403,7 @@ ## 创建聊天室 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯 > 运营服务 > 聊天室管理**。 +1. 在环信即时通讯 IM 的左侧导航栏中,选择 **即时通讯 > 运营服务 > 聊天室管理**。 2. 在 **聊天室管理** 页面,点击 **创建聊天室**,在弹出的对话框中设置聊天室名称、描述、超级管理员和普通管理员的用户 ID 以及最大成员数,然后点击 **保存**。 diff --git a/docs/product/faq_quality_issues.md b/docs/product/faq_quality_issues.md index 2f641a24e..afc585a10 100644 --- a/docs/product/faq_quality_issues.md +++ b/docs/product/faq_quality_issues.md @@ -70,11 +70,14 @@ 2.若排除以上情况,可根据 App Key、发送者 ID 或消息 ID、消息发送时间在 [环信控制台](https://console.easemob.com/user/login) 自行查询消息投递状态,具体操作如下: -1. 登录环信控制台。 -2. 在首页的 应用列表 区域中,点击具体应用的 **操作** 栏中的 **管理**。 -3. 在界面左侧导航栏中选择**应用详情**下的**即时通讯** > **实时查询** > **IM消息投递查询**。 +a. 登录 [环信控制台](https://console.easemob.com/user/login)。 +b. 选择页面上方的 **应用管理**。在弹出的应用列表页面,单击你的应用的 **操作** 栏中的 **管理**。 +c. 在左侧导航栏,选择 **运营管理 > 问题排查 > IM用户投递查询**。 +d. 设置查询参数,点击 **查询**。 -![img](/images/product/faq-msgdeliveryquery.png) +下图为查询 app 管理员调用 REST API 在两个群组中发送的文本消息。 + +![img](/images/console/operation_troubleshooting_message_delivery.png) ## 参考 @@ -82,12 +85,14 @@ 在使用环信即时通讯 IM 基础聊天业务的场景下,处理特定业务需求时需知晓某些用户是否在线。为此,环信即时通讯 IM 提供单个用户以及批量用户是否在线状态的查询,详见 [用户在线状态回调](/document/server-side/callback_login_logout.html)。 -除此之外,可以在 [环信控制台](https://console.easemob.com/user/login) 上查询用户连接状态,具体操作如下: +除此之外,可以在 [环信控制台](https://console.easemob.com/user/login) 上查询单个用户在最近三天内的设备连接状态。,具体操作如下: -1. 登录环信控制台。 -2. 在首页的 **应用列表** 区域中,点击具体应用的 **操作** 栏中的 **管理**。 -3. 在界面左侧导航栏中选择 **应用详情** 下的 **即时通讯** > **实时查询** > **IM用户连接状态**。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面,单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏,选择 **运营管理 > 问题排查 > 用户连接状态查询**。 +4. 输入用户 ID,设置查询时间,点击 **查询**。 +5. 在 **用户状态历史** 栏中查看用户的设备连接状态。 -![img](/images/product/faq-userconnectionstatus.png) +![img](/images/console/operation_troubleshooting_user_connection.png) 说明: 环信即时通讯 IM SDK 未提供直接查询用户是否在线的方法,客户端可以封装查询用户是否在线的接口调用或者让自己服务器端来调用再与自己客户端交互。 \ No newline at end of file diff --git a/docs/product/limitation.md b/docs/product/limitation.md index 3ba1cf542..83067510e 100644 --- a/docs/product/limitation.md +++ b/docs/product/limitation.md @@ -40,7 +40,7 @@ ### 消息撤回 -默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的**功能配置** > **功能配置总览** > **基础功能**页面设置消息撤回时长,该时长不超过 7 天。 +默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)的**功能配置** > **基础功能** > **消息**页面设置消息撤回时长,该时长不超过 7 天。 :::tip 除了透传消息,其他各类型的消息都支持撤回。 @@ -55,7 +55,7 @@ | 使用限制| 默认 | 描述 | | :--------- | :----- | :------- | -| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | +| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置** > **基础功能** > **消息**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 | | 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 | | 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 | | 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 | diff --git a/docs/product/message_single_chat.md b/docs/product/message_single_chat.md index 466108e39..ca5c2a5a3 100644 --- a/docs/product/message_single_chat.md +++ b/docs/product/message_single_chat.md @@ -27,9 +27,9 @@ | 单聊消息发送控制 | 描述 | | :--------- | :----- | -| 陌生人之间发送消息 | App 内任意两个用户之间均可发送单聊消息。该场景下,在环信控制台的 **即时通讯 > 服务概览** 页面的 **设置** 区域下关闭了 **好友关系检查** 功能。 | +| 陌生人之间发送消息 | App 内任意两个用户之间均可发送单聊消息。该场景下,在环信控制台的 **功能配置 > 基础功能** > **用户** 页面关闭了 **好友关系检查** 功能。 | | App 管理员发送单聊消息 | App 管理员模拟其他用户向 app 内任意用户发送消息。 | -| 只给好友发送消息 | 只能给好友发送消息,即在环信控制台的 **即时通讯 > 服务概览** 页面的 **设置** 区域下打开 **好友关系检查** 功能。 | +| 只给好友发送消息 | 只能给好友发送消息,即在环信控制台的 **功能配置 > 基础功能** > **用户** 页面打开 **好友关系检查** 功能。 | | 拒绝来自某用户的消息 | 可通过以下两种方法拒绝来自某个用户的消息:
- **将用户添加到黑名单**,拒绝来自该用户的消息。
- **将该用户从联系人列表移除。** 这种情况适用于 app 仅支持好友之间发送消息的情况。如果 app 支持陌生人之间发送消息,例如,用户 A 从用户 B 的联系人列表移除,用户 A 仍然可以向用户 B 发送消息吧。
- **全局禁言 (RESTful API)**:可通过对单个用户进行单聊全局禁言,使指定用户无法向 app 内的任何用户发送单聊消息。| |对消息放行或拦截|- **发送前回调**:环信 IM 服务器会在发送消息之前,向你的应用服务器发送请求,你可以根据业务需求配置规则决定下发或拦截消息。
- **内容审核**:基于内容审核结果对消息进行处理,包括拦截、替换敏感信息和放行消息。该服务只对文本、图片、音频和视频消息有效。 | diff --git a/docs/product/moderation/moderation_keyword.md b/docs/product/moderation/moderation_keyword.md index 0d365805e..053e1fc18 100644 --- a/docs/product/moderation/moderation_keyword.md +++ b/docs/product/moderation/moderation_keyword.md @@ -21,7 +21,7 @@ 2. 选择页面上方的 **应用管理**。在弹出的应用列表页面,单击你的应用的 **操作** 栏中的 **管理**。 3. 在左侧导航栏,选择 **功能配置 > 增值服务 > 内容审核 > 文本审核 > 关键词名单**。 - 关键词名单包含白名单和黑名单,即 **命中处置** 参数为 **通过** 时为白名单,设置为 **拦截** 和 `替换为 ***` 时为黑名单。每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 100,000 个词条。添加的关键词在 1 分钟后生效。 + 关键词名单包含白名单和黑名单,即 **命中处置** 参数为 **通过** 时为白名单,设置为 **拦截** 和 `替换为 ***` 时为黑名单。每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词,即每个应用最多可配置 1,000,000 个词条。添加的关键词在 1 分钟后生效。 4. 在 **黑/白名单管理** 页面,单击 **创建黑/白名单**,配置名单参数。 diff --git a/docs/product/moderation/moderation_record_callback.md b/docs/product/moderation/moderation_record_callback.md index 554dc3e42..267434702 100644 --- a/docs/product/moderation/moderation_record_callback.md +++ b/docs/product/moderation/moderation_record_callback.md @@ -5,7 +5,7 @@ 审核记录支持回调,具体操作步骤如下: 1. 登录 [环信控制台](https://console.easemob.com/user/login)。 -2. 选择页面上方的 **应用管理**。在弹出的应用列表页面,单击你的应用的 **操作** 栏中的 **管理**。 +2. 选择 **应用管理**。在弹出的应用列表页面,单击你的应用的 **操作** 栏中的 **管理**。 ![img](/images/console/app_mgmt_list.png) @@ -52,7 +52,7 @@ | callId | String| 回调的标识。格式为 {appkey}_{uuid},其中 UUID 为随机生成,作为每条回调的唯一标识。| | moderationResult | String | 消息处理结果:
- `PASS`:通过,直接下发消息;
- `REJECT`:拒绝下发;
- `EXCHANGE`:替换消息中的违规内容;
- `RECALL`:撤回发送的音频和视频。 | | providerResult | String | 审核结果:
- `PASS`:消息中不包含违规内容;
- `REVIEWED`:消息中疑似包含违规内容;
- `REJECT`:消息存在违规内容。| -| security | String | 签名,格式如下: MD5(callId+Secret+timestamp),其中 Secret 详见[环信 IM 管理后台](https://console.easemob.com/user/login)的回调规则。 | +| security | String | 签名,格式如下: MD5(callId+Secret+timestamp),其中 Secret 详见[环信控制台](https://console.easemob.com/user/login)的回调规则。 | | messageType | String | 消息类型:
- `txt`:文本消息;
- `img`:图片消息;
- `audio`:语音消息;
- `video`:视频消息;
- `custom`:自定义消息。 | | messageId | String | 消息 ID。 | | targetType | String | 会话类型。
- `chat`:单聊;
- `groupchat`:群聊;
- `chatroom`:聊天室。 | diff --git a/docs/product/pricing.md b/docs/product/pricing.md index 732e77426..decb108f8 100644 --- a/docs/product/pricing.md +++ b/docs/product/pricing.md @@ -86,7 +86,7 @@ 以下为计费示例: -某用户订阅的即时通讯的套餐包为专业版,应用的当月最高 DAU 为 15,000,峰值群组和聊天室数为 110,000 个(免费额度为 100,000), 当月即时通讯服务费用为 1299 + 1000 + 100 = 2399 元。 +某用户订阅的即时通讯的套餐包为专业版,应用的当月最高 DAU 为 15,000,峰值群组和聊天室数为 100,000 个(免费额度为 100,000), 当月即时通讯服务费用为 1299 + 1000 + 100 = 2399 元。 ### 增值服务费用 diff --git a/docs/product/pricing_method.md b/docs/product/pricing_method.md index 97698ee62..ffab4a759 100644 --- a/docs/product/pricing_method.md +++ b/docs/product/pricing_method.md @@ -10,10 +10,10 @@ 你可以参考如下步骤订阅即时通讯套餐包: -1. 登录[环信控制台](https://console.easemob.com/user/login),在 **应用列表** 区域,选择你的应用,点击 **操作** 栏中的 **管理** 链接。 -2. 在左侧导航栏,选择 **即时通讯** > **功能配置** > **版本开通**。 +1. 登录[环信控制台](https://console.easemob.com/user/login),在 **应用管理** 页面,选择你的 应用,点击 **操作** 栏中的 **管理** 链接。 +2. 在左侧导航栏,选择 **服务开通** > **套餐购买**。 3. 选择套餐包,点击 **立即开通**。 -4. 进入 **即时通讯IM 服务版本** 页面,查看套餐包的功能详情,选择 **我已阅读并同意《环信云服务购买协议》**,然后点击 **提交订单** 完成支付。 +4. 进入 **开通服务版本** 页面,查看套餐包的功能详情,然后点击 **下一步** 完成支付。 ### 升级套餐包 @@ -23,15 +23,16 @@ **方法一** -1. 登录[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **服务概览**,点击 **服务版本** 区域的 **当前版本** 对应的 **升级版本**,进入**即时通讯IM 服务版本** 页面。 - -2. 查看各套餐包的功能详情,根据业务需要选择套餐包,选择 **我已阅读并同意《环信云服务购买协议》**,点击 **提交订单**,完成支付。 +1. 登录[环信控制台](https://console.easemob.com/user/login),在 **应用管理** 页面,选择你的应用,点击 **操作** 栏中的 **管理** 链接。 +2. 在 **应用概览** 页面,在 **服务开通信息** 区域中点击 **调整套餐** +3. 查看各套餐包的功能详情,根据业务需要选择套餐包,点击 **下一步**,完成支付。 **方法二** -1. 在[环信控制台](https://console.easemob.com/user/login),选择 **即时通讯** > **功能配置** > **功能配置总览**。 -2. 点击对应功能的 **操作** 一栏的 **升级**,进入**即时通讯IM 服务版本** 页面。 -3. 查看各套餐包的功能详情,根据业务需要选择套餐包,选择 **我已阅读并同意《环信云服务购买协议》**,点击 **提交订单**,完成支付。 +1. 登录[环信控制台](https://console.easemob.com/user/login),在 **应用管理** 页面,选择你的 应用,点击 **操作** 栏中的 **管理** 链接。 +2. 在左侧导航栏,选择 **服务开通** > **套餐购买**。 +3. 选择套餐包,点击 **立即开通**。 +4. 进入 **开通服务版本** 页面,查看套餐包的功能详情,然后点击 **下一步** 完成支付。 :::tip 1. 原版本下订阅的所有增值服务会同时取消订阅并退还剩余费用。若你仍需要增值服务,请重新订阅。 @@ -49,15 +50,11 @@ **方法一** -[订阅套餐包](#订阅套餐包)时,你可以在 **即时通讯IM 服务版本** 页面下的相应套餐标签页的 **可选增值服务** 区域选择所需增值服务进行订阅。 +[订阅套餐包](#订阅套餐包)时,你可以在 **开通服务版本** 页面的 **单独购买增值服务** 页签中选择所需增值服务进行订阅。 **方法二** 参考以下步骤订阅增值服务: -1. 选择 **即时通讯** > **功能配置** > **功能配置总览**,选择要开通的服务,点击 **操作栏** 中的 **增值服务** 链接。 - -2. 进入 **即时通讯IM 服务版本**页面下的 **单独购买增值服务** 标签页,选择增值服务对应的 **付费开通** 按钮或所需服务项目,确定购买时长,然后选择 **我已阅读并同意《环信云服务购买协议》**。 - -3. 点击 **提交订单**,完成支付。 - +1. 在左侧导航栏,选择 **服务开通** > **增值服务**。 +2. 在右侧的增值服务页面中分别订阅和开通内容审核、即时推送、消息翻译、服务端 API 调用和实时音视频服务。 diff --git a/docs/product/pricing_policy.md b/docs/product/pricing_policy.md index 2f0923df7..2d9719a61 100644 --- a/docs/product/pricing_policy.md +++ b/docs/product/pricing_policy.md @@ -86,7 +86,7 @@ 以下为计费示例: -某用户订阅的即时通讯的套餐包为专业版,应用的当月最高 DAU 为 15,000,峰值群组和聊天室数为 110,000 个(免费额度为 100,000), 当月即时通讯服务费用为 1299 + 1000 + 100 = 2399 元。 +某用户订阅的即时通讯的套餐包为专业版,应用的当月最高 DAU 为 15,000,峰值群组和聊天室数为 100,000 个(免费额度为 100,000), 当月即时通讯服务费用为 1299 + 1000 + 100 = 2399 元。 ### 增值服务费用 diff --git a/docs/product/product_function.md b/docs/product/product_function.md index 5ff96d869..2ec8fa5d2 100644 --- a/docs/product/product_function.md +++ b/docs/product/product_function.md @@ -43,7 +43,7 @@ | 单平台登录 | Android、iPhone、iPad、HarmonyOS、Windows、Mac、Web 仅可有1种平台在线。 | | 多平台登录 | 每端默认最多支持 4 个设备同时在线。 | -使用多端登录前,你需要在[环信控制台](https://console.easemob.com/user/login)的 **即时通讯** > **功能配置** > **功能配置总览** > **基础功能** 页面上查找 **多端多设备在线**,开启该功能。此外,可以在 **基础功能**页签下点击 **多端多设备在线** 操作栏中的 **设置**,在弹出的对话框中设置各端设备的数量。 +使用多端登录前,你需要在 [环信控制台](https://console.easemob.com/user/login) 的 **功能配置** > **基础功能** > **用户** 页面上查找 **多端多设备**,开启该功能。开通该功能后,点击 **设置**,在弹出的对话框中设置各端设备的数量。 ## 消息类型 @@ -70,7 +70,7 @@ | :------------- | :---------------------- | | 发送和接收消息 | 发送和接收各类消息,包括文本、图片、音频、视频、文件消息、位置消息、命令消息、自定义消息以及合并消息。 | | 本地存储 | 接收的消息存储在本地。 | -| 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关,详见[产品价格](https://www.easemob.com/pricing/im)。 | +| 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关,详见 [产品价格](https://www.easemob.com/pricing/im)。 | | 离线消息推送 |
- 用户离线时,可向消息接收方发送推送通知。
- 支持离线消息存储,默认为 7 天。 | | 多端同步 | 多端多设备消息同步,同时收到消息。 | | 本地搜索 | 按照关键字搜索本地会话中的各类消息。 | @@ -112,7 +112,7 @@ ## 用户关系 -环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 +环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要在 [环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 | 功能 | 描述 | | :-------------- | :----- | @@ -163,16 +163,16 @@ ## 环信控制台 -你可以在[环信控制台](https://console.easemob.com/user/login)对你的应用进行配置和管理。 +你可以在 [环信控制台](https://console.easemob.com/user/login) 对你的应用进行配置和管理。 | 功能 | 描述 | | :------ | :----------- | | 创建应用 | 创建你的应用 | | 升级套餐包 | 自助开通专业版或旗舰版 IM | -| 订阅增值服务 | 开通消息回调、全局禁言等 [增值服务](/product/pricing_policy.html#增值服务费用) | +| 订阅增值服务 | 开通内容审核、实时音视频、即时推送等 [增值服务](/product/pricing_policy.html#增值服务费用) | | 账户中心 | 查看订单记录和消费账单 | | 开通功能 | 开通服务端会话列表或多端多设备等功能 | -| 服务概览 | 展示你的服务版本、域名配置等 | +| 应用概览 | 展示你的服务版本、域名配置等 | | 推送配置 | 包括各厂商推送证书管理和推送模板管理 | | 消息回调 | 发送前回调和发送后回调规则配置 | | IP 白名单 | 允许你赋给特定 IP 地址调用 RESTful API 的权限 | diff --git a/docs/product/product_user_relationship.md b/docs/product/product_user_relationship.md index b0bf9a4e3..5092304b6 100644 --- a/docs/product/product_user_relationship.md +++ b/docs/product/product_user_relationship.md @@ -58,8 +58,8 @@ 环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要按以下步骤开启好友关系检查。 -1. 在环信即时通讯云的左侧导航栏中,选择 **即时通讯** > **服务概览**。 -2. 在 **设置** 区域,点击 **好友关系检查**对应的 **打开**,则该功能的状态为**已开启**。若关闭该功能,点击 **关闭**。 +1. 在环信控制台左侧导航栏中,选择 **功能配置 > 基础功能** > **用户**。 +2. 点击 **好友关系检查** 对应的开启按钮。 该功能开启后,SDK 会在用户发起单聊时检查好友关系,若用户向陌生人发送单聊消息,SDK 会提示错误码 221。 ## 黑名单 diff --git a/docs/product/voiceroom/demo_scenario_introduction.md b/docs/product/voiceroom/demo_scenario_introduction.md index 903c2061a..3505d8fa5 100644 --- a/docs/product/voiceroom/demo_scenario_introduction.md +++ b/docs/product/voiceroom/demo_scenario_introduction.md @@ -2,7 +2,7 @@ ## 场景描述 -环信语聊房(Easemob Chat Room)场景方案是环信打造的一款低门槛、高可用的语聊房场景方案。该场景方案融合了环信即时通讯云的聊天室和声网 RTC 的音频技术,提供市面主流的语聊房 App 的功能,其核心功能包括房间管理、麦位控制、聊天打赏和音频特效等,覆盖语音游戏、语音社交、相亲交友等场景,能够较为全面满足客户的语聊房开发需求。同时,环信 IM 的聊天室中的 [KV 属性管理和自动销毁](/document/ios/room_attributes.html)以及[消息优先级](/document/ios/message_send.html#聊天室消息优先级与消息丢弃逻辑)等功能能够对语聊房的功能性进行有效补充和拓展。 +环信语聊房(Easemob Chat Room)场景方案是环信打造的一款低门槛、高可用的语聊房场景方案。该场景方案融合了环信即时通讯 IM 的聊天室和声网 RTC 的音频技术,提供市面主流的语聊房 App 的功能,其核心功能包括房间管理、麦位控制、聊天打赏和音频特效等,覆盖语音游戏、语音社交、相亲交友等场景,能够较为全面满足客户的语聊房开发需求。同时,环信 IM 的聊天室中的 [KV 属性管理和自动销毁](/document/ios/room_attributes.html)以及[消息优先级](/document/ios/message_send.html#聊天室消息优先级与消息丢弃逻辑)等功能能够对语聊房的功能性进行有效补充和拓展。 ## 功能列表 diff --git a/docs/push/push_androidvendor_statistics.md b/docs/push/push_androidvendor_statistics.md index 3582b0bf3..bdc36861f 100644 --- a/docs/push/push_androidvendor_statistics.md +++ b/docs/push/push_androidvendor_statistics.md @@ -25,7 +25,7 @@ ![img](/images/instantpush/push_flyme_callbackaddr.png) -您可以在环信后台,**即时通讯** → **服务概览** 中查看当前 Appkey 的 Rest API 域名地址,仅支持填写 `easemob.com` 类型。 +您可以在环信控制台的 **应用概览** 页面中查看当前 App Key 的 Rest API 域名地址,仅支持填写 `easemob.com` 类型。 ![img](/images/instantpush/push_domain_name.png) diff --git a/docs/push/push_integration_note_ios.md b/docs/push/push_integration_note_ios.md index a8ba0cb8a..0e4be5dae 100644 --- a/docs/push/push_integration_note_ios.md +++ b/docs/push/push_integration_note_ios.md @@ -95,8 +95,8 @@ demo 中的 SDK 文件夹为 **Hyphenate SDK**,将 SDK 文件夹拖入到工 ``` 调用的 SDK 接口参数解释如下: -- App Key: 区别 APP 的标识,请参考[开发者注册及管理后台](https://docs-im.easemob.com/im/quickstart/guide/experience#注册并创建应用)。 -- apnsCertName: iOS 中推送证书名称,请参考[制作与上传推送证书](https://docs-im.easemob.com/im/ios/apns/deploy)。 +- App Key: 区别 APP 的标识,请参考 [环信控制台文档](/product/console/app_manage.html#获取应用凭证)。 +- apnsCertName: iOS 中推送证书名称,请参考 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书) 和 [上传推送证书](/document/ios/push/push_apns.html#上传推送证书)。 ### SDK 登录流程 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md index c973518c1..a220c0992 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md @@ -41,7 +41,7 @@ dependencies { 你可以在应用加载时或使用 ChatroomUIKit 之前对其进行初始化。 -初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用详情**页面查看 App Key。 +初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用概览**页面查看 App Key。 ```kotlin // 初始化 ChatroomUIKit diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md index f9bd98616..7dc274509 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md @@ -34,7 +34,7 @@ flutter pub get add chatroom_uikit 你可以在应用加载时或使用 `chatroom_uikit` 之前对其进行初始化。 -初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用详情**页面查看 App Key。 +初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用概览**页面查看 App Key。 ```dart void main() async { diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md index ee7023df6..2e52cfa50 100644 --- a/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md @@ -25,7 +25,7 @@ 你可以在应用加载时或使用 ChatroomUIKit 之前对其进行初始化。 -初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用详情**页面查看 App Key。 +初始化时,需传入 App Key。你可以在[环信控制台](https://console.easemob.com/user/login)的**应用概览**页面查看 App Key。 ```swift import ChatroomUIKit diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md b/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md index e3979e438..7eea1f9fe 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md @@ -132,7 +132,7 @@ export type RoomOption = { | 参数 | 是否必需 | 描述 | | :----------- | :----- | :--------------------- | -| `appKey` | 是 | 你在环信控制台创建应用时填入的应用名称。该参数是 App Key 的一部分。可以在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 | +| `appKey` | 是 | 你在环信控制台创建应用时填入的应用名称。该参数是 App Key 的一部分。可以在[环信控制台](https://console.easemob.com/user/login)的 **应用概览** 页面查看。 | | `isDevMode` | 否 | 如果设置为 `true`,则激活日志打印等工具。 | | `language` | 否 | 设置当前的语言,若未设置,则获取系统当前的语言作为默认值。 | | `languageBuiltInFactory` | 否 | 若未设置则使用内置的语言资源。通常可以修改内置的 UI 内容。 | diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md index ecd22c3ed..1c9a331b3 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md @@ -252,7 +252,7 @@ export default App; 在 [环信控制台](https://console.easemob.com/) 上获取以下信息,然后设置配置选项。 -- 获取 App Key。详见 [查看应用详情文档](/product/console/app_manage.html#查看应用信息) +- 获取 App Key。详见 [查看应用概览文档](/product/console/app_manage.html#查看应用信息) - 创建用户,获取用户 ID 和 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 - 获取聊天室 ID。详见 [创建聊天室文档](/product/console/operation_chatroom.html#创建聊天室)。 diff --git a/docs/uikit/chatuikit/android/chatfeature_message.md b/docs/uikit/chatuikit/android/chatfeature_message.md index 4e1c24e7b..c7f23ff03 100644 --- a/docs/uikit/chatuikit/android/chatfeature_message.md +++ b/docs/uikit/chatuikit/android/chatfeature_message.md @@ -81,7 +81,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 1. 开启消息翻译特性。 @@ -130,7 +130,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息表情回复特性在 `ChatUIKitConfig` 中默认关闭,即 `enableMessageReaction` 的默认值为 `false`。要开启该特性,将该参数设置为 `true`。示例代码如下: @@ -152,7 +152,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息话题特性在 `ChatUIKitConfig` 中默认关闭,即 `enableChatThreadMessage` 的默认值为 `false`。要开启该特性,需将该参数设置为 `true`。 @@ -311,7 +311,7 @@ class ChatThreadActivity:ChatUIKitThreadActivity() { #### 自定义输入状态指示 UI -本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/product/typing_indication.html)。 +本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/product/solution_common/typing_indication.html)。 用户需要监听透传消息回调处理导航相关 UI 显示效果。 diff --git a/docs/uikit/chatuikit/android/chatuikit_overview.md b/docs/uikit/chatuikit/android/chatuikit_overview.md index 2e03c313a..aac13b965 100644 --- a/docs/uikit/chatuikit/android/chatuikit_overview.md +++ b/docs/uikit/chatuikit/android/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信单群聊 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信单群聊 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/chatuikit-android) 和 [Android Demo 源码](https://github.com/easemob/easemob-demo-android)。 diff --git a/docs/uikit/chatuikit/flutter/chatfeature_message.md b/docs/uikit/chatuikit/flutter/chatfeature_message.md index 49ba503aa..e2fdd454b 100644 --- a/docs/uikit/chatuikit/flutter/chatfeature_message.md +++ b/docs/uikit/chatuikit/flutter/chatfeature_message.md @@ -97,7 +97,7 @@ ChatUIKitSettings.enableMessageReply = false; #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 1. 开启消息翻译特性。 @@ -135,7 +135,7 @@ ChatUIKitSettings.translateTargetLanguage = 'zh-Hans'; #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 单群聊 UiKit 的 `ChatUIKitSettings` 对象中提供了 `enableMessageReaction` 属性用于设置是否开启 `Reaction` 功能, 默认值为 `false`。要开启该功能,将该参数设置为 `true`。示例代码如下: @@ -153,7 +153,7 @@ ChatUIKitSettings.enableMessageReaction = true; #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息话题特性在 `ChatUIKitSettings.enableChatThreadMessage` 中提供开关,默认值为 `false`。要开启该特性,需将该参数设置为 `true`。 @@ -223,7 +223,7 @@ ChatUIKitSettings.enablePinMsg = false; 输入状态指示功能指在单聊会话中实时显示会话的一方正在输入的状态,增强通讯互动的实时性。此功能有助于用户了解对方是否正在回复,从而优化沟通体验,提升对话流畅度。 -本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/product/typing_indication.html)。 +本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/product/solution_common/typing_indication.html)。 diff --git a/docs/uikit/chatuikit/flutter/chatuikit_advancedusage.md b/docs/uikit/chatuikit/flutter/chatuikit_advancedusage.md index 686f514d6..6e027bac0 100644 --- a/docs/uikit/chatuikit/flutter/chatuikit_advancedusage.md +++ b/docs/uikit/chatuikit/flutter/chatuikit_advancedusage.md @@ -289,7 +289,7 @@ ChatUIKitSettings.conversationListMuteImage = const AssetImage( 消息话题(即 `Thread`)指用户可以在群组聊天中根据一条消息创建话题进行深入探讨,讨论和追踪特定项目任务,而不影响其他聊天内容。 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/)上已开通该功能。 消息话题特性在 `ChatUIKitSettings.enableChatThreadMessage` 中提供开关,默认值为 `false`。要开启该特性,需将该参数设置为 `true`。 @@ -303,7 +303,7 @@ ChatUIKitSettings.conversationListMuteImage = const AssetImage( 消息翻译是指用户可以将一条消息翻译成其他语言。消息翻译可以帮助使用不同语言的用户进行沟通。 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/)上已试用该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/)上已试用该功能。 1. 开启消息翻译特性。 @@ -329,7 +329,7 @@ ChatUIKitSettings.conversationListMuteImage = const AssetImage( 表情回复(即 `Reaction`)指用户可以使用表情符号回复消息。表情回复可以帮助用户表达情绪、态度、进行调查或投票。在单群聊 UIKit 中,用户可以长按单条消息触发消息拓展功能菜单,选择表情回复。 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/)上已开通该功能。 单群聊 UiKit 的 `ChatUIKitSettings` 对象中提供了 `enableMessageReaction` 属性用于设置是否开启 `Reaction` 功能, 默认值为 `false`。要开启该功能,将该参数设置为 `true`。示例代码如下: diff --git a/docs/uikit/chatuikit/flutter/chatuikit_overview.md b/docs/uikit/chatuikit/flutter/chatuikit_overview.md index 00a6b3caa..ce992c4ef 100644 --- a/docs/uikit/chatuikit/flutter/chatuikit_overview.md +++ b/docs/uikit/chatuikit/flutter/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信单群聊 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信单群聊 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 若要访问源码,请点击[这里](https://github.com/easemob/chatuikit-flutter)。 diff --git a/docs/uikit/chatuikit/harmonyos/chatuikit_overview.md b/docs/uikit/chatuikit/harmonyos/chatuikit_overview.md index c3dabbc86..6169766e7 100644 --- a/docs/uikit/chatuikit/harmonyos/chatuikit_overview.md +++ b/docs/uikit/chatuikit/harmonyos/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信单群聊 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信单群聊 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/easemob-uikit-harmonyos)。 diff --git a/docs/uikit/chatuikit/ios/chatfeature_message.md b/docs/uikit/chatuikit/ios/chatfeature_message.md index f6b0e7a1e..07185f161 100644 --- a/docs/uikit/chatuikit/ios/chatfeature_message.md +++ b/docs/uikit/chatuikit/ios/chatfeature_message.md @@ -100,7 +100,7 @@ Appearance.chat.contentStyle: [MessageContentDisplayStyle] = [.withReply,.withAv #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 1. 开启消息翻译特性。 @@ -133,7 +133,7 @@ Appearance.chat.targetLanguage = .English #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息表情回复特性在 `Appearance.swift` 中默认关闭,即 `Appearance.chat.contentStyle` 数组中默认不包含 `.withMessageReaction`。 @@ -158,7 +158,7 @@ Appearance.chat.contentStyle.append(.withMessageReaction) #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 Thread 特性在 `Appearance.swift` 中默认关闭,即` Appearance.chat.contentStyle` 数组中默认不包含 `.withMessageThread`。 @@ -235,7 +235,7 @@ Appearance.chat.messageLongPressedActions.removeAll { $0.tag == "Pin" } #### 自定义输入状态指示 UI -本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/product/typing_indication.html)。 +本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/product/solution_common/typing_indication.html)。 用户需要监听透传消息回调处理导航相关 UI 显示效果。 diff --git a/docs/uikit/chatuikit/ios/chatuikit_overview.md b/docs/uikit/chatuikit/ios/chatuikit_overview.md index 3936e2a17..3488fe3c2 100644 --- a/docs/uikit/chatuikit/ios/chatuikit_overview.md +++ b/docs/uikit/chatuikit/ios/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信聊天 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信聊天 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/chatuikit-ios) 和 [iOS Demo 源码](https://doc.easemob.com/product/demo.html)。 diff --git a/docs/uikit/chatuikit/ios/chatuikit_quickstart.md b/docs/uikit/chatuikit/ios/chatuikit_quickstart.md index 90d7142b1..d2ccbcb2e 100644 --- a/docs/uikit/chatuikit/ios/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/ios/chatuikit_quickstart.md @@ -29,7 +29,7 @@ 你可以在应用加载时或使用 EaseChatUIKit 之前对其进行初始化。 -初始化时,需传入 App Key。你可以在 [环信控制台](https://console.easemob.com/user/login) 的 **应用详情** 页面查看 App Key。 +初始化时,需传入 App Key。你可以在 [环信控制台](https://console.easemob.com/user/login) 的 **应用概览** 页面查看 App Key。 ``` import EaseChatUIKit diff --git a/docs/uikit/chatuikit/react-native/chatfeature_message.md b/docs/uikit/chatuikit/react-native/chatfeature_message.md index 6c5cd2633..7f06876dd 100644 --- a/docs/uikit/chatuikit/react-native/chatfeature_message.md +++ b/docs/uikit/chatuikit/react-native/chatfeature_message.md @@ -68,7 +68,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 1. 开启消息翻译特性。 @@ -98,7 +98,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 单群聊 UiKit 的 `ContainerProps` 对象中提供了 `enableReaction` 属性用于设置是否开启 `Reaction` 功能, 默认值为 `false`。要开启该功能,将该参数设置为 `true`。 @@ -112,7 +112,7 @@ #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息话题特性在 `ContainerProps.enableThread` 中提供开关,默认值为 `false`。要开启该特性,需将该参数设置为 `true`。 @@ -205,7 +205,7 @@ export function App() { #### 自定义输入状态指示 UI -本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/product/typing_indication.html)。 +本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/product/solution_common/typing_indication.html)。 如果需要自定义正在输入组件样式,需要自定义聊天页面组件的导航栏组件,可以参考 `ConversationDetailNavigationBar` 组件。 diff --git a/docs/uikit/chatuikit/react-native/chatuikit_overview.md b/docs/uikit/chatuikit/react-native/chatuikit_overview.md index 60705c642..4f584760b 100644 --- a/docs/uikit/chatuikit/react-native/chatuikit_overview.md +++ b/docs/uikit/chatuikit/react-native/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信聊天 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信聊天 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/react-native-chat-library) 和 [React Native Demo 源码](https://github.com/easemob/easemob-uikit-reactnative)。 diff --git a/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md b/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md index a5f2a1795..672b3f779 100644 --- a/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md @@ -216,7 +216,7 @@ export default function App(): React.JSX.Element { 在 [环信控制台](https://console.easemob.com/) 获取 App Key 和用户 ID 和 token,然后填入配置选项: -- 在 **应用详情** 页面 [获取 App Key](/product/console/app_manage.html#查看应用信息)。 +- 在 **应用概览** 页面 [获取 App Key](/product/console/app_manage.html#查看应用信息)。 - 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 ```tsx diff --git a/docs/uikit/chatuikit/uniapp/chatuikit_overview.md b/docs/uikit/chatuikit/uniapp/chatuikit_overview.md index b032d7f1e..639e57df6 100644 --- a/docs/uikit/chatuikit/uniapp/chatuikit_overview.md +++ b/docs/uikit/chatuikit/uniapp/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信单群聊 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信单群聊 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 UI 组件库,提供各种组件实现会话列表、聊天界面、联系人列表及后续界面等功能,帮助开发者根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/easemob-uikit-uniapp)。 diff --git a/docs/uikit/chatuikit/web/chatfeature_message.md b/docs/uikit/chatuikit/web/chatfeature_message.md index 0acca0ee0..deea737a0 100644 --- a/docs/uikit/chatuikit/web/chatfeature_message.md +++ b/docs/uikit/chatuikit/web/chatfeature_message.md @@ -96,7 +96,7 @@ features.chat.message.reply = false; #### 如何使用 -1. 使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 +1. 使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已申请试用该功能。 消息翻译特性默认开启,若要在全局配置中关闭,可以进行如下设置: @@ -126,7 +126,7 @@ features.chat.message.translate = false; #### 如何使用 -使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 表情回复特性默认开启,若要在全局配置中关闭,可以进行如下设置: @@ -148,7 +148,7 @@ features.chat.message.reaction = false; #### 如何使用 -1. 使用该特性前,请确保在[环信即时通信控制台](https://console.easemob.com/user/login)上已开通该功能。 +1. 使用该特性前,请确保在[环信控制台](https://console.easemob.com/user/login)上已开通该功能。 消息话题特性默认开启,若要在全局配置中关闭,可以进行如下设置: @@ -296,5 +296,5 @@ features.chat.messageInput.typing = false; #### 自定义 -本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/document/product/typing_indication.html)。 +本功能使用 SDK 的透传消息实现,详见 [SDK 相关文档](/product/solution_common/typing_indication.html)。 diff --git a/docs/uikit/chatuikit/web/chatuikit_overview.md b/docs/uikit/chatuikit/web/chatuikit_overview.md index f2f48d42a..473d5fd33 100644 --- a/docs/uikit/chatuikit/web/chatuikit_overview.md +++ b/docs/uikit/chatuikit/web/chatuikit_overview.md @@ -2,7 +2,7 @@ -环信单群聊 UIKit 是基于环信即时通讯云 IM SDK 开发的一款即时通讯 React UI 组件库。该组件库提供了聊天相关的组件,包括会话列表、聊天界面、联系人列表和群组设置等组件,组件内部集成了 IM SDK,可以帮助开发者不关心内部实现和数据管理就能根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 +环信单群聊 UIKit 是基于环信即时通讯 IM IM SDK 开发的一款即时通讯 React UI 组件库。该组件库提供了聊天相关的组件,包括会话列表、聊天界面、联系人列表和群组设置等组件,组件内部集成了 IM SDK,可以帮助开发者不关心内部实现和数据管理就能根据实际业务需求快速搭建包含 UI 界面的即时通讯应用。 你可以查看 [UIKit 源码](https://github.com/easemob/Easemob-UIKit-web/tree/main)。