From c8438c78448eb27c49192995bfc1163312cdd363 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 29 Sep 2025 16:20:54 +0800 Subject: [PATCH 1/9] Change Links of Old Console Documents to New Doc Links --- docs/callkit/android/easecallkit.md | 2 +- docs/callkit/android/integration.md | 2 +- docs/callkit/android/quickstart.md | 2 +- docs/callkit/ios/easecallkit.md | 2 +- docs/callkit/web/easecallkit.md | 2 +- docs/document/android/conversation_list.md | 2 +- docs/document/android/demo.md | 6 +-- docs/document/android/initialization.md | 2 +- docs/document/android/login.md | 4 +- docs/document/android/message_receipt.md | 4 +- docs/document/android/message_send.md | 2 +- docs/document/android/moderation.md | 4 +- docs/document/android/push/push_display.md | 6 +-- docs/document/android/push/push_overview.md | 10 +++-- docs/document/android/quickstart.md | 2 +- docs/document/android/user_relationship.md | 2 +- docs/document/applet/alipay.md | 2 +- docs/document/applet/baidu.md | 2 +- docs/document/applet/bytedance.md | 2 +- docs/document/applet/initialization.md | 2 +- docs/document/applet/login.md | 4 +- docs/document/applet/message_send.md | 2 +- docs/document/applet/push/uniapp_push.md | 2 +- docs/document/applet/qq.md | 2 +- docs/document/applet/uniapp.md | 2 +- docs/document/applet/uniappnativeapp.md | 2 +- docs/document/applet/wechat.md | 2 +- docs/document/flutter/conversation_list.md | 2 +- docs/document/flutter/demo.md | 6 +-- docs/document/flutter/initialization.md | 2 +- docs/document/flutter/login.md | 4 +- docs/document/flutter/message_send.md | 2 +- docs/document/flutter/moderation.md | 4 +- docs/document/flutter/overview.md | 2 +- docs/document/flutter/quickstart.md | 2 +- docs/document/flutter/user_relationship.md | 2 +- docs/document/harmonyos/conversation_list.md | 2 +- docs/document/harmonyos/initialization.md | 2 +- docs/document/harmonyos/login.md | 4 +- docs/document/harmonyos/message_receipt.md | 2 +- docs/document/harmonyos/message_send.md | 2 +- docs/document/harmonyos/overview.md | 2 +- docs/document/harmonyos/quickstart.md | 2 +- docs/document/harmonyos/user_relationship.md | 2 +- docs/document/ios/conversation_list.md | 2 +- docs/document/ios/demo.md | 6 +-- docs/document/ios/initialization.md | 2 +- docs/document/ios/login.md | 2 +- docs/document/ios/message_receipt.md | 2 +- docs/document/ios/message_send.md | 2 +- docs/document/ios/moderation.md | 4 +- docs/document/ios/quickstart.md | 4 +- docs/document/ios/user_relationship.md | 2 +- .../react-native/conversation_list.md | 2 +- docs/document/react-native/demo.md | 6 +-- docs/document/react-native/initialization.md | 2 +- docs/document/react-native/login.md | 4 +- docs/document/react-native/message_receipt.md | 2 +- docs/document/react-native/message_send.md | 2 +- docs/document/react-native/moderation.md | 4 +- docs/document/react-native/overview.md | 2 +- .../react-native/push/push_overview.md | 2 +- docs/document/react-native/quickstart.md | 4 +- docs/document/react-native/releasenote.md | 2 +- .../react-native/user_relationship.md | 2 +- docs/document/server-side/account_system.md | 38 +++++++++---------- docs/document/server-side/callback_contact.md | 12 +++--- .../server-side/callback_group_ban.md | 6 +-- .../server-side/callback_group_block.md | 8 ++-- .../server-side/callback_group_read_ack.md | 6 +-- .../server-side/callback_group_room_admin.md | 8 ++-- .../callback_group_room_allowlist.md | 8 ++-- .../callback_group_room_announcement.md | 6 +-- .../callback_group_room_blocklist.md | 8 ++-- .../server-side/callback_group_room_create.md | 6 +-- .../server-side/callback_group_room_delete.md | 6 +-- .../server-side/callback_group_room_info.md | 6 +-- .../server-side/callback_group_room_join.md | 10 ++--- .../server-side/callback_group_room_leave.md | 12 +++--- .../server-side/callback_group_room_mute.md | 8 ++-- .../callback_group_room_muteall.md | 6 +-- .../server-side/callback_group_room_owner.md | 6 +-- .../server-side/callback_group_shared_file.md | 8 ++-- .../server-side/callback_login_logout.md | 6 +-- .../server-side/callback_message_recall.md | 2 +- .../document/server-side/callback_overview.md | 2 +- .../server-side/callback_postsending.md | 16 ++++---- .../server-side/callback_presending.md | 8 ++-- .../server-side/callback_room_superadmin.md | 8 ++-- .../server-side/callback_sensitive_word.md | 2 +- .../callback_single_conversation_ack.md | 2 +- .../server-side/callback_single_read_ack.md | 6 +-- .../server-side/chatroom_attribute.md | 8 ++-- .../server-side/chatroom_label_mute.md | 8 ++-- docs/document/server-side/chatroom_manage.md | 8 ++-- .../server-side/chatroom_member_add_delete.md | 8 ++-- .../server-side/chatroom_member_admin.md | 8 ++-- .../server-side/chatroom_member_allowlist.md | 8 ++-- .../server-side/chatroom_member_blocklist.md | 8 ++-- .../server-side/chatroom_member_mutelist.md | 8 ++-- .../server-side/chatroom_member_obtain.md | 8 ++-- .../server-side/chatroom_superadmin.md | 8 ++-- .../server-side/conversation_delete.md | 8 ++-- .../easemob_user_token_password.md | 8 ++-- docs/document/server-side/group_file.md | 8 ++-- docs/document/server-side/group_manage.md | 8 ++-- .../server-side/group_member_add_delete.md | 8 ++-- .../server-side/group_member_admin.md | 8 ++-- .../server-side/group_member_allowlist.md | 8 ++-- .../server-side/group_member_attribute.md | 8 ++-- .../server-side/group_member_blocklist.md | 8 ++-- .../server-side/group_member_mutelist.md | 8 ++-- .../server-side/group_member_obtain.md | 8 ++-- docs/document/server-side/group_thread.md | 8 ++-- docs/document/server-side/keyword_add.md | 8 ++-- docs/document/server-side/keyword_delete.md | 8 ++-- .../server-side/keyword_delete_batch.md | 8 ++-- .../server-side/keyword_list_create.md | 8 ++-- .../server-side/keyword_list_delete.md | 8 ++-- .../server-side/keyword_list_modify.md | 8 ++-- .../server-side/keyword_list_query.md | 8 ++-- docs/document/server-side/keyword_modify.md | 8 ++-- docs/document/server-side/keyword_query.md | 8 ++-- .../server-side/message_attachment_storage.md | 8 ++-- docs/document/server-side/message_chatroom.md | 10 ++--- docs/document/server-side/message_delete.md | 8 ++-- docs/document/server-side/message_download.md | 8 ++-- docs/document/server-side/message_group.md | 10 ++--- .../server-side/message_historical.md | 8 ++-- docs/document/server-side/message_import.md | 8 ++-- docs/document/server-side/message_modify.md | 8 ++-- docs/document/server-side/message_offline.md | 12 +++--- docs/document/server-side/message_recall.md | 8 ++-- docs/document/server-side/message_single.md | 12 +++--- .../server-side/message_translation_detect.md | 8 ++-- .../message_translation_language_list.md | 8 ++-- .../server-side/message_translation_text.md | 8 ++-- docs/document/server-side/overview.md | 2 +- docs/document/server-side/presence.md | 8 ++-- docs/document/server-side/push.md | 6 +-- .../server-side/push_result_statistics.md | 8 ++-- docs/document/server-side/reaction.md | 8 ++-- docs/document/server-side/user_favorite.md | 8 ++-- docs/document/server-side/user_global_mute.md | 14 +++---- .../user_relationship_blocklist_add.md | 8 ++-- .../user_relationship_blocklist_check.md | 8 ++-- .../user_relationship_blocklist_obtain.md | 8 ++-- .../user_relationship_blocklist_remove.md | 8 ++-- .../user_relationship_friend_add.md | 8 ++-- .../user_relationship_friend_check.md | 8 ++-- .../user_relationship_friend_import.md | 8 ++-- .../user_relationship_friend_list_obtain.md | 8 ++-- .../user_relationship_friend_list_paged.md | 8 ++-- .../user_relationship_friend_remove.md | 8 ++-- .../user_relationship_friend_remove_all.md | 8 ++-- .../user_relationship_remark_set.md | 8 ++-- docs/document/server-side/userprofile.md | 8 ++-- docs/document/unity/conversation_list.md | 2 +- docs/document/unity/initialization.md | 2 +- docs/document/unity/login.md | 4 +- docs/document/unity/message_receipt.md | 2 +- docs/document/unity/message_send.md | 2 +- docs/document/unity/moderation.md | 4 +- docs/document/unity/overview.md | 2 +- docs/document/unity/quickstart.md | 2 +- docs/document/unity/releasenote.md | 2 +- docs/document/unity/user_relationship.md | 2 +- docs/document/web/conversation_list.md | 2 +- docs/document/web/demo_react.md | 6 +-- docs/document/web/initialization.md | 2 +- docs/document/web/login.md | 4 +- docs/document/web/message_receipt.md | 6 +-- docs/document/web/message_send.md | 2 +- docs/document/web/moderation.md | 4 +- docs/document/web/quickstart.md | 6 +-- docs/document/web/user_relationship.md | 2 +- docs/document/windows/conversation_list.md | 2 +- docs/document/windows/initialization.md | 2 +- docs/document/windows/login.md | 4 +- docs/document/windows/message_receipt.md | 4 +- docs/document/windows/message_send.md | 2 +- docs/document/windows/moderation.md | 4 +- docs/document/windows/overview.md | 2 +- docs/document/windows/quickstart.md | 4 +- docs/document/windows/releasenote.md | 2 +- docs/document/windows/user_relationship.md | 2 +- docs/product/aigc/aigc_rest_api.md | 8 ++-- .../aigc/aigc_run_through_demo_server.md | 6 +-- docs/product/circle/category_mgmt_rest.md | 8 ++-- docs/product/circle/channel_mgmt_rest.md | 8 ++-- docs/product/circle/server_mgmt_rest.md | 8 ++-- docs/product/conversation_function.md | 2 +- docs/product/easemob_app_token.md | 8 ++-- docs/product/easemob_user_token.md | 10 ++--- .../moderation/moderation_record_callback.md | 2 +- docs/product/product_dynamics.md | 2 +- docs/product/product_function.md | 2 +- .../product_user_registration_login.md | 2 +- docs/push/push_integration_note_ios.md | 2 +- .../android/roomfeature_message.md | 2 +- .../android/roomuikit_best_practice.md | 2 +- .../android/roomuikit_quickstart.md | 8 ++-- .../chatroomuikit/android/roomuikit_run.md | 2 +- .../flutter/roomuikit_best_practice.md | 2 +- .../flutter/roomuikit_integrated.md | 2 +- .../flutter/roomuikit_quickstart.md | 6 +-- .../chatroomuikit/flutter/roomuikit_run.md | 2 +- .../ios/roomuikit_best_practice.md | 2 +- .../chatroomuikit/ios/roomuikit_quickstart.md | 8 ++-- docs/uikit/chatroomuikit/ios/roomuikit_run.md | 2 +- .../react-native/roomuikit_best_practice.md | 2 +- .../react-native/roomuikit_integrated.md | 2 +- .../react-native/roomuikit_quickstart.md | 8 ++-- .../chatroomuikit/web/roomuikit_integrated.md | 2 +- .../chatuikit/android/chatuikit_quickstart.md | 4 +- .../chatuikit/flutter/chatuikit_quickstart.md | 4 +- docs/uikit/chatuikit/flutter/ui_quickstart.md | 2 +- .../harmonyos/chatuikit_integrated.md | 2 +- .../harmonyos/chatuikit_quickstart.md | 2 +- .../chatuikit/ios/chatuikit_advancedusage.md | 2 +- .../chatuikit/ios/chatuikit_quickstart.md | 6 +-- docs/uikit/chatuikit/ios/chatuikit_run.md | 4 +- .../react-native/chatuikit_quickstart.md | 4 +- .../chatuikit/react-native/ui_quickstart.md | 2 +- .../web/chatuikit_integrated_react.md | 4 +- .../chatuikit/web/chatuikit_integrated_vue.md | 2 +- .../chatuikit/web/chatuikit_quickstart.md | 4 +- 227 files changed, 591 insertions(+), 589 deletions(-) diff --git a/docs/callkit/android/easecallkit.md b/docs/callkit/android/easecallkit.md index 1f85307ad..276606ea9 100644 --- a/docs/callkit/android/easecallkit.md +++ b/docs/callkit/android/easecallkit.md @@ -35,7 +35,7 @@ EaseCallKit 集成在环信开源 IM Demo 中，你可以通过以下两种方 集成该库之前，你需要满足以下条件： -- 分别创建 [环信应用](/product/enable_and_configure_IM.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/android/get-started/enable-service#创建声网项目)； +- 分别创建 [环信应用](/product/console/app_create.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/android/get-started/enable-service#创建声网项目)； - 已完成环信 IM 的基本功能，包括登录、好友、群组以及会话等的集成； - 上线之前开通声网 Token 验证时，用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server)，用于生成 Token。具体请参见 [创建 Token 服务及使用 App Server 生成 Token](https://doc.shengwang.cn/doc/rtc/android/basic-features/token-authentication)。 diff --git a/docs/callkit/android/integration.md b/docs/callkit/android/integration.md index e2eee5fe2..6b9158659 100644 --- a/docs/callkit/android/integration.md +++ b/docs/callkit/android/integration.md @@ -56,7 +56,7 @@ dependencyResolutionManagement { } ``` -2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖： +2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 CallKit 的最新版本，详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/chat-call-kit/overview)。 ```kotlin dependencies { diff --git a/docs/callkit/android/quickstart.md b/docs/callkit/android/quickstart.md index 292f1eb99..99b7b06aa 100644 --- a/docs/callkit/android/quickstart.md +++ b/docs/callkit/android/quickstart.md @@ -61,7 +61,7 @@ dependencyResolutionManagement { } ``` -- 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖： +- 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 CallKit 的最新版本，详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/chat-call-kit/overview)。 ```kotlin dependencies { diff --git a/docs/callkit/ios/easecallkit.md b/docs/callkit/ios/easecallkit.md index 9f6280a28..92157ff83 100644 --- a/docs/callkit/ios/easecallkit.md +++ b/docs/callkit/ios/easecallkit.md @@ -40,7 +40,7 @@ pod install 在集成该库前，你需要满足以下条件： -- 分别创建 [环信应用](/product/enable_and_configure_IM.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/ios/get-started/enable-service#创建声网项目)； +- 分别创建 [环信应用](/product/console/app_create.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/ios/get-started/enable-service#创建声网项目)； - 已完成环信 IM 的基本功能，包括登录、好友、群组以及会话等的集成； - 上线之前开通声网 token 验证时，用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server)，用于生成 token。利用 App Server 生成 token 的过程参见 [声网 token](https://doc.shengwang.cn/doc/rtc/ios/basic-features/token-authentication)。 diff --git a/docs/callkit/web/easecallkit.md b/docs/callkit/web/easecallkit.md index ecd0e6294..46007ccdb 100644 --- a/docs/callkit/web/easecallkit.md +++ b/docs/callkit/web/easecallkit.md @@ -15,7 +15,7 @@ 集成该库之前，你需要满足以下条件： -- 创建 [环信应用](/product/enable_and_configure_IM.html)及[声网应用](https://doc.shengwang.cn/doc/rtc/javascript/get-started/enable-service#创建声网项目)； +- 创建 [环信应用](/product/console/app_create.html)及[声网应用](https://doc.shengwang.cn/doc/rtc/javascript/get-started/enable-service#创建声网项目)； - 实现环信 IM 的基本功能，包括登录、好友、群组以及会话等的集成； - 上线前开通声网 Token 验证时，用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server)，用于生成 Token。详见[创建 Token 服务及使用 App Server 生成 Token](https://doc.shengwang.cn/doc/rtc/javascript/basic-features/token-authentication)。 diff --git a/docs/document/android/conversation_list.md b/docs/document/android/conversation_list.md index 7e8b27847..0a5e88486 100644 --- a/docs/document/android/conversation_list.md +++ b/docs/document/android/conversation_list.md @@ -33,7 +33,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.0.3。而且，只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `asyncFilterConversationsFromDB`、`getAllConversationsBySort` 或 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/android/demo.md b/docs/document/android/demo.md index 26e6612fd..e9d945577 100644 --- a/docs/document/android/demo.md +++ b/docs/document/android/demo.md @@ -31,9 +31,9 @@ ### 跑通步骤 -1. [创建应用](/product/enable_and_configure_IM.html#创建应用)。 -2. [获取应用的 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 -3. [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +1. [创建应用](/product/console/app_create.html)。 +2. [获取应用的 App Key](/product/console/app_manage.html#查看应用信息)。 +3. [创建用户](/product/console/operation_user.html#创建用户)。 4. [下载即时通讯 IM Demo 项目源码](https://github.com/easemob/easemob-demo-android)。 5. 下载完毕，打开 Android Studio，点击 **File > Open**，打开已下载到本地的 Demo (`easemob-demo-android`) 工程根目录即可。 6. 将你的应用的 App Key 填入 Demo 工程根目录下的 `local.properties` 文件，格式为 `APPKEY = 你申请的appkey`。 diff --git a/docs/document/android/initialization.md b/docs/document/android/initialization.md index 6cb7476b6..213cc106d 100644 --- a/docs/document/android/initialization.md +++ b/docs/document/android/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/android/login.md b/docs/document/android/login.md index d3d348aae..43ba402c8 100644 --- a/docs/document/android/login.md +++ b/docs/document/android/login.md @@ -19,13 +19,13 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（4.15.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token，例如，每次登录时更新 token。 diff --git a/docs/document/android/message_receipt.md b/docs/document/android/message_receipt.md index 40e953d50..f93d3ee3e 100644 --- a/docs/document/android/message_receipt.md +++ b/docs/document/android/message_receipt.md @@ -4,7 +4,7 @@ **单聊会话支持消息送达回执和消息已读回执**，发送方发送消息后可及时了解接收方是否及时收到并阅读了消息。 -**群聊会话只支持消息已读回执，不支持送达回执**。群成员在发送消息时，可以设置该消息是否需要已读回执。要使用该功能，你需要 [在环信控制台上开通该功能](/product/console/basic_message.html#群聊消息已读回执)，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +**群聊会话只支持消息已读回执，不支持送达回执**。群成员在发送消息时，可以设置该消息是否需要已读回执。要使用该功能，你需要 [在环信控制台开通该功能](/product/console/basic_message.html#群聊消息已读回执)，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 消息送达回执和已读回执的效果示例，如下图所示： @@ -38,7 +38,7 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 要使用群消息已读回执功能，需在 [环信控制台](https://console.easemob.com/user/login) 开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执) ，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 diff --git a/docs/document/android/message_send.md b/docs/document/android/message_send.md index 33be45a86..f644729f1 100644 --- a/docs/document/android/message_send.md +++ b/docs/document/android/message_send.md @@ -2,7 +2,7 @@ 环信即时通讯 IM Android SDK 通过 [EMChatManager](https://sdkdocs.easemob.com/apidoc/android/chat3.0/classcom_1_1hyphenate_1_1chat_1_1_e_m_chat_manager.html)、[EMMessage](https://sdkdocs.easemob.com/apidoc/android/chat3.0/classcom_1_1hyphenate_1_1chat_1_1_e_m_message.html) 和 [EMOptions](https://sdkdocs.easemob.com/apidoc/android/chat3.0/classcom_1_1hyphenate_1_1chat_1_1_e_m_options.html) 类实现文本、图片、音频、视频和文件等类型的消息的发送和接收。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 - 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。 diff --git a/docs/document/android/moderation.md b/docs/document/android/moderation.md index bd09ba57c..42e89d17d 100644 --- a/docs/document/android/moderation.md +++ b/docs/document/android/moderation.md @@ -9,7 +9,7 @@ 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/enable_and_configure_IM.html#消息举报)。 +关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -22,7 +22,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/enable_and_configure_IM.html#消息举报)。 +- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 diff --git a/docs/document/android/push/push_display.md b/docs/document/android/push/push_display.md index fd0f41975..0b6888eb7 100644 --- a/docs/document/android/push/push_display.md +++ b/docs/document/android/push/push_display.md @@ -64,7 +64,7 @@ EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle(); 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/console/push_template.html)。 使用推送模板有以下优势： @@ -79,7 +79,7 @@ EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle(); - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 :::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +1. 设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面开通。如需关闭该功能联系商务，因为该操作会删除所有相关配置。 2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 ::: @@ -138,7 +138,7 @@ EMClient.getInstance().chatManager().sendMessage(message); } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/android/push/push_overview.md b/docs/document/android/push/push_overview.md index ea2b7191a..fcd4d9e3d 100644 --- a/docs/document/android/push/push_overview.md +++ b/docs/document/android/push/push_overview.md @@ -20,11 +20,13 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +离线推送的高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。 + +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -56,9 +58,9 @@ ## 前提条件 -1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +1. 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 2. 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 +3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信控制台](https://console.easemob.com/user/login)上激活。 4. 各推送使用的条件： - Google FCM：设备启用了 Google Play 服务且可连接至 Google 服务器； - 小米推送：在小米设备上可用； diff --git a/docs/document/android/quickstart.md b/docs/document/android/quickstart.md index 35bc4de75..828f11544 100644 --- a/docs/document/android/quickstart.md +++ b/docs/document/android/quickstart.md @@ -170,7 +170,7 @@ EMClient.getInstance().init(context, options); ``` ### 2. 创建用户 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 Token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 Token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/android/user_relationship.md b/docs/document/android/user_relationship.md index e8e058dbc..6c7f02fbc 100644 --- a/docs/document/android/user_relationship.md +++ b/docs/document/android/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/applet/alipay.md b/docs/document/applet/alipay.md index 1da66d452..54a526767 100644 --- a/docs/document/applet/alipay.md +++ b/docs/document/applet/alipay.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 +开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 ### 搭建支付宝小程序开发环境 diff --git a/docs/document/applet/baidu.md b/docs/document/applet/baidu.md index 04bf603ec..1bbb98df9 100644 --- a/docs/document/applet/baidu.md +++ b/docs/document/applet/baidu.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 +开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 ### 搭建百度小程序开发环境 diff --git a/docs/document/applet/bytedance.md b/docs/document/applet/bytedance.md index a560814d6..965783a99 100644 --- a/docs/document/applet/bytedance.md +++ b/docs/document/applet/bytedance.md @@ -4,7 +4,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 +开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 ### 搭建抖音小程序开发环境 diff --git a/docs/document/applet/initialization.md b/docs/document/applet/initialization.md index 3ecbc5511..fcb40cba9 100644 --- a/docs/document/applet/initialization.md +++ b/docs/document/applet/initialization.md @@ -4,7 +4,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## SDK 初始化 diff --git a/docs/document/applet/login.md b/docs/document/applet/login.md index eb0e1d81f..2f969ed7d 100644 --- a/docs/document/applet/login.md +++ b/docs/document/applet/login.md @@ -12,13 +12,13 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见[创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 登录方式 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（4.15.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token，例如，每次登录时更新 token。 diff --git a/docs/document/applet/message_send.md b/docs/document/applet/message_send.md index 353c348b9..b73e0c2b8 100644 --- a/docs/document/applet/message_send.md +++ b/docs/document/applet/message_send.md @@ -4,7 +4,7 @@ 环信即时通讯 IM 的小程序 SDK 可以实现文本、图片、音频、视频和文件等类型的消息的发送和接收。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 - 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。 diff --git a/docs/document/applet/push/uniapp_push.md b/docs/document/applet/push/uniapp_push.md index 465c76c09..e624617ac 100644 --- a/docs/document/applet/push/uniapp_push.md +++ b/docs/document/applet/push/uniapp_push.md @@ -6,7 +6,7 @@ ## 前提条件 -1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +1. 在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 2. 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 3. 你已在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。高级功能激活后，你可以设置推送通知方式、免打扰模式和自定义推送模板。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** 4. 各推送使用的条件： diff --git a/docs/document/applet/qq.md b/docs/document/applet/qq.md index b187cac4d..72cd85a9b 100644 --- a/docs/document/applet/qq.md +++ b/docs/document/applet/qq.md @@ -6,7 +6,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用)，来获取唯一 appKey，SDK 初始化时需要配置 appKey。 +开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html)，来获取唯一 appKey，SDK 初始化时需要配置 appKey。 ## 实现步骤 diff --git a/docs/document/applet/uniapp.md b/docs/document/applet/uniapp.md index 670980c16..e6b5daa05 100644 --- a/docs/document/applet/uniapp.md +++ b/docs/document/applet/uniapp.md @@ -33,7 +33,7 @@ ### 集成前准备 -[注册并创建应用](/product/enable_and_configure_IM.html#创建应用) +[注册并创建应用](/product/console/app_create.html) ### 搭建开发环境 diff --git a/docs/document/applet/uniappnativeapp.md b/docs/document/applet/uniappnativeapp.md index bd1f5f41d..264f909c5 100644 --- a/docs/document/applet/uniappnativeapp.md +++ b/docs/document/applet/uniappnativeapp.md @@ -24,7 +24,7 @@ ## 开发者集成 -[注册并创建应用](/product/enable_and_configure_IM.html#创建应用) +[注册并创建应用](/product/console/app_create.html) ### 搭建 app 开发环境 diff --git a/docs/document/applet/wechat.md b/docs/document/applet/wechat.md index 7f62a9ca2..a14929a8a 100644 --- a/docs/document/applet/wechat.md +++ b/docs/document/applet/wechat.md @@ -8,7 +8,7 @@ ### 注册环信账号 -开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 +开发者需要在环信管理后台 [注册并创建应用](/product/console/app_create.html)，来获取唯一 App Key，SDK 初始化时需要配置 App Key。 ### 搭建微信小程序开发环境 diff --git a/docs/document/flutter/conversation_list.md b/docs/document/flutter/conversation_list.md index 96f76381b..66a1b6d62 100644 --- a/docs/document/flutter/conversation_list.md +++ b/docs/document/flutter/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表) ，并将 SDK 升级至 V4.5.0 或以上版本。只有开通该功能，你才能使用置顶会话功能。** 2. 建议在 app 安装时或本地没有会话时调用该方法，否则调用 `loadAllConversations` 获取本地会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/flutter/demo.md b/docs/document/flutter/demo.md index db6008a84..b0cfdf603 100644 --- a/docs/document/flutter/demo.md +++ b/docs/document/flutter/demo.md @@ -29,9 +29,9 @@ ### 跑通步骤 -1. [创建应用](/product/enable_and_configure_IM.html)。 -2. [获取应用的 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 -3. [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +1. [创建应用](/product/console/app_create.html)。 +2. [获取应用的 App Key](/product/console/app_manage.html#查看应用信息)。 +3. [创建用户](/product/console/operation_user.html#创建用户)。 4. [下载即时通讯 IM Demo 项目源码](https://github.com/easemob/easemob-demo-flutter)。 5. 下载完毕，打开项目。 6. 将你的应用的 App Key 填入 Demo 工程根目录下的 `main.dart` 文件。 diff --git a/docs/document/flutter/initialization.md b/docs/document/flutter/initialization.md index 3d199f8bb..e0bb8c7ab 100644 --- a/docs/document/flutter/initialization.md +++ b/docs/document/flutter/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/flutter/login.md b/docs/document/flutter/login.md index 81921bf41..636c71fce 100644 --- a/docs/document/flutter/login.md +++ b/docs/document/flutter/login.md @@ -12,13 +12,13 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 1. **用户 ID + token** 是更加安全的登录方式。token 可以通过调用 REST API 获取。 详见 [环信用户 token 的获取](/document/server-side/easemob_user_token.html)。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/flutter/message_send.md b/docs/document/flutter/message_send.md index 3ad3d88cc..7b83d6ab1 100644 --- a/docs/document/flutter/message_send.md +++ b/docs/document/flutter/message_send.md @@ -2,7 +2,7 @@ 环信即时通讯 IM Flutter SDK 通过 `EMChatManager` 和 `EMMessage` 类实现文本、图片、音频、视频和文件等类型的消息的发送和接收。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 - 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。 diff --git a/docs/document/flutter/moderation.md b/docs/document/flutter/moderation.md index 9695df652..584cb14f5 100644 --- a/docs/document/flutter/moderation.md +++ b/docs/document/flutter/moderation.md @@ -9,7 +9,7 @@ 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/enable_and_configure_IM.html#消息举报)。 +关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/enable_and_configure_IM.html#消息举报)。 +- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 diff --git a/docs/document/flutter/overview.md b/docs/document/flutter/overview.md index fda9ca61d..d73b76f55 100644 --- a/docs/document/flutter/overview.md +++ b/docs/document/flutter/overview.md @@ -37,7 +37,7 @@ await EMClient.getInstance.startCallback(); ### 控制台注册 -通过控制台注册用户，详见[创建 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +通过控制台注册用户，详见[创建 IM 用户](/product/console/operation_user.html#创建用户)。 ### REST API 注册 diff --git a/docs/document/flutter/quickstart.md b/docs/document/flutter/quickstart.md index 3094c1bf6..a6d848831 100644 --- a/docs/document/flutter/quickstart.md +++ b/docs/document/flutter/quickstart.md @@ -240,7 +240,7 @@ void _initSDK() async { ### 创建用户 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/flutter/user_relationship.md b/docs/document/flutter/user_relationship.md index 43d4542e9..835afb212 100644 --- a/docs/document/flutter/user_relationship.md +++ b/docs/document/flutter/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/harmonyos/conversation_list.md b/docs/document/harmonyos/conversation_list.md index 1a3486a47..1ca848685 100644 --- a/docs/document/harmonyos/conversation_list.md +++ b/docs/document/harmonyos/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表) 。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `getAllConversationsBySort`、`getConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/harmonyos/initialization.md b/docs/document/harmonyos/initialization.md index 1d0a598f3..eceb7ba68 100644 --- a/docs/document/harmonyos/initialization.md +++ b/docs/document/harmonyos/initialization.md @@ -6,7 +6,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/harmonyos/login.md b/docs/document/harmonyos/login.md index dd9627103..cd711faa6 100644 --- a/docs/document/harmonyos/login.md +++ b/docs/document/harmonyos/login.md @@ -12,13 +12,13 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（1.8.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire`。 diff --git a/docs/document/harmonyos/message_receipt.md b/docs/document/harmonyos/message_receipt.md index fbfec5a58..633aec32f 100644 --- a/docs/document/harmonyos/message_receipt.md +++ b/docs/document/harmonyos/message_receipt.md @@ -38,7 +38,7 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 要使用群消息已读回执功能，需在 [环信控制台](https://console.easemob.com/user/login) 开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执) ，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 diff --git a/docs/document/harmonyos/message_send.md b/docs/document/harmonyos/message_send.md index ef83a93fe..9e960e302 100644 --- a/docs/document/harmonyos/message_send.md +++ b/docs/document/harmonyos/message_send.md @@ -2,7 +2,7 @@ 环信即时通讯 IM HarmonyOS SDK 通过 [`ChatManager`](https://sdkdocs.easemob.com/apidoc/harmony/chat3.0/classes/ChatManager.ChatManager.html) 类和 [`ChatMessage`](https://sdkdocs.easemob.com/apidoc/harmony/chat3.0/classes/message_ChatMessage.ChatMessage.html) 类实现文本、图片、音频、视频和文件等类型的消息的发送。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。 diff --git a/docs/document/harmonyos/overview.md b/docs/document/harmonyos/overview.md index b7065bbf6..da2a24c1f 100644 --- a/docs/document/harmonyos/overview.md +++ b/docs/document/harmonyos/overview.md @@ -50,7 +50,7 @@ ChatClient.getInstance().init(context, options); ### 控制台注册 -通过控制台注册用户，详见[创建 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +通过控制台注册用户，详见[创建 IM 用户](/product/console/operation_user.html#创建用户)。 ### REST API 注册 diff --git a/docs/document/harmonyos/quickstart.md b/docs/document/harmonyos/quickstart.md index 074997a24..786eefaed 100644 --- a/docs/document/harmonyos/quickstart.md +++ b/docs/document/harmonyos/quickstart.md @@ -124,7 +124,7 @@ ChatClient.getInstance().init(context, options); ### 2. 创建账号 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/harmonyos/user_relationship.md b/docs/document/harmonyos/user_relationship.md index 40f88554c..947936cf2 100644 --- a/docs/document/harmonyos/user_relationship.md +++ b/docs/document/harmonyos/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/ios/conversation_list.md b/docs/document/ios/conversation_list.md index 34bc539b5..620213bcd 100644 --- a/docs/document/ios/conversation_list.md +++ b/docs/document/ios/conversation_list.md @@ -33,7 +33,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.0.3。只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `filterConversationsFromDB`、`getAllConversations:` 或 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/ios/demo.md b/docs/document/ios/demo.md index 7cf4f930b..0dd26099d 100644 --- a/docs/document/ios/demo.md +++ b/docs/document/ios/demo.md @@ -31,9 +31,9 @@ ### 跑通步骤 -1. [创建应用](/product/enable_and_configure_IM.html)。 -2. [获取应用的 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 -3. [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +1. [创建应用](/product/console/app_create.html)。 +2. [获取应用的 App Key](/product/console/app_manage.html#查看应用信息)。 +3. [创建用户](/product/console/operation_user.html#创建用户)。 4. [下载即时通讯 IM Demo 项目源码](https://github.com/easemob/easemob-demo-ios)。 5. 下载完毕，打开 `EaseChatDemo` 目录，运行 `pod install`。 6. 打开 `EaseChatDemo/CustomConstants/PublicDefines.swift` 文件，修改文件中的占位符，`AppKey` 填入步骤 2 获取的 App Key，`ServerHost` 和 `CallKitAppId` 可以填入空字符串。 diff --git a/docs/document/ios/initialization.md b/docs/document/ios/initialization.md index c1764cf18..c548c239d 100644 --- a/docs/document/ios/initialization.md +++ b/docs/document/ios/initialization.md @@ -6,7 +6,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/ios/login.md b/docs/document/ios/login.md index 2c5f13d8b..dc0d161ee 100644 --- a/docs/document/ios/login.md +++ b/docs/document/ios/login.md @@ -12,7 +12,7 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户，详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 diff --git a/docs/document/ios/message_receipt.md b/docs/document/ios/message_receipt.md index 733f76094..cba36306b 100644 --- a/docs/document/ios/message_receipt.md +++ b/docs/document/ios/message_receipt.md @@ -38,7 +38,7 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 要使用群消息已读回执功能，需在 [环信控制台](https://console.easemob.com/user/login) 开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执) ，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 diff --git a/docs/document/ios/message_send.md b/docs/document/ios/message_send.md index 95f8bd175..dc58d5c1d 100644 --- a/docs/document/ios/message_send.md +++ b/docs/document/ios/message_send.md @@ -4,7 +4,7 @@ 环信即时通讯 IM iOS SDK 通过 `ChatManager` 类和 `EMChatMessage` 类实现文本、图片、音频、视频和文件等类型的消息的发送。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 - 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的相关文档。 diff --git a/docs/document/ios/moderation.md b/docs/document/ios/moderation.md index a16a939a5..9d2081110 100644 --- a/docs/document/ios/moderation.md +++ b/docs/document/ios/moderation.md @@ -9,7 +9,7 @@ 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/enable_and_configure_IM.html#消息举报)。 +关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/enable_and_configure_IM.html#消息举报)。 +- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 diff --git a/docs/document/ios/quickstart.md b/docs/document/ios/quickstart.md index 3043d8204..11b25ce39 100644 --- a/docs/document/ios/quickstart.md +++ b/docs/document/ios/quickstart.md @@ -15,7 +15,7 @@ - Xcode (推荐最新版本)。 - 安装 iOS 10.0 或以上版本的 iOS 模拟器或 Apple 设备。 - CocoaPods [1.10.1 或以上版本](https://cocoapods.org/)。 -- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 ## 1. 准备开发环境 @@ -83,7 +83,7 @@ SDK 支持 **CocoaPods 导入**和**手动导入**两种方式。 ## 4. 创建账号 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/ios/user_relationship.md b/docs/document/ios/user_relationship.md index 80053d3f3..cf03025e0 100644 --- a/docs/document/ios/user_relationship.md +++ b/docs/document/ios/user_relationship.md @@ -12,7 +12,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 黑名单管理：查询黑名单列表、将添加用户至黑名单以及从黑名单中移出用户等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/react-native/conversation_list.md b/docs/document/react-native/conversation_list.md index 8deb63770..93baf0f06 100644 --- a/docs/document/react-native/conversation_list.md +++ b/docs/document/react-native/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 1.2.0 或以上版本。而且，只有开通该功能，你才能使用置顶会话功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/react-native/demo.md b/docs/document/react-native/demo.md index d5b255ae9..9576e290e 100644 --- a/docs/document/react-native/demo.md +++ b/docs/document/react-native/demo.md @@ -31,9 +31,9 @@ ### 跑通步骤 -1. [创建应用](/product/enable_and_configure_IM.html)。 -2. [获取应用的 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 -3. [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +1. [创建应用](/product/console/app_create.html)。 +2. [获取应用的 App Key](/product/console/app_manage.html#查看应用信息)。 +3. [创建用户](/product/console/operation_user.html#创建用户)。 4. [下载即时通讯 IM Demo 项目源码](https://github.com/easemob/easemob-uikit-reactnative)。 5. 进入工程根目录，执行 `yarn && yarn prepare` 安装依赖和创建本地配置文件。 6. 更改配置文件(`examples/product-uikit-demo/src/env.ts`)内容, 设置 appKey 的值，其他字段有默认值。 diff --git a/docs/document/react-native/initialization.md b/docs/document/react-native/initialization.md index 09d5683c1..d9d4fa58c 100644 --- a/docs/document/react-native/initialization.md +++ b/docs/document/react-native/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/react-native/login.md b/docs/document/react-native/login.md index 5446c1577..103827ac4 100644 --- a/docs/document/react-native/login.md +++ b/docs/document/react-native/login.md @@ -12,11 +12,11 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户，详见[创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/react-native/message_receipt.md b/docs/document/react-native/message_receipt.md index 89dbfc2e8..2f1a259cd 100644 --- a/docs/document/react-native/message_receipt.md +++ b/docs/document/react-native/message_receipt.md @@ -38,7 +38,7 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 要使用群消息已读回执功能，需在 [环信控制台](https://console.easemob.com/user/login) 开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执) ，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 diff --git a/docs/document/react-native/message_send.md b/docs/document/react-native/message_send.md index 5cac4aa7b..240fb1683 100644 --- a/docs/document/react-native/message_send.md +++ b/docs/document/react-native/message_send.md @@ -4,7 +4,7 @@ 环信即时通讯 IM React Native SDK 通过 `ChatManager` 类和 `ChatMessage` 类实现文本、图片、音频、视频和文件等类型的消息的发送。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 - 关于消息发送控制，详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)、[群组聊天](/product/message_group.html#群组消息发送控制) 和 [聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。 diff --git a/docs/document/react-native/moderation.md b/docs/document/react-native/moderation.md index 63a1dd096..20e4d98a7 100644 --- a/docs/document/react-native/moderation.md +++ b/docs/document/react-native/moderation.md @@ -9,7 +9,7 @@ 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/enable_and_configure_IM.html#消息举报)。 +关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -21,7 +21,7 @@ 1. 完成 SDK 初始化，详见 [初始化](initialization.html)文档。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台开通消息举报功能](/product/enable_and_configure_IM.html#消息举报)。 +3. 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 ## 实现方法 diff --git a/docs/document/react-native/overview.md b/docs/document/react-native/overview.md index 2e7e77f06..07a09b6e5 100644 --- a/docs/document/react-native/overview.md +++ b/docs/document/react-native/overview.md @@ -75,7 +75,7 @@ ChatClient.getInstance() ### 控制台注册 -通过控制台注册用户，详见[创建 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +通过控制台注册用户，详见[创建 IM 用户](/product/console/operation_user.html#创建用户)。 ### REST API 注册 diff --git a/docs/document/react-native/push/push_overview.md b/docs/document/react-native/push/push_overview.md index 93bf5ac63..d71410669 100644 --- a/docs/document/react-native/push/push_overview.md +++ b/docs/document/react-native/push/push_overview.md @@ -75,7 +75,7 @@ ## 前提条件 -1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +1. 在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 2. 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 4. 各推送使用的条件： diff --git a/docs/document/react-native/quickstart.md b/docs/document/react-native/quickstart.md index 77e090d0b..512f74e9a 100644 --- a/docs/document/react-native/quickstart.md +++ b/docs/document/react-native/quickstart.md @@ -41,7 +41,7 @@ ### 其他要求 -有效的环信即时通讯 IM 开发者账号和 App key，详见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 ## 项目设置 @@ -82,7 +82,7 @@ cd ios && pod install && cd .. ## 创建用户 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 用于登录。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 用于登录。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/react-native/releasenote.md b/docs/document/react-native/releasenote.md index 0b619e9d1..a928bf268 100644 --- a/docs/document/react-native/releasenote.md +++ b/docs/document/react-native/releasenote.md @@ -446,7 +446,7 @@ 具体集成请参考以下文档： -- [开通配置环信即时通讯 IM 服务](/product/enable_and_configure_IM.html) +- [创建应用](/product/console/app_create.html) - [环信即时通讯 IM React-Native 快速开始](quickstart.html) - [消息管理 React Native](message_overview.html) - [群组](group_overview.html) diff --git a/docs/document/react-native/user_relationship.md b/docs/document/react-native/user_relationship.md index e5f6e9e01..ac81029f8 100644 --- a/docs/document/react-native/user_relationship.md +++ b/docs/document/react-native/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信即时通讯云控制台](https://console.easemob.com/user/login) [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信即时通讯云控制台](https://console.easemob.com/user/login) [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md index 344f1d186..6515618c8 100644 --- a/docs/document/server-side/account_system.md +++ b/docs/document/server-side/account_system.md @@ -12,9 +12,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -42,7 +42,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -146,7 +146,7 @@ curl -X POST -i "https://XXXX.com/XXXX-demo/XXXX/users" -d '{"username":"user1", | 400 | illegal_argument | NICKNAME_TOO_LONG | 注册用户的推送昵称长度超过限制。 | 查看注册用户名[规范](#开放注册单个用户)。 | | 400 | duplicate_unique_property_exists | Application XXX Entity user requires that property named username be unique, value of XXX exists | 注册用户名已经存在。 | 更换用户名重新注册。 | | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法，可能过期或 token 错误。 | 使用新的 token 访问。 | -| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](https://doc.easemob.com/product/enable_and_configure_IM.html#创建应用)。 | +| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](https://doc.easemob.com/product/console/app_create.html)。 | | 429 | resource_limited | You have exceeded the limit of the community edition,Please upgrade to the enterprise edition | 注册用户的数量超过当前产品套餐包的限制。 | 联系商务开通付费版。 | 关于其他错误，你可以参考 [错误码](#错误码) 了解可能的原因。 @@ -256,7 +256,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' - | 401 | unauthorized | token is illegal. | token 不合法，生成 token 使用信息与请求携带的信息不匹配。 | 使用新的 token 访问。 | | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法，可能过期或 token 错误。 | 使用新的 token 访问。 | | 401 | unauthorized | Open registration doesn't allow, so register user need token| 授权注册模式，注册用户时需要 token。 | 请求时携带 token。 | -| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](https://doc.easemob.com/product/enable_and_configure_IM.html#创建应用) | +| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](https://doc.easemob.com/product/console/app_create.html) | | 429 | resource_limited | You have exceeded the limit of the community edition,Please upgrade to the enterprise edition | 注册用户的数量超过当前产品套餐版本的限制。 | 联系商务开通付费版。 | 关于其他错误，你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -418,7 +418,7 @@ curl -X POST -H "Authorization: Bearer " -i "https://XXXX/XXXX/XX | 401 | unauthorized | token is illegal. | token 不合法，生成 token 使用信息与请求携带的信息不匹配。 | 使用新的 token 访问。 | | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法，可能过期或 token 错误。 | 使用新的 token 访问。 | | 401 | unauthorized | Open registration doesn't allow, so register user need token, | 授权注册模式，注册用户时需要 token。 | 请求时携带 token。 | -| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](/product/enable_and_configure_IM.html#创建应用)。 | +| 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)。 | | 429 | resource_limited | You have exceeded the limit of the community edition,Please upgrade to the enterprise edition | 注册用户的数量超过当前产品套餐版本的限制。 | 联系商务开通付费版。 | 关于其他错误，你可以参考 [响应状态码](error.html) 了解可能的原因。 @@ -517,7 +517,7 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer - `true`：封禁
- `false`：解禁 | | - `type` | String | `DISABLE`：封禁或解禁操作。 | diff --git a/docs/document/server-side/callback_group_block.md b/docs/document/server-side/callback_group_block.md index 94b8c44b2..afc5ad4ab 100644 --- a/docs/document/server-side/callback_group_block.md +++ b/docs/document/server-side/callback_group_block.md @@ -1,10 +1,10 @@ # 屏蔽/解除屏蔽群组事件 -成功屏蔽/解除屏蔽群组后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看群组屏蔽/解除屏蔽的信息，进行数据同步。 +成功屏蔽/解除屏蔽群组后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看群组屏蔽/解除屏蔽的信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果你需要屏蔽/解除屏蔽群组的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果你需要屏蔽/解除屏蔽群组的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -40,7 +40,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.type` | String | 屏蔽群组事件，值为 `ADD`。 | | `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | @@ -83,7 +83,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.type` | String | 解除屏蔽群组事件，值为 `REMOVE`。 | | `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | diff --git a/docs/document/server-side/callback_group_read_ack.md b/docs/document/server-side/callback_group_read_ack.md index b07adc9db..3c582d691 100644 --- a/docs/document/server-side/callback_group_read_ack.md +++ b/docs/document/server-side/callback_group_read_ack.md @@ -1,10 +1,10 @@ # 发送群组消息已读回执 -成功发送群组消息已读回执后，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。 +成功发送群组消息已读回执后，环信服务器会按照 [发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要发送群组消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要发送群组消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -52,7 +52,7 @@ | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_回执消息的消息 ID`。 | | `channel_channel` | String | 群聊消息的已读回执，格式为 `App Key_群组 ID@conference.easemob.com`，例如，示例中的 `easemob-demo#wang_277721224642561@conference.easemob.com`。| | `eventType` | String | `chat`：表示上行消息。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `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 | 你在环信管理后台注册的应用唯一标识。 | diff --git a/docs/document/server-side/callback_group_room_admin.md b/docs/document/server-side/callback_group_room_admin.md index 9367e774d..bd97ef778 100644 --- a/docs/document/server-side/callback_group_room_admin.md +++ b/docs/document/server-side/callback_group_room_admin.md @@ -1,10 +1,10 @@ # 添加/删除群组/聊天室管理员事件 -成功添加或删除群组或聊天室管理员后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加/删除的群组/聊天室管理员，进行数据同步。 +成功添加或删除群组或聊天室管理员后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加/删除的群组/聊天室管理员，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要添加/删除群组/聊天室管理员事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要添加/删除群组/聊天室管理员事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -47,7 +47,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 添加为群组/聊天室管理员的用户 ID。 | | `payload.type` | String | 添加群组/聊天室管理员的事件，值为 `ADD`。 | @@ -99,7 +99,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 被移除的群组/聊天室管理员的用户 ID。 | | `payload.type` | String | 移除群组/聊天室管理员的事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_group_room_allowlist.md b/docs/document/server-side/callback_group_room_allowlist.md index 763080c0a..308476983 100644 --- a/docs/document/server-side/callback_group_room_allowlist.md +++ b/docs/document/server-side/callback_group_room_allowlist.md @@ -1,10 +1,10 @@ # 将群组/聊天室成员加入或移出白名单的事件 -将群组/聊天室成员加入或移出白名单后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加或移出白名单的成员，进行数据同步。 +将群组/聊天室成员加入或移出白名单后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加或移出白名单的成员，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要将群组/聊天室成员加入或移出白名单的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要将群组/聊天室成员加入或移出白名单的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -44,7 +44,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | Array | 被加入白名单的成员的用户 ID。 | | `payload.type` | String | 将群组/聊天室成员加入白名单的事件，值为 `ADD`。 | @@ -93,7 +93,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.member` | JSON | 被移出白名单的成员的用户 ID。 | | `payload.type` | String | 将群组/聊天室成员移出白名单的事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_group_room_announcement.md b/docs/document/server-side/callback_group_room_announcement.md index 07ca31c39..cc3f2bc7c 100644 --- a/docs/document/server-side/callback_group_room_announcement.md +++ b/docs/document/server-side/callback_group_room_announcement.md @@ -1,10 +1,10 @@ # 群组/聊天室公告事件 -设置或更新群组/聊天室公告后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看公告信息，进行数据同步。 +设置或更新群组/聊天室公告后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看公告信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室公告事件的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室公告事件的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -41,7 +41,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | - `type` | String | 公告更新事件。 | | - `announcement` | String | 新公告内容。若删除了公告内容，则该字段不存在。 | diff --git a/docs/document/server-side/callback_group_room_blocklist.md b/docs/document/server-side/callback_group_room_blocklist.md index c35f4d75c..0f8875eff 100644 --- a/docs/document/server-side/callback_group_room_blocklist.md +++ b/docs/document/server-side/callback_group_room_blocklist.md @@ -1,10 +1,10 @@ # 将群组/聊天室成员加入/移出黑名单事件 -在群组或聊天室中的成员被加入或移出黑名单时，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看加入/移出的成员，进行数据同步。 +在群组或聊天室中的成员被加入或移出黑名单时，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看加入/移出的成员，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室成员被加入/移出黑名单事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室成员被加入/移出黑名单事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -49,7 +49,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.member` | Array | 被加入或移出群组/聊天室黑名单的用户 ID。 | | `payload.expire_timestamp` | Long | 用户在黑名单中的过期时间。用户加入黑名单后，系统会自动分配该参数的值。 | @@ -99,7 +99,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | Array | 被移出群组/聊天室黑名单的用户 ID。 | | `payload.type` | Array | 将用户移出群组/聊天室黑名单的事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_group_room_create.md b/docs/document/server-side/callback_group_room_create.md index a528ffee4..4d5ed25a9 100644 --- a/docs/document/server-side/callback_group_room_create.md +++ b/docs/document/server-side/callback_group_room_create.md @@ -1,10 +1,10 @@ # 创建群组/聊天室事件 -成功创建群组或聊天室后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看创建的群组/聊天室的信息，进行数据同步。 +成功创建群组或聊天室后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看创建的群组/聊天室的信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要创建群组/聊天室的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要创建群组/聊天室的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -65,7 +65,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.role` | JSON | 群组角色。若设置了管理员，显示管理员角色，若未设置，则只显示群组角色：
- 用户 ID：`owner`
- 用户 ID：`admin` | | `payload.member`| Array | 创建群组时拉入群的用户。 | diff --git a/docs/document/server-side/callback_group_room_delete.md b/docs/document/server-side/callback_group_room_delete.md index 5c07466ae..75e2ed6da 100644 --- a/docs/document/server-side/callback_group_room_delete.md +++ b/docs/document/server-side/callback_group_room_delete.md @@ -1,10 +1,10 @@ # 解散群组/聊天室事件 -成功解散群组或聊天室后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调进行数据同步。 +成功解散群组或聊天室后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室解散的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室解散的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -37,7 +37,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | | `id` | String | 群组/聊天室 ID。 | | `type` | String | 区分群组或聊天室事件：
- `GROUP`：群组
- `CHATROOM` ：聊天室 | diff --git a/docs/document/server-side/callback_group_room_info.md b/docs/document/server-side/callback_group_room_info.md index ddf217caf..ffcf7bffa 100644 --- a/docs/document/server-side/callback_group_room_info.md +++ b/docs/document/server-side/callback_group_room_info.md @@ -1,10 +1,10 @@ # 更新群组/聊天室信息事件 -成功更新群组/聊天室信息后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看更新后的群组/聊天室的信息，进行数据同步。 +成功更新群组/聊天室信息后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看更新后的群组/聊天室的信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室信息更新的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室信息更新的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -73,7 +73,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `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 类型，群组信息的最新修改时间。 | diff --git a/docs/document/server-side/callback_group_room_join.md b/docs/document/server-side/callback_group_room_join.md index b8dc98b6f..4ba2b5a9a 100644 --- a/docs/document/server-side/callback_group_room_join.md +++ b/docs/document/server-side/callback_group_room_join.md @@ -1,10 +1,10 @@ # 群组/聊天室加人事件 -在群组或聊天室创建时拉人进入、邀请用户加入、或用户申请加入时，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调进行数据同步。 +在群组或聊天室创建时拉人进入、邀请用户加入、或用户申请加入时，环信服务器会按照 [发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室加人的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 设置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室加人的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 设置发送后回调规则，详见 [配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -53,7 +53,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON |
- 创建群组或聊天室时，被拉入进群/聊天室的用户 ID。
- 用户主动加入聊天室时，该用户的 ID。 | | `payload.options.ext` | JSON | 扩展信息。该字段只适用于加入聊天室事件，不适用于加群事件。 | @@ -105,7 +105,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member`| JSON | 被邀请的用户 ID。 | | `payload.type` | Array | 入群方式：`INVITE` 表示邀请用户入群。 | @@ -156,7 +156,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.member` | JSON | 申请加入的用户 ID。 | | `payload.type`| Array | 加入方式：`APPLY` 表示申请入群。 | diff --git a/docs/document/server-side/callback_group_room_leave.md b/docs/document/server-side/callback_group_room_leave.md index 941bb91dd..6e957e175 100644 --- a/docs/document/server-side/callback_group_room_leave.md +++ b/docs/document/server-side/callback_group_room_leave.md @@ -1,10 +1,10 @@ # 群组/聊天室成员离开事件 -在群组或聊天室中的成员离开时，包括主动退出、被踢出以及被加入群组/聊天室黑名单时退出，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调查看离开的成员，进行数据同步。 +在群组或聊天室中的成员离开时，包括主动退出、被踢出以及被加入群组/聊天室黑名单时退出，环信服务器会按照 [发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调查看离开的成员，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室成员离开的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室成员离开的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见 [配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -72,7 +72,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见 [配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 退出群组/聊天室的用户 ID。 | | `payload.action` | JSON | 该字段只适用于退出聊天室事件，不适用于退出群组事件：
- `user_quit`：退出聊天室的用户 ID。
- `user_offline`：因离线退出聊天室。 | @@ -126,7 +126,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被踢出群组/聊天室的用户 ID。 | | `payload.type` | Array | 退群方式：`KICK` 表示将用户踢出群组/聊天室。 | @@ -180,7 +180,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被加入群组/聊天室黑名单后离开的用户 ID。 | | `payload.type` | Array | 退群方式：`BLOCK` 表示加入群组/聊天室黑名单后离开群组/聊天室。 | @@ -232,7 +232,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `id` | String | 群组/聊天室 ID。 | | `operation` | String | 操作。用户退出群组/聊天室的操作为 `LEAVE`。 | | `operator` | String | 操作人。 | diff --git a/docs/document/server-side/callback_group_room_mute.md b/docs/document/server-side/callback_group_room_mute.md index e3a94b943..33f30b484 100644 --- a/docs/document/server-side/callback_group_room_mute.md +++ b/docs/document/server-side/callback_group_room_mute.md @@ -1,10 +1,10 @@ # 将群组/聊天室成员添加或移出禁言列表的事件 -成功将群组或聊天室成员添加或移出禁言列表后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看成员禁言/解除禁言的信息，进行数据同步。 +成功将群组或聊天室成员添加或移出禁言列表后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看成员禁言/解除禁言的信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要将群组或聊天室成员添加或移出禁言列表的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要将群组或聊天室成员添加或移出禁言列表的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -46,7 +46,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被加入禁言列表的成员的用户 ID。 | | `payload.expire_timestamp` | LONG | 禁言过期时间。将群组或聊天室成员禁言后，系统会自动分配一个禁言过期时间戳。 | @@ -96,7 +96,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.member` | JSON | 被移出禁言列表的成员的用户 ID。 | | `payload.type` | String | 将成员移出禁言列表的事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_group_room_muteall.md b/docs/document/server-side/callback_group_room_muteall.md index e297a0be7..7b1664c16 100644 --- a/docs/document/server-side/callback_group_room_muteall.md +++ b/docs/document/server-side/callback_group_room_muteall.md @@ -1,10 +1,10 @@ # 群组/聊天室全员禁言事件 -群组/聊天室全员禁言或解除禁言后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看全员禁言状态，进行数据同步。 +群组/聊天室全员禁言或解除禁言后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看全员禁言状态，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要群组/聊天室全员禁言或解除禁言的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要群组/聊天室全员禁言或解除禁言的事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -43,7 +43,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `paylod` | Object | 事件内容。 | | `payload.mute` | JSON | 全员禁言或解除全员禁言：
- `true`：全员禁言
- `false`：解除全员禁言 | | `payload.type` | String | 全员禁言/解除全员禁言事件，值为 `MUTE`。 | diff --git a/docs/document/server-side/callback_group_room_owner.md b/docs/document/server-side/callback_group_room_owner.md index d35c3eec4..8c448e149 100644 --- a/docs/document/server-side/callback_group_room_owner.md +++ b/docs/document/server-side/callback_group_room_owner.md @@ -1,10 +1,10 @@ # 变更群主/聊天室所有者事件 -成功变更群主或聊天室所有者后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看新群主信息，进行数据同步。 +成功变更群主或聊天室所有者后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看新群主信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要变更群主或聊天室所有者的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要变更群主或聊天室所有者的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -46,7 +46,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | - `owner`| String | 原群主。 | | - `new_owner` | String | 新群主。 | diff --git a/docs/document/server-side/callback_group_shared_file.md b/docs/document/server-side/callback_group_shared_file.md index ecacae862..7e2730612 100644 --- a/docs/document/server-side/callback_group_shared_file.md +++ b/docs/document/server-side/callback_group_shared_file.md @@ -1,10 +1,10 @@ # 上传/删除群组共享文件事件 -上传或删除群组共享文件后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看上传或删除的群组共享文件，进行数据同步。 +上传或删除群组共享文件后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看上传或删除的群组共享文件，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要上传或删除群组共享文件的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要上传或删除群组共享文件的回调事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -44,7 +44,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | - `share_file`| String | 上传的群组共享文件。 | | - `type` | String | 群组共享文件上传事件，值为 `ADD`。 | @@ -92,7 +92,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | - `share_file`| String | 删除的群组共享文件。 | | - `type` | String | 群组共享文件删除事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_login_logout.md b/docs/document/server-side/callback_login_logout.md index e7419455a..5615c45b5 100644 --- a/docs/document/server-side/callback_login_logout.md +++ b/docs/document/server-side/callback_login_logout.md @@ -29,7 +29,7 @@ app 用户状态分为在线和离线两种，即用户已连接到环信即时 | :---------- | :------- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | | `reason` | object | `login`，用户登录。 | -| `security` | String | 签名，格式如下: MD5（callId+secret+timestamp）。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: MD5（callId+secret+timestamp）。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | @@ -65,7 +65,7 @@ app 用户状态分为在线和离线两种，即用户已连接到环信即时 | :---------- | :------- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | | `reason` | object | 值为 `logout`，表示用户登出。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | @@ -101,7 +101,7 @@ app 用户状态分为在线和离线两种，即用户已连接到环信即时 | :---------- | :------- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | | `reason` | object | `replaced`，该用户登出，原因是被其他设备登录踢掉。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `os` | String | 设备类型。 | | `ip` | String | 用户登录 IP。 | | `host` | String | 服务器名称。 | diff --git a/docs/document/server-side/callback_message_recall.md b/docs/document/server-side/callback_message_recall.md index 5b9c801d8..4e94a7545 100644 --- a/docs/document/server-side/callback_message_recall.md +++ b/docs/document/server-side/callback_message_recall.md @@ -19,7 +19,7 @@ | `msg_id` | String | 该撤回事件消息的 ID，与发送消息时的 `msg_id` 一致。 | | `payload` | object | 事件内容，与通过 REST API 发送过来的一致，查看 [历史消息内容](message_historical.html#历史消息记录的内容)。 | | `securityVersion` | String | 安全校验版本，目前为 1.0.0。忽略此参数，以后会改成 Console 后台做设置。 | -| `security` | String | 签名，格式如下: MD5（callId+secret+timestamp）。Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: MD5（callId+secret+timestamp）。Secret 见 [Console 后台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | | `appkey` | String | 你在环信管理后台注册的应用唯一标识。 | | `host` | String | 服务器名称。 | diff --git a/docs/document/server-side/callback_overview.md b/docs/document/server-side/callback_overview.md index d6d5fffed..8a4dd1fcc 100644 --- a/docs/document/server-side/callback_overview.md +++ b/docs/document/server-side/callback_overview.md @@ -12,7 +12,7 @@ - **发送后回调**：旨在让 app 后台实现必要的数据同步，环信服务器忽略回调返回码。 - 发送后回调包括发送消息、发送消息已读回执、进行群组或聊天室操作、好友关系操作和用户状态变化等事件，详见[发送后回调过滤规则设置](/product/enable_and_configure_IM.html#配置回调规则)。 + 发送后回调包括发送消息、发送消息已读回执、进行群组或聊天室操作、好友关系操作和用户状态变化等事件，详见[发送后回调过滤规则设置](/product/console/basic_webhook.html#配置消息回调规则)。 使用回调功能前，请查看你的产品套餐是否支持，详见 [增值服务费用](/product/pricing_policy.html#增值服务费用)。若不支持，你需首先在 [环信控制台](https://console.easemob.com/user/login)[开通该功能](/product/console/basic_webhook.html#消息回调-1)，然后 [配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 diff --git a/docs/document/server-side/callback_postsending.md b/docs/document/server-side/callback_postsending.md index 3c480374c..c20acf052 100644 --- a/docs/document/server-side/callback_postsending.md +++ b/docs/document/server-side/callback_postsending.md @@ -15,13 +15,13 @@ ## 实现步骤 -1. 开通回调服务：在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开通回调服务](/product/enable_and_configure_IM.html#开通消息回调)。 -2. 配置发送后回调规则：详见[规则配置说明](/product/enable_and_configure_IM.html#配置回调规则)。 +1. 开通回调服务：在[环信控制台](https://console.easemob.com/user/login)[开通回调服务](/product/console/basic_webhook.html)。 +2. 配置发送后回调规则：详见[规则配置说明](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送消息或进行群组、聊天室或联系人相关操作后，环信服务器向你的应用服务器发送回调请求。 ## 发送后回调规则 -要使用发送后回调，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置回调规则，详见[规则配置说明](/product/enable_and_configure_IM.html#配置回调规则)。 +要使用发送后回调，你需要在[环信控制台](https://console.easemob.com/user/login)配置回调规则，详见[规则配置说明](/product/console/basic_webhook.html#配置消息回调规则)。 对于同一个 app 可以针对聊天消息、离线消息和通过 REST API 发送的消息配置不同的规则。如果 app 同时需要聊天消息和离线消息两种消息，建议区分回调地址。不过，规则也可以将这两种消息同时回调至一个指定服务器地址，在接收到消息后，可以对 `eventType` 判断，区分消息类型。 @@ -77,7 +77,7 @@ | `msg_id` | 消息的 ID。 | | `payload` | 消息内容，与通过 RESTful API 发送过来的一致，查看 [消息格式文档](message_historical.html#历史消息记录的内容)。 | | `securityVersion` | 安全校验版本，目前为 1.0.0。请忽略此参数。 | -| `security` | 签名，格式如下: MD5（callId+Secret+timestamp）。关于 Secret，详见[规则配置说明](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | 签名，格式如下: MD5（callId+Secret+timestamp）。关于 Secret，详见[规则配置说明](/product/console/basic_webhook.html#配置消息回调规则)。 | ### 回调响应 @@ -112,8 +112,8 @@ GET https://{host}/{org_name}/{app_name}/callbacks/storage/info | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------------- | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header @@ -192,8 +192,8 @@ POST https://{host}/{org_name}/{app_name}/callbacks/storage/retry | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------------------- | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 请求 header diff --git a/docs/document/server-side/callback_presending.md b/docs/document/server-side/callback_presending.md index 50505a4a2..f6b6a5444 100644 --- a/docs/document/server-side/callback_presending.md +++ b/docs/document/server-side/callback_presending.md @@ -12,13 +12,13 @@ ## 实现步骤 -1. 开通回调服务：在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开通消息回调服务](/product/enable_and_configure_IM.html#开通消息回调)。 -2. 配置发送前回调规则：详见[环信即时通讯云控制台](https://console.easemob.com/user/login)[规则配置说明](/product/enable_and_configure_IM.html#配置回调规则)。 +1. 开通回调服务：在[环信控制台](https://console.easemob.com/user/login)[开通消息回调服务](/product/console/basic_webhook.html#开通服务)。 +2. 配置发送前回调规则：详见[环信控制台](https://console.easemob.com/user/login)[规则配置说明](/product/console/basic_webhook.html#配置消息回调规则)。 3. 环信服务器向你的应用服务器发送 HTTP/HTTPS POST 请求。 ## 回调规则 -要使用发送前回调，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置回调规则，详见[规则配置说明](/product/enable_and_configure_IM.html#配置回调规则)。 +要使用发送前回调，你需要在[环信控制台](https://console.easemob.com/user/login)配置回调规则，详见[规则配置说明](/product/console/basic_webhook.html#配置消息回调规则)。 对同一 app，可针对不同消息类型配置不同的规则，也支持通过同一规则选择两种以上消息类型同时回调至一个指定服务器地址。接收到消息后，你可以根据消息类型进行分类处理。 @@ -60,7 +60,7 @@ | `to` | 消息的接收方。单聊为消息接收方，群组聊天和聊天室为群组 ID 和聊天室 ID。 | | `msg_id` | 消息的 ID。 | | `payload` | 消息内容，与通过 RESTful API 发送过来的一致，查看 [消息格式文档](message_historical.html#历史消息记录的内容)。 | -| `security` | 签名，格式如下: MD5（callId+Secret+timestamp）。Secret 见 [环信即时通讯云控制台](https://console.easemob.com/user/login)[回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | 签名，格式如下: MD5（callId+Secret+timestamp）。Secret 见 [环信控制台](https://console.easemob.com/user/login)[回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 | ### 请求字段说明 diff --git a/docs/document/server-side/callback_room_superadmin.md b/docs/document/server-side/callback_room_superadmin.md index 9286f86e2..d1dbbb781 100644 --- a/docs/document/server-side/callback_room_superadmin.md +++ b/docs/document/server-side/callback_room_superadmin.md @@ -1,10 +1,10 @@ # 添加/删除聊天室超级管理员事件 -成功添加或删除聊天室超级管理员后，环信服务器会按照[发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加/删除的聊天室超级管理员，进行数据同步。 +成功添加或删除聊天室超级管理员后，环信服务器会按照[发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)向你的 App Server 发送回调请求，App Server 可通过该回调查看添加/删除的聊天室超级管理员，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要添加/删除聊天室超级管理员事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要添加/删除聊天室超级管理员事件，你需要在[环信控制台](https://console.easemob.com/user/login)设置发送后回调规则，详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见[回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -43,7 +43,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 添加的聊天室超级管理员的用户 ID。 | | `payload.type` | String | 添加聊天室超级管理员的事件，值为 `ADD`。 | @@ -91,7 +91,7 @@ | 字段名称 | 类型 | 描述 | | :------------- | :----- | :----------------------------------------------------------- | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 `App Key_UUID`。 | -| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。| +| `security` | String | 签名，格式如下: `MD5(callId+secret+timestamp)`。详见[配置环信控制台回调规则](/product/console/basic_webhook.html#配置消息回调规则)。| | `payload` | Object | 事件内容。 | | `payload.admin`| JSON | 移除的聊天室超级管理员的用户 ID。 | | `payload.type` | String | 移除聊天室超级管理员的事件，值为 `REMOVE`。 | diff --git a/docs/document/server-side/callback_sensitive_word.md b/docs/document/server-side/callback_sensitive_word.md index 08f72bbeb..8dcf8a8ac 100644 --- a/docs/document/server-side/callback_sensitive_word.md +++ b/docs/document/server-side/callback_sensitive_word.md @@ -10,7 +10,7 @@ | `eventType` | String | 事件类型，用于标识为敏感词检测还是其他类型的事件。 | | `sensitiveWords` | List | 敏感词内容。 | | `contentOwner` | String | 内容发送方的用户 ID。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。`secret` 详见 [Console 后台的回调规则配置](enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。`secret` 详见 [环信控制台的回调规则配置](/product/console/basic_webhook.html#配置消息回调规则)。 | | `contentUri` | String | 消息唯一标识，格式为 msync:msgId。 | | `host` | String | 服务器名称。 | | `appkey` | String | 即时通讯服务分配给每个应用的唯一标识，由 `orgname` 和 `appname` 参数的值组成。 | diff --git a/docs/document/server-side/callback_single_conversation_ack.md b/docs/document/server-side/callback_single_conversation_ack.md index e44bff56d..6c0cb0108 100644 --- a/docs/document/server-side/callback_single_conversation_ack.md +++ b/docs/document/server-side/callback_single_conversation_ack.md @@ -9,7 +9,7 @@ | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 “App Key_回执消息的消息 ID”。 | | `eventType` | String | `chat`：上行消息。 | | `chat_type` | String | 会话已读回执。 | -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。关于 `Secret`，详见 [环信即时通讯管理台配置回调规则的描述](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。关于 `Secret`，详见 [环信即时通讯管理台配置回调规则的描述](/product/console/basic_webhook.html#配置消息回调规则)。 | | `payload` | object | 会话已读回执详情。 | | `payload.ack_message_id` | String | 会话中消息的消息 ID。 | | `payload.type` | String | 会话已读回执类型。 | | diff --git a/docs/document/server-side/callback_single_read_ack.md b/docs/document/server-side/callback_single_read_ack.md index 06d03f359..a4c4c8077 100644 --- a/docs/document/server-side/callback_single_read_ack.md +++ b/docs/document/server-side/callback_single_read_ack.md @@ -1,10 +1,10 @@ # 发送单聊消息已读回执 -成功发送单聊消息已读回执后，环信服务器会按照 [发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。 +成功发送单聊消息已读回执后，环信服务器会按照 [发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则) 向你的 App Server 发送回调请求，App Server 可通过该回调已读回执信息，进行数据同步。 :::tip 1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务，详见 [增值服务费用)](/product/pricing_policy.html#增值服务费用)。 -2. 如果需要发送单聊消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +2. 如果需要发送单聊消息已读回执的回调事件，你需要在 [环信控制台](https://console.easemob.com/user/login) 配置发送后回调规则，详见 [配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 3. 发送后回调的相关介绍，详见 [回调说明](/document/server-side/callback_postsending.html)。 ::: @@ -46,7 +46,7 @@ | `chat_type` | String | `read_ack` 已读回执。 | | `callId` | String | `callId` 为每个回调请求的唯一标识，格式为 “App Key_回执消息的消息 ID”。 | | `channel_channel` | String | 单聊消息的已读回执，格式为 `App Key_接收已读回执用户 ID@conference.easemob.com`，例如，示例中的 `easemob-demo#wang_277721224642561@conference.easemob.com`。| -| `security` | String | 签名，格式如下: `MD5（callId+secret+timestamp）`。 Secret 见 [Console 后台回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 | +| `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 | 你在环信管理后台注册的应用唯一标识。 | diff --git a/docs/document/server-side/chatroom_attribute.md b/docs/document/server-side/chatroom_attribute.md index 98374fcc6..1215ef587 100644 --- a/docs/document/server-side/chatroom_attribute.md +++ b/docs/document/server-side/chatroom_attribute.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室属性相关限制，详见[使用限制](/product/limitation.html#聊天室基本属性)。 @@ -20,9 +20,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | diff --git a/docs/document/server-side/chatroom_label_mute.md b/docs/document/server-side/chatroom_label_mute.md index 568869bc7..f60b08f78 100644 --- a/docs/document/server-side/chatroom_label_mute.md +++ b/docs/document/server-side/chatroom_label_mute.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/chatroom_manage.md b/docs/document/server-side/chatroom_manage.md index 18bd89f6d..626ae5bd0 100644 --- a/docs/document/server-side/chatroom_manage.md +++ b/docs/document/server-side/chatroom_manage.md @@ -12,7 +12,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解不同套餐版本支持的聊天室总数，详见 [IM 套餐包功能详情](/product/product_package_feature.html)。 @@ -22,9 +22,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | diff --git a/docs/document/server-side/chatroom_member_add_delete.md b/docs/document/server-side/chatroom_member_add_delete.md index a53315d2e..6a2554874 100644 --- a/docs/document/server-side/chatroom_member_add_delete.md +++ b/docs/document/server-side/chatroom_member_add_delete.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 diff --git a/docs/document/server-side/chatroom_member_admin.md b/docs/document/server-side/chatroom_member_admin.md index 18d882db2..088747e76 100644 --- a/docs/document/server-side/chatroom_member_admin.md +++ b/docs/document/server-side/chatroom_member_admin.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -26,9 +26,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 diff --git a/docs/document/server-side/chatroom_member_allowlist.md b/docs/document/server-side/chatroom_member_allowlist.md index ff4089823..4b8125ddb 100644 --- a/docs/document/server-side/chatroom_member_allowlist.md +++ b/docs/document/server-side/chatroom_member_allowlist.md @@ -16,7 +16,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -26,9 +26,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 diff --git a/docs/document/server-side/chatroom_member_blocklist.md b/docs/document/server-side/chatroom_member_blocklist.md index a7f7af748..b321f9881 100644 --- a/docs/document/server-side/chatroom_member_blocklist.md +++ b/docs/document/server-side/chatroom_member_blocklist.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -20,9 +20,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 diff --git a/docs/document/server-side/chatroom_member_mutelist.md b/docs/document/server-side/chatroom_member_mutelist.md index b35496e09..2010cc6d3 100644 --- a/docs/document/server-side/chatroom_member_mutelist.md +++ b/docs/document/server-side/chatroom_member_mutelist.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/chatroom_member_obtain.md b/docs/document/server-side/chatroom_member_obtain.md index d4c893b93..406f79d29 100644 --- a/docs/document/server-side/chatroom_member_obtain.md +++ b/docs/document/server-side/chatroom_member_obtain.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 - 了解聊天室成员相关限制，详见[使用限制](/product/limitation.html#聊天室成员)。 @@ -46,9 +46,9 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?pagenum={ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 查询参数 diff --git a/docs/document/server-side/chatroom_superadmin.md b/docs/document/server-side/chatroom_superadmin.md index cd433298b..ce735be1b 100644 --- a/docs/document/server-side/chatroom_superadmin.md +++ b/docs/document/server-side/chatroom_superadmin.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见[接口频率限制](limitationapi.html)。 ## 公共参数 @@ -17,9 +17,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | diff --git a/docs/document/server-side/conversation_delete.md b/docs/document/server-side/conversation_delete.md index 68caf215b..778b4bdc6 100644 --- a/docs/document/server-side/conversation_delete.md +++ b/docs/document/server-side/conversation_delete.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -31,9 +31,9 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/user_channel | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 要删除会话的用户的唯一标识符，即用户 ID。 | #### 请求 header diff --git a/docs/document/server-side/easemob_user_token_password.md b/docs/document/server-side/easemob_user_token_password.md index c8b3e791d..bd2de9c9c 100644 --- a/docs/document/server-side/easemob_user_token_password.md +++ b/docs/document/server-side/easemob_user_token_password.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](/product/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](/product/easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见[接口频率限制](/product/limitationapi.html)。 @@ -30,9 +30,9 @@ POST https://{host}/{org_name}/{app_name}/token | 参数 | 类型 | 是否必需 | 描述 | | :------------- | :----- | :------- | :--------------------- | -| `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。| -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。| +| `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| #### 请求 header diff --git a/docs/document/server-side/group_file.md b/docs/document/server-side/group_file.md index ad0d4cf0b..51d509b31 100644 --- a/docs/document/server-side/group_file.md +++ b/docs/document/server-side/group_file.md @@ -6,7 +6,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 了解群组公告和群共享文件的大小限制，详见 [使用限制](limitation.html#群组)。 @@ -16,9 +16,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_manage.md b/docs/document/server-side/group_manage.md index 0d663a5f1..7942558aa 100644 --- a/docs/document/server-side/group_manage.md +++ b/docs/document/server-side/group_manage.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 了解单个 App 创建群组数量的限制，以及单个用户可加入群组的数量限制（视版本而定），详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_add_delete.md b/docs/document/server-side/group_member_add_delete.md index d613b6394..1495023cf 100644 --- a/docs/document/server-side/group_member_add_delete.md +++ b/docs/document/server-side/group_member_add_delete.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_admin.md b/docs/document/server-side/group_member_admin.md index af220b4b5..577513ca3 100644 --- a/docs/document/server-side/group_member_admin.md +++ b/docs/document/server-side/group_member_admin.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | #### 响应参数 diff --git a/docs/document/server-side/group_member_allowlist.md b/docs/document/server-side/group_member_allowlist.md index 7c37e2977..22a3ded97 100644 --- a/docs/document/server-side/group_member_allowlist.md +++ b/docs/document/server-side/group_member_allowlist.md @@ -14,7 +14,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -24,9 +24,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_attribute.md b/docs/document/server-side/group_member_attribute.md index 3f2f7c302..a56b0b387 100644 --- a/docs/document/server-side/group_member_attribute.md +++ b/docs/document/server-side/group_member_attribute.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_blocklist.md b/docs/document/server-side/group_member_blocklist.md index e215eb20f..525e671b6 100644 --- a/docs/document/server-side/group_member_blocklist.md +++ b/docs/document/server-side/group_member_blocklist.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_mutelist.md b/docs/document/server-side/group_member_mutelist.md index 3d017b7eb..5314a2bc8 100644 --- a/docs/document/server-side/group_member_mutelist.md +++ b/docs/document/server-side/group_member_mutelist.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -18,9 +18,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/group_member_obtain.md b/docs/document/server-side/group_member_obtain.md index 5c4ee3b95..dbb065a5f 100644 --- a/docs/document/server-side/group_member_obtain.md +++ b/docs/document/server-side/group_member_obtain.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 群成员的相关限制，详见 [使用限制](limitation.html#群组)。 @@ -46,9 +46,9 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N} | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | #### 查询参数 diff --git a/docs/document/server-side/group_thread.md b/docs/document/server-side/group_thread.md index 36767c9f4..f2ebc28cb 100644 --- a/docs/document/server-side/group_thread.md +++ b/docs/document/server-side/group_thread.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯 IM 管理后台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 子区相关的限制，详见 [使用限制](limitation.html#子区)。 - 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。 @@ -19,9 +19,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | diff --git a/docs/document/server-side/keyword_add.md b/docs/document/server-side/keyword_add.md index b7e10e6fe..9218d68e7 100644 --- a/docs/document/server-side/keyword_add.md +++ b/docs/document/server-side/keyword_add.md @@ -11,7 +11,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -33,9 +33,9 @@ POST https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id}/word/ba | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。将关键词添加到该名单中。 | ### 请求 header diff --git a/docs/document/server-side/keyword_delete.md b/docs/document/server-side/keyword_delete.md index fb6ee0f15..fd77183b8 100644 --- a/docs/document/server-side/keyword_delete.md +++ b/docs/document/server-side/keyword_delete.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ DELETE https://{host}/{org_name}/{app_name}/moderation/text/list/(list_id)/word? | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。 | ### 查询参数 diff --git a/docs/document/server-side/keyword_delete_batch.md b/docs/document/server-side/keyword_delete_batch.md index bd2b26587..8ad0b3fcf 100644 --- a/docs/document/server-side/keyword_delete_batch.md +++ b/docs/document/server-side/keyword_delete_batch.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ DELETE https://{host}/{org_name}/{app_name}/moderation/text/list/(list_id)/word/ | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。 | ### 请求 header diff --git a/docs/document/server-side/keyword_list_create.md b/docs/document/server-side/keyword_list_create.md index 3835e6dec..e491db3f2 100644 --- a/docs/document/server-side/keyword_list_create.md +++ b/docs/document/server-side/keyword_list_create.md @@ -13,7 +13,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -35,9 +35,9 @@ POST https://{host}/{org_name}/{app_name}/moderation/text/list | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/keyword_list_delete.md b/docs/document/server-side/keyword_list_delete.md index 320cab107..ac3ee6c3e 100644 --- a/docs/document/server-side/keyword_list_delete.md +++ b/docs/document/server-side/keyword_list_delete.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ DELETE https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id} | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 要删除的关键词名单 ID。 | ## HTTP 响应 diff --git a/docs/document/server-side/keyword_list_modify.md b/docs/document/server-side/keyword_list_modify.md index e9cd14233..2e645a2aa 100644 --- a/docs/document/server-side/keyword_list_modify.md +++ b/docs/document/server-side/keyword_list_modify.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ PUT https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id} | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。 | ### 请求 header diff --git a/docs/document/server-side/keyword_list_query.md b/docs/document/server-side/keyword_list_query.md index b85f3ddd5..38bcaa9e1 100644 --- a/docs/document/server-side/keyword_list_query.md +++ b/docs/document/server-side/keyword_list_query.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ POST https://{host}/{org_name}/{app_name}/moderation/text/list/search | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/keyword_modify.md b/docs/document/server-side/keyword_modify.md index a001bbc4c..16f56c7ad 100644 --- a/docs/document/server-side/keyword_modify.md +++ b/docs/document/server-side/keyword_modify.md @@ -10,7 +10,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -32,9 +32,9 @@ PUT https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id}/word | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。要修改该名单中的关键词。 | ### 请求 header diff --git a/docs/document/server-side/keyword_query.md b/docs/document/server-side/keyword_query.md index 74dd83d36..aa3cf7e59 100644 --- a/docs/document/server-side/keyword_query.md +++ b/docs/document/server-side/keyword_query.md @@ -11,7 +11,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -34,9 +34,9 @@ POST https://{host}/{org_name}/{app_name}/moderation/text/list/{list_id}/word | 参数 | 类型 | 是否必需 | 描述 | | :------------ | :----- | :------- | :---------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `list_id` | String | 是 | 关键词名单 ID。查询该名单中的关键词。 | ### 请求 header diff --git a/docs/document/server-side/message_attachment_storage.md b/docs/document/server-side/message_attachment_storage.md index 4c88da46d..aa2bd3cc4 100644 --- a/docs/document/server-side/message_attachment_storage.md +++ b/docs/document/server-side/message_attachment_storage.md @@ -14,7 +14,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -35,9 +35,9 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/chatfiles/lifetime | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 调用该接口的用户 ID。 | #### 请求 Header diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md index 6c0d3dd80..cf5dbfbf7 100644 --- a/docs/document/server-side/message_chatroom.md +++ b/docs/document/server-side/message_chatroom.md @@ -52,7 +52,7 @@ - 该接口不校验传入的发送方用户 ID 和作为接收方的聊天室 ID。如果你传入的发送方用户 ID 和聊天室 ID 不存在，服务器并不会提示，仍照常发送消息。 - 聊天室中发消息时，不会同步给发送方。 - 你可以设置哪些用户拉漫游消息时拉不到该消息（`roam_ignore_users` 参数）。 -- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在[环信控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 - 调用该接口会触发发送后回调事件，请查看 [回调事件文档](callback_message_send.html#发送聊天室消息)。 - [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 @@ -131,7 +131,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -140,9 +140,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 diff --git a/docs/document/server-side/message_delete.md b/docs/document/server-side/message_delete.md index 35a12ad07..b18bee63e 100644 --- a/docs/document/server-side/message_delete.md +++ b/docs/document/server-side/message_delete.md @@ -12,7 +12,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -21,9 +21,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md index 068ee71fc..136da313f 100644 --- a/docs/document/server-side/message_download.md +++ b/docs/document/server-side/message_download.md @@ -8,7 +8,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -17,9 +17,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 diff --git a/docs/document/server-side/message_group.md b/docs/document/server-side/message_group.md index 7a7be326b..99647aa63 100644 --- a/docs/document/server-side/message_group.md +++ b/docs/document/server-side/message_group.md @@ -55,7 +55,7 @@ - 群组中发送的消息均同步给发送方。 - 你可以只将消息发送给在线用户，若群组中的用户离线则无法收到消息（`routetype` 参数）。 - 你可以设置哪些用户拉漫游消息时拉不到该消息（`roam_ignore_users` 参数）。 -- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 - 调用该接口会触发发送后回调事件，请查看 [回调事件文档](callback_message_send.html#发送群组消息)。 - [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 @@ -126,7 +126,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -135,9 +135,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 diff --git a/docs/document/server-side/message_historical.md b/docs/document/server-side/message_historical.md index 57bff972d..ad6bc5e0c 100644 --- a/docs/document/server-side/message_historical.md +++ b/docs/document/server-side/message_historical.md @@ -17,7 +17,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -26,9 +26,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。| +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| ### 响应参数 diff --git a/docs/document/server-side/message_import.md b/docs/document/server-side/message_import.md index 7ad6cc5ff..0a5d5c1d7 100644 --- a/docs/document/server-side/message_import.md +++ b/docs/document/server-side/message_import.md @@ -15,7 +15,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 公共参数 @@ -24,9 +24,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 diff --git a/docs/document/server-side/message_modify.md b/docs/document/server-side/message_modify.md index df1f15c19..b753885be 100644 --- a/docs/document/server-side/message_modify.md +++ b/docs/document/server-side/message_modify.md @@ -31,7 +31,7 @@ 要调用环信即时通讯 REST API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 需联系环信商务开通该功能。 @@ -53,9 +53,9 @@ PUT https://{host}/{org_name}/{app_name}/messages/rewrite/{msg_id} | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `msg_id` | String| 是 | 要修改的消息的 ID。| ### 请求 header diff --git a/docs/document/server-side/message_offline.md b/docs/document/server-side/message_offline.md index f85f969f1..538206ae0 100644 --- a/docs/document/server-side/message_offline.md +++ b/docs/document/server-side/message_offline.md @@ -10,9 +10,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -30,7 +30,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 @@ -119,7 +119,7 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer ### 3. 创建用户 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/web/user_relationship.md b/docs/document/web/user_relationship.md index 8c3bf0d5c..678fc92fa 100644 --- a/docs/document/web/user_relationship.md +++ b/docs/document/web/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移出黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/windows/conversation_list.md b/docs/document/windows/conversation_list.md index efc488fb0..07e7f2ca2 100644 --- a/docs/document/windows/conversation_list.md +++ b/docs/document/windows/conversation_list.md @@ -34,7 +34,7 @@ :::tip 1. 若使用该方法，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 1.2.0 或以上版本。 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `LoadAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: ```csharp diff --git a/docs/document/windows/initialization.md b/docs/document/windows/initialization.md index 5f25b58f8..6c6b4cc10 100644 --- a/docs/document/windows/initialization.md +++ b/docs/document/windows/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/windows/login.md b/docs/document/windows/login.md index f1f5af8b3..bd8f815f6 100644 --- a/docs/document/windows/login.md +++ b/docs/document/windows/login.md @@ -12,13 +12,13 @@ 2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户： -可以在[环信控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在[环信控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在 [环信控制台](https://console.easemob.com/user/login) 创建用户后，环信服务器会自动为这些用户分配用户 Token，详见 [测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下，你在 [环信控制台](https://console.easemob.com/user/login) 创建用户后，环信服务器会自动为这些用户分配用户 Token，详见 [查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/windows/message_receipt.md b/docs/document/windows/message_receipt.md index 63550469f..6bf1408e6 100644 --- a/docs/document/windows/message_receipt.md +++ b/docs/document/windows/message_receipt.md @@ -4,7 +4,7 @@ **单聊会话支持消息送达回执和消息已读回执**，发送方发送消息后可及时了解接收方是否及时收到并阅读了消息。 -**群聊会话只支持消息已读回执，不支持送达回执**。群成员在发送消息时，可以设置该消息是否需要已读回执。要使用该功能，你需要[在环信即时通讯云控制台上开通该功能](/product/enable_and_configure_IM.html#设置群消息已读回执)，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +**群聊会话只支持消息已读回执，不支持送达回执**。群成员在发送消息时，可以设置该消息是否需要已读回执。要使用该功能，你需要 [在环信控制台开通该功能](/product/console/basic_message.html#群聊消息已读回执)，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 消息送达回执和已读回执的效果示例，如下图所示： @@ -38,7 +38,7 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 要使用群消息已读回执功能，需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执) ，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 diff --git a/docs/document/windows/message_send.md b/docs/document/windows/message_send.md index d7b8a49a3..03486e102 100644 --- a/docs/document/windows/message_send.md +++ b/docs/document/windows/message_send.md @@ -2,7 +2,7 @@ 环信即时通讯 IM SDK 通过 `IChatManager` 和 `Message` 类实现文本、图片、音频、视频和文件等类型的消息的发送。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 diff --git a/docs/document/windows/moderation.md b/docs/document/windows/moderation.md index 4f59acd7a..42c0ab51c 100644 --- a/docs/document/windows/moderation.md +++ b/docs/document/windows/moderation.md @@ -9,7 +9,7 @@ 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/enable_and_configure_IM.html#消息举报)。 +关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/enable_and_configure_IM.html#消息举报)。 +- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 diff --git a/docs/document/windows/overview.md b/docs/document/windows/overview.md index 32570e1db..9b0f7fb85 100644 --- a/docs/document/windows/overview.md +++ b/docs/document/windows/overview.md @@ -53,7 +53,7 @@ SDKClient.Instance.InitWithOptions(options); ### 控制台注册 -通过控制台注册用户，详见[创建 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +通过控制台注册用户，详见[创建 IM 用户](/product/console/operation_user.html#创建用户)。 ### REST API 注册 diff --git a/docs/document/windows/quickstart.md b/docs/document/windows/quickstart.md index 2042d1034..ff667c334 100644 --- a/docs/document/windows/quickstart.md +++ b/docs/document/windows/quickstart.md @@ -25,7 +25,7 @@ - Visual Studio IDE 2019 或以上； - .Net Framework 4.5.2 或以上； - 目前 Windows SDK 仅支持 64 位运行模式； -- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 ## 项目设置 @@ -89,7 +89,7 @@ SDKClient.Instance.InitWithOptions(options); ### 4.创建用户 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/windows/releasenote.md b/docs/document/windows/releasenote.md index 350825ec0..0f3ffb543 100644 --- a/docs/document/windows/releasenote.md +++ b/docs/document/windows/releasenote.md @@ -325,7 +325,7 @@ 具体集成请参考以下文档： -- [开通配置环信即时通讯 IM 服务](/product/enable_and_configure_IM.html) +- 在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - [环信即时通讯 IM Windows 快速入门](quickstart.html) - [消息管理 Windows](message_send.html) - [群组 Windows](group_manage.html) diff --git a/docs/document/windows/user_relationship.md b/docs/document/windows/user_relationship.md index b9c0088f5..d25f82680 100644 --- a/docs/document/windows/user_relationship.md +++ b/docs/document/windows/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、同意好友请求、拒绝好友请求和删除好友等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/product/aigc/aigc_rest_api.md b/docs/product/aigc/aigc_rest_api.md index f78c98510..34793d85c 100644 --- a/docs/product/aigc/aigc_rest_api.md +++ b/docs/product/aigc/aigc_rest_api.md @@ -6,7 +6,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯云控制台 [开通配置环信即时通讯 IM 服务](/product/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 app token，详见 [使用 App Token 鉴权](/product/easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](/product/limitationapi.html)。 @@ -34,9 +34,9 @@ GET https://{host}/{org_name}/{app_name}/robot/rule?&page={page}&size={size} | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 查询参数 diff --git a/docs/product/aigc/aigc_run_through_demo_server.md b/docs/product/aigc/aigc_run_through_demo_server.md index cd2f1c9e6..d3f0238f5 100644 --- a/docs/product/aigc/aigc_run_through_demo_server.md +++ b/docs/product/aigc/aigc_run_through_demo_server.md @@ -65,7 +65,7 @@ easemob: #### 4. 创建机器人账号 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 示例项目中创建了 3 个智能体，因此建议设置 3 个机器人账号与智能体一 一绑定，即 `com.easemob.chattyai.chat.util.BotSettingUtil` 中的 `botBean0.setAccount`（机器人用户 ID）与 `botBean0.setName`（智能体名称）为一 一对应关系，见下方代码。 @@ -90,9 +90,9 @@ bots.put("boy0",botBean0); #### 5. 配置发送前回调规则 -若使用消息发送前回调功能，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通该功能，详见[回调配置相关文档](/product/enable_and_configure_IM.html#配置消息回调)。该功能为增值服务，费用详见 [增值服务费用](/product/pricing_policy.html#增值服务费用)。 +若使用消息发送前回调功能，你需要在[环信控制台](https://console.easemob.com/user/login)开通该功能，详见[回调配置相关文档](/product/console/basic_webhook.html#发送前回调)。该功能为增值服务，费用详见 [增值服务费用](/product/pricing_policy.html#增值服务费用)。 -回调功能开通后，选择**即时通讯** > **功能配置** > **消息回调**，点击**添加回调地址**，配置发送前回调规则。其中，**会话类型**选择**单聊**和**群聊**，**消息类型**选择**文本**，**启用状态**选择**启用**，**回调地址**需确保设置为环信即时通讯 IM 可以通过外网访问到回调地址，格式为 `http(s)://ip:端口/chatty/callback.json`。其他参数的含义详见[配置回调规则相关文档](/product/enable_and_configure_IM.html#配置回调规则)。 +回调功能开通后，选择**即时通讯** > **功能配置** > **消息回调**，点击**添加回调地址**，配置发送前回调规则。其中，**会话类型**选择**单聊**和**群聊**，**消息类型**选择**文本**，**启用状态**选择**启用**，**回调地址**需确保设置为环信即时通讯 IM 可以通过外网访问到回调地址，格式为 `http(s)://ip:端口/chatty/callback.json`。其他参数的含义详见[配置回调规则相关文档](/product/console/basic_webhook.html#配置消息回调规则)。 ![img](/images/aigc/callback_address.png) diff --git a/docs/product/circle/category_mgmt_rest.md b/docs/product/circle/category_mgmt_rest.md index 3ef055882..2564da4e3 100644 --- a/docs/product/circle/category_mgmt_rest.md +++ b/docs/product/circle/category_mgmt_rest.md @@ -17,7 +17,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](/document/server-side/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](/product/limitationapi.html)。 ## 公共参数 @@ -26,9 +26,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------------------------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `channel_category_id` | String | 是 | 频道分组 ID。 | diff --git a/docs/product/circle/channel_mgmt_rest.md b/docs/product/circle/channel_mgmt_rest.md index e73c535f4..fc91eba28 100644 --- a/docs/product/circle/channel_mgmt_rest.md +++ b/docs/product/circle/channel_mgmt_rest.md @@ -15,7 +15,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](http://doc.easemob.com/document/server-side/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](http://doc.easemob.com/product/limitationapi.html)。 ## 公共参数 @@ -24,9 +24,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------------------------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `user_id` | String | 是 | 用户 ID。 | diff --git a/docs/product/circle/server_mgmt_rest.md b/docs/product/circle/server_mgmt_rest.md index 1669603dc..72e72f191 100644 --- a/docs/product/circle/server_mgmt_rest.md +++ b/docs/product/circle/server_mgmt_rest.md @@ -15,7 +15,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](http://doc.easemob.com/document/server-side/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](http://doc.easemob.com/product/limitationapi.html)。 ## 公共参数 @@ -24,9 +24,9 @@ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------------------------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `user_id` | String | 是 | 用户 ID。 | diff --git a/docs/product/conversation_function.md b/docs/product/conversation_function.md index 8d1828eed..bd7cc1359 100644 --- a/docs/product/conversation_function.md +++ b/docs/product/conversation_function.md @@ -41,7 +41,7 @@ ### 用户关系 -环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 | 功能 | 描述 | | :-------------- | :----- | diff --git a/docs/product/easemob_app_token.md b/docs/product/easemob_app_token.md index 2eb34fdcc..09257973c 100644 --- a/docs/product/easemob_app_token.md +++ b/docs/product/easemob_app_token.md @@ -24,9 +24,9 @@ POST https://{host}/{org_name}/{app_name}/token | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | -| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 请求 header @@ -91,4 +91,4 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' - | 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 中传入的与该参数一致。 | -| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或[创建应用](/product/enable_and_configure_IM.html#创建应用)。 | +| 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/easemob_user_token.md b/docs/product/easemob_user_token.md index b66a7760a..d800f4920 100644 --- a/docs/product/easemob_user_token.md +++ b/docs/product/easemob_user_token.md @@ -32,7 +32,7 @@ 要调用环信即时通讯 RESTful API，请确保满足以下要求： -- 已在环信控制台 [开通配置环信即时通讯 IM 服务](/product/enable_and_configure_IM.html)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 已从服务端获取 App Token，详见 [使用 App Token 鉴权](/product/easemob_app_token.html)。 - 了解环信 IM API 的调用频率限制，详见 [接口频率限制](/product/limitationapi.html)。 @@ -54,9 +54,9 @@ POST https://{host}/{org_name}/{app_name}/token | 参数 | 类型 | 是否必需 | 描述 | | :------------- | :----- | :------- | :---------------------------------- | -| `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。| -| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。| +| `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| #### 请求 header @@ -141,7 +141,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' - | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法，可能过期或 token 错误。 | 使用新的 token 访问。 | | 401 | auth_bad_access_token | Unable to authenticate due to corrupt access token | token 权限错误（可能使用的是用户 token）或生成 token 时使用的 app key 与 请求 url 中使用的 app key 不相同。 | 请保证使用的 token 正确。 | | 404 | invalid_grant | user not found | 用户不存在。 | 先注册用户或者检查用户名是否正确。| -| 404 | organization_application_not_found | Could not find application for XXX/XXX from URI: XXX/XXX/users | App key 不存在。 | 检查 `orgName` 和 `appName` 是否正确或 [创建应用](/product/enable_and_configure_IM.html#创建应用)。| +| 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)。| | 404 | entity_not_found | User null not found | 用户不存在。 | 先注册用户或者检查用户名是否正确。 | | 409 | concurrent_operation_error | concurrency create app user failed | 同一秒内多次获取用户 token 时，若自动创建用户（即请求 body 中的 `grant_type` 为 `inherit`，`autoCreateUser` 为 `true`），引起的并发注册用户问题。 | 避免同一秒内多次调用该 API 自动创建用户获取用户 token。 如果获取 token 的用户已注册，并发调用该 API 则不会报错。 | | 429 | resource_limited | You have exceeded the limit of the community edition,Please upgrade to the enterprise edition | 请求 body 中 `grant_type` 为 `inherit`，`autoCreateUser` 为 `true`（用户不存在时，自动注册用户） ，在使用注册用户的数量超过版本的限制 | 联系商务开通付费版。 | diff --git a/docs/product/moderation/moderation_record_callback.md b/docs/product/moderation/moderation_record_callback.md index 10c2e3595..923e17a38 100644 --- a/docs/product/moderation/moderation_record_callback.md +++ b/docs/product/moderation/moderation_record_callback.md @@ -12,7 +12,7 @@ ![img](/images/moderation/moderation_callback_02.png) -3. 勾选 **内容审核**，其他字段的设置详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 +3. 勾选 **内容审核**，其他字段的设置详见[配置回调规则](/product/console/basic_webhook.html#配置消息回调规则)。 ![img](/images/moderation/moderation_callback_03.png) diff --git a/docs/product/product_dynamics.md b/docs/product/product_dynamics.md index 0f6dc78c5..bf0566ad1 100644 --- a/docs/product/product_dynamics.md +++ b/docs/product/product_dynamics.md @@ -77,7 +77,7 @@ 1. 注册用户时用户 ID 建议统一使用小写字母 -为了更好地实现服务端与 SDK 的兼容，调用 [RESTful API](/document/server-side/account_system.html#注册用户)和客户端 API 以及 [在环信控制台创建用户](/product/enable_and_configure_IM.html#创建-im-用户)时，建议统一使用小写字母。目前用户 ID 支持以下字符集： +为了更好地实现服务端与 SDK 的兼容，调用 [RESTful API](/document/server-side/account_system.html#注册用户)和客户端 API 以及 [在环信控制台创建用户](/product/console/operation_user.html#创建用户)时，建议统一使用小写字母。目前用户 ID 支持以下字符集： - 26 个小写英文字母 a-z； - 10 个数字 0-9； diff --git a/docs/product/product_function.md b/docs/product/product_function.md index 9a1cbb3cf..bc2a81e48 100644 --- a/docs/product/product_function.md +++ b/docs/product/product_function.md @@ -112,7 +112,7 @@ ## 用户关系 -环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 | 功能 | 描述 | | :-------------- | :----- | diff --git a/docs/product/product_user_registration_login.md b/docs/product/product_user_registration_login.md index 584da5f33..9f2ebf08a 100644 --- a/docs/product/product_user_registration_login.md +++ b/docs/product/product_user_registration_login.md @@ -9,7 +9,7 @@ - 开放注册：一般在体验 Demo 和测试环境时使用，正式环境中不推荐使用该方式注册环信账号。要使用开放注册，需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域，将**用户注册模式**设置为**开放注册**。只有打开该开关，才能使用客户端或 [REST API](/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#批量授权注册用户)的接口介绍。 -除此以外，可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户，详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +除此以外，可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户，详见[创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 用户登录 diff --git a/docs/push/push_integration_note_ios.md b/docs/push/push_integration_note_ios.md index 6e4890d75..a8ba0cb8a 100644 --- a/docs/push/push_integration_note_ios.md +++ b/docs/push/push_integration_note_ios.md @@ -4,7 +4,7 @@ ## iOS SDK 使用须知 -使用 SDK 之前，你需先创建应用，获取应用的唯一标识 App Key，请参见[创建应用](/product/enable_and_configure_IM.html#创建应用)。 +使用 SDK 之前，你需先创建应用，获取应用的唯一标识 App Key，请参见[创建应用](/product/console/app_create.html)。 环信推送分为在线推送和远程推送，远程推送时通过 APNS 下发，所以你需要配置应用对应的证书，请参见[APNS 推送配置](/document/ios/push/push_apns.html#上传推送证书)。 diff --git a/docs/uikit/chatroomuikit/android/roomfeature_message.md b/docs/uikit/chatroomuikit/android/roomfeature_message.md index 32c85bbf2..23b0a98f7 100644 --- a/docs/uikit/chatroomuikit/android/roomfeature_message.md +++ b/docs/uikit/chatroomuikit/android/roomfeature_message.md @@ -22,7 +22,7 @@ ## 消息撤回 -在聊天室中撤销已经发送的消息。当用户发送一条消息后，可能会发现消息内容有误或不妥当，可以使用消息撤回功能将消息从聊天室的聊天窗口中删除，使其他用户无法再看到该消息。在 UIKit 中，默认通过长按单条消息，触发撤回选项，实现对该条消息的撤回。撤回的默认限制是 2 分钟，超时则无法撤回。时间限制可[通过环信控制台的进行调整](/product/enable_and_configure_IM.html#设置消息撤回-rest-客户端)，最长为 7 天。 +在聊天室中撤销已经发送的消息。当用户发送一条消息后，可能会发现消息内容有误或不妥当，可以使用消息撤回功能将消息从聊天室的聊天窗口中删除，使其他用户无法再看到该消息。在 UIKit 中，默认通过长按单条消息，触发撤回选项，实现对该条消息的撤回。撤回的默认限制是 2 分钟，超时则无法撤回。时间限制可[通过环信控制台的进行调整](/product/console/basic_message.html#消息撤回)，最长为 7 天。 :::tip 所有用户只能撤回自己发送的消息，即使聊天室所有者也不能撤回其他成员发送的消息。 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md index cf4d33f83..734890838 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md @@ -40,7 +40,7 @@ ChatroomUIKitClient.getInstance().login(YourAppUser, token, onSuccess = {}, onEr ## 初始化聊天室视图 -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 加载聊天室视图 `ComposeChatroom`，传入的参数包括聊天室 ID、布局参数、聊天室所有者的用户 ID 及一些选项。 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md index 735139e73..31c977bec 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md @@ -11,7 +11,7 @@ - 使用 Kotlin 语言开发，1.5.21 或以上版本； - JDK 1.8 或以上版本； - Gradle 7.0.0 或以上版本； -- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 ## 创建项目引入 ChatroomUIKit 模块 @@ -58,7 +58,7 @@ class ChatroomApplication : Application() { ### 第二步 登录 ChatroomUIKit -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 ChatroomUIKit。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 ChatroomUIKit。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 :::tip 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 ChatroomUIKit。 @@ -74,7 +74,7 @@ class ChatroomApplication : Application() { 创建聊天室视图的步骤如下： -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 加载聊天室视图 `ComposeChatroom`，传入的参数包括聊天室 ID 和聊天室所有者的用户 ID。 @@ -89,7 +89,7 @@ class ChatroomActivity : ComponentActivity(){ } ``` -3. [添加聊天室成员](https://doc.easemob.com/product/enable_and_configure_IM.html#创建聊天室)。 +3. [添加聊天室成员](/product/console/operation_chatroom.html#创建聊天室)。 ### 第四步 发送消息 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_run.md b/docs/uikit/chatroomuikit/android/roomuikit_run.md index c984cfb94..21c8055d3 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_run.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_run.md @@ -47,7 +47,7 @@ dependencies { ### 第三步 编译 -编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。此外，还需[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)。 +编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/console/operation_user.html#创建用户)。此外，还需 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)。 1. 初始化 ChatroomUIKit。 diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md index 6dbbaceb2..cb8b9d3b5 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md @@ -74,7 +74,7 @@ try { } ``` -2. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +2. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 3. 使用 `chatroom_uikit` 前，需要先创建 `ChatroomController`, 并使 `ChatRoomUIKit` 作为当前页面的根节点，并将其他组件作为 `ChatRoomUIKit` 的子节点。 diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_integrated.md b/docs/uikit/chatroomuikit/flutter/roomuikit_integrated.md index 25ba7afdb..4d0a1ba31 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_integrated.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_integrated.md @@ -8,7 +8,7 @@ - 即时通讯 SDK 3.0.0（包含）-4.0.0； - Flutter 3.3.0 或以上版本； -- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/console/app_manage.html#查看应用信息)。 - 对于 `iOS` 应用： - Xcode 13 或以上版本; - ios 11 或以上版本; diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md index aefdaa82b..c19e46fcd 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md @@ -8,13 +8,13 @@ - 即时通讯 SDK 3.0.0（包含）-4.0.0； - Flutter 3.3.0 或以上版本； -- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/console/app_manage.html#查看应用信息)。 ## 操作流程 ### 第一步 创建聊天室和用户 -在环信控制台[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)和[用户](/product/enable_and_configure_IM.html#创建-im-用户)。 +在环信控制台 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)和 [用户](/product/console/operation_user.html#创建用户)。 ### 第二步 创建项目 @@ -48,7 +48,7 @@ void main() async { ### 第五步 登录 chatroom_uikit -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 `chatroom_uikit`。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 `chatroom_uikit`。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 :::tip 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 `chatroom_uikit`。 diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_run.md b/docs/uikit/chatroomuikit/flutter/roomuikit_run.md index 0be019ae1..98f57ee29 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_run.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_run.md @@ -8,7 +8,7 @@ - 即时通讯 SDK 3.0.0（包含）-4.0.0； - Flutter 3.3.0 或以上版本； -- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)； +- 有效的环信即时通讯 IM 开发者账号和 [App Key](/product/console/app_manage.html#查看应用信息)； - `iOS` 应用： - Xcode 13 或以上; - ios 11 或以上; diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md index cd4a4db62..13498e6df 100644 --- a/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/ios/roomuikit_best_practice.md @@ -42,7 +42,7 @@ ChatroomUIKitClient.shared.login(user: YourAppUser(), token: "token", completion ## 初始化聊天室视图 -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 创建聊天室视图 `ChatroomView`，传入的参数包括聊天室 ID、布局参数、聊天室所有者的用户 ID 及一些选项。 diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md index d164017dd..827d395df 100644 --- a/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md @@ -41,7 +41,7 @@ class AppDelegate：UIResponder，UIApplicationDelegate { ### 第二步 登录 ChatroomUIKit -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 ChatroomUIKit。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token 登录 ChatroomUIKit。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 :::tip 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 ChatroomUIKit。 @@ -57,7 +57,7 @@ ChatroomUIKitClient.shared.login(userId: "user id", token: "token", completion: 创建聊天室视图的步骤如下： -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 创建聊天室视图 `ChatroomView`，传入的参数包括聊天室 ID、布局参数和聊天室所有者的用户 ID。 @@ -76,7 +76,7 @@ let roomView = ChatroomUIKitClient.shared.launchRoomView(roomId: "Chat room ID", ![img](/images/uikit/chatroomios/hierarchy.png =800x550) -4. [添加聊天室成员](https://doc.easemob.com/product/enable_and_configure_IM.html#创建聊天室)。 +4. [添加聊天室成员](/product/console/operation_chatroom.html#聊天室审核管理)。 ### 第四步 发送第一条消息 @@ -84,4 +84,4 @@ let roomView = ChatroomUIKitClient.shared.launchRoomView(roomId: "Chat room ID", ![img](/images/uikit/chatroomios/click_chat.png =500x500) -上图为聊天室 Demo 显示的内容，如果要实现类似的样式，可以点击[这里](https://github.com/easemob/ChatroomDemo/tree/dev/iOS/ChatroomDemo)。 \ No newline at end of file +上图为聊天室 Demo 显示的内容，如果要实现类似的样式，可以点击 [GitHub 链接](https://github.com/easemob/ChatroomDemo/tree/dev/iOS/ChatroomDemo)。 \ No newline at end of file diff --git a/docs/uikit/chatroomuikit/ios/roomuikit_run.md b/docs/uikit/chatroomuikit/ios/roomuikit_run.md index 86c583721..90e9ce11e 100644 --- a/docs/uikit/chatroomuikit/ios/roomuikit_run.md +++ b/docs/uikit/chatroomuikit/ios/roomuikit_run.md @@ -32,7 +32,7 @@ ### 第三步 编译 -编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在[环信控制台](https://console.easemob.com/user/login)上创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)。此外，还需[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)。 +编译时，需要传入 App Key、用户 ID 和用户 token。因此，编译前，你需要在 [环信控制台](https://console.easemob.com/user/login) 创建有效的环信即时通讯 IM 开发者账号，并获取 App Key，[创建环信 IM 用户](/product/console/operation_user.html#创建用户)。此外，还需 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)。 1. 使用 Xcode 打开 .xcworkspace 工程文件。 diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md index 6aa95c359..f51dcfa8f 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md @@ -88,7 +88,7 @@ export function LoginScreen(props: Props) { ## 初始化聊天室视图 -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/enable_and_configure_IM.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 加载聊天室视图 `Chatroom`，传入的参数包括聊天室 ID、聊天室所有者的用户 ID 及一些选项。 diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_integrated.md b/docs/uikit/chatroomuikit/react-native/roomuikit_integrated.md index c5d7d1988..80e861013 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_integrated.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_integrated.md @@ -9,7 +9,7 @@ - NodeJs 16.18 或以上版本； - iOS 应用：Xcode 13 或以上版本以及它的相关依赖工具； - Android 应用：Android Studio 2021 或以上版本以及它的相关依赖工具； -- 有效的环信即时通讯 IM 开发者账号和 [App key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 [App key](/product/console/app_manage.html#查看应用信息)。 ## 创建项目或现有项目 diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md index 6fd1e02ec..ecd22c3ed 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_quickstart.md @@ -12,7 +12,7 @@ ## 开发者账号 -有效的环信即时通讯 IM 开发者账号和 [App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +有效的环信即时通讯 IM 开发者账号和 [App Key](/product/console/app_manage.html#查看应用信息)。 ## 操作流程 @@ -252,9 +252,9 @@ export default App; 在 [环信控制台](https://console.easemob.com/) 上获取以下信息，然后设置配置选项。 -- 获取 App Key。详见 [查看应用详情文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息) -- 创建用户，获取用户 ID 和 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 -- 获取聊天室 ID。详见 [创建聊天室文档](/product/enable_and_configure_IM.html#创建聊天室)。 +- 获取 App Key。详见 [查看应用详情文档](/product/console/app_manage.html#查看应用信息) +- 创建用户，获取用户 ID 和 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 +- 获取聊天室 ID。详见 [创建聊天室文档](/product/console/operation_chatroom.html#创建聊天室)。 ```tsx const appKey = ""; diff --git a/docs/uikit/chatroomuikit/web/roomuikit_integrated.md b/docs/uikit/chatroomuikit/web/roomuikit_integrated.md index 51ad699a3..98b27928d 100644 --- a/docs/uikit/chatroomuikit/web/roomuikit_integrated.md +++ b/docs/uikit/chatroomuikit/web/roomuikit_integrated.md @@ -8,7 +8,7 @@ - React 16.8.0 或以上版本； - React DOM 16.8.0 或以上版本； -- 有效的 Easemob IM 开发者账号，并[获取 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的 Easemob IM 开发者账号，并[获取 App Key](/product/console/app_manage.html#查看应用信息)。 ## 创建项目 diff --git a/docs/uikit/chatuikit/android/chatuikit_quickstart.md b/docs/uikit/chatuikit/android/chatuikit_quickstart.md index da6be3866..4a91daafa 100644 --- a/docs/uikit/chatuikit/android/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/android/chatuikit_quickstart.md @@ -11,7 +11,7 @@ - Android Studio 4.0 或以上 - Android SDK API 21 或以上 - JDK 11 或以上 -- 有效的环信即时通讯 IM 开发者账号和 App key，详见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 App key，详见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 ## 项目准备 @@ -205,7 +205,7 @@ android.enableJetifier=true 若你已集成了即时通讯 IM SDK，SDK 的所有用户 ID 均可用于登录单群聊 UIKit。 ::: -你需要在环信控制台 [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)，登录时传入用户 ID 和密码。 +你需要在环信控制台 [创建用户](/product/console/operation_user.html#创建用户)，登录时传入用户 ID 和密码。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/uikit/chatuikit/flutter/chatuikit_quickstart.md b/docs/uikit/chatuikit/flutter/chatuikit_quickstart.md index 9b5e8588a..4e713d690 100644 --- a/docs/uikit/chatuikit/flutter/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/flutter/chatuikit_quickstart.md @@ -86,7 +86,7 @@ void main() { 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录单群聊 UIKit。 ::: -- [使用用户 ID 和密码登录](/product/enable_and_configure_IM.html#创建-im-用户)： +- [使用用户 ID 和密码登录](/product/console/operation_user.html#创建用户)： ```dart ChatUIKit.instance.loginWithPassword(userId: userId, password: password); @@ -94,7 +94,7 @@ ChatUIKit.instance.loginWithPassword(userId: userId, password: password); - 使用用户 ID 和 token 登录： -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 diff --git a/docs/uikit/chatuikit/flutter/ui_quickstart.md b/docs/uikit/chatuikit/flutter/ui_quickstart.md index 8da50f0a5..b3a20080f 100644 --- a/docs/uikit/chatuikit/flutter/ui_quickstart.md +++ b/docs/uikit/chatuikit/flutter/ui_quickstart.md @@ -10,7 +10,7 @@ 集成 em_chat_uikit 前，你的开发环境需要满足以下条件： 1. 有效的环信即时通讯 IM 开发者账号，创建应用并获取 App Key。 -2. 在[环信控制台](https://console.easemob.com/index)[创建两个用户用于聊天](/product/enable_and_configure_IM.html#创建-im-用户)。 +2. 在[环信控制台](https://console.easemob.com/index)[创建两个用户用于聊天](/product/console/operation_user.html#创建用户)。 ### Android 平台 diff --git a/docs/uikit/chatuikit/harmonyos/chatuikit_integrated.md b/docs/uikit/chatuikit/harmonyos/chatuikit_integrated.md index 9dd5d95eb..1cb316160 100644 --- a/docs/uikit/chatuikit/harmonyos/chatuikit_integrated.md +++ b/docs/uikit/chatuikit/harmonyos/chatuikit_integrated.md @@ -9,7 +9,7 @@ - DevEco Studio NEXT Release（5.0.3.900）及以上； - HarmonyOS SDK API 12 及以上； - HarmonyOS NEXT.0.0.71 或以上版本的模拟器或者真机； -- 有效的环信即时通讯 IM 开发者账号和 App Key，请参见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，请参见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 ## 集成单群聊 UIKit diff --git a/docs/uikit/chatuikit/harmonyos/chatuikit_quickstart.md b/docs/uikit/chatuikit/harmonyos/chatuikit_quickstart.md index 418b340ba..6cffa95a3 100644 --- a/docs/uikit/chatuikit/harmonyos/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/harmonyos/chatuikit_quickstart.md @@ -11,7 +11,7 @@ - DevEco Studio NEXT Release（5.0.3.900）及以上； - HarmonyOS SDK API 12 及以上； - HarmonyOS NEXT.0.0.71 或以上版本的模拟器或者真机； -- 有效的环信即时通讯 IM 开发者账号和 App Key，请参见 [环信控制台文档](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，请参见 [环信控制台文档](/product/console/app_manage.html#查看应用信息)。 ## 项目准备 diff --git a/docs/uikit/chatuikit/ios/chatuikit_advancedusage.md b/docs/uikit/chatuikit/ios/chatuikit_advancedusage.md index d98325fff..11342414b 100644 --- a/docs/uikit/chatuikit/ios/chatuikit_advancedusage.md +++ b/docs/uikit/chatuikit/ios/chatuikit_advancedusage.md @@ -16,7 +16,7 @@ let error = ChatUIKitClient.shared.setup(option: ChatOptions(appKey: appKey)) 使用当前用户对象符合 `ChatUserProfileProtocol` 协议的用户信息登录 EaseChatUIKit。 -[在环信控制台上创建用户](/product/enable_and_configure_IM.html#创建-im-用户)，将用户 ID 传入以下代码中的 `userId`。 +[在环信控制台上创建用户](/product/console/operation_user.html#创建用户)，将用户 ID 传入以下代码中的 `userId`。 :::tip 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 EaseChatUIKit。 diff --git a/docs/uikit/chatuikit/ios/chatuikit_quickstart.md b/docs/uikit/chatuikit/ios/chatuikit_quickstart.md index b10e6bb69..d627b30e2 100644 --- a/docs/uikit/chatuikit/ios/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/ios/chatuikit_quickstart.md @@ -11,7 +11,7 @@ - Xcode：推荐最新版本。 - 安装 iOS 14.0 或以上版本的 iOS 模拟器或 Apple 设备。 - CocoaPods 1.14.3 及以上版本已经安装并且已跑通了集成。 -- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 ## 实现发送第一条单聊消息 @@ -52,7 +52,7 @@ let error = EaseChatUIKitClient.shared.setup(appKey: "Appkey") 若你已集成了 IM SDK，SDK 的所有用户 ID 均可用于登录 EaseChatUIKit。 ::: -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 @@ -120,7 +120,7 @@ public final class YourAppUser: NSObject, EaseProfileProtocol { ### 第四步 创建聊天页面 -1. 在控制台[关闭好友关系检查功能](/product/enable_and_configure_IM.html#好友关系检查)，即无需添加好友即可聊天。 +1. 在控制台[关闭好友关系检查功能](/product/console/basic_user.html#好友关系检查)，即无需添加好友即可聊天。 2. 调用 `init` 方法将在控制台上创建的用户的用户 ID 传入 `conversationId` 参数，向该用户发送消息。 ```swift diff --git a/docs/uikit/chatuikit/ios/chatuikit_run.md b/docs/uikit/chatuikit/ios/chatuikit_run.md index bc58d34ee..40bba27a8 100644 --- a/docs/uikit/chatuikit/ios/chatuikit_run.md +++ b/docs/uikit/chatuikit/ios/chatuikit_run.md @@ -41,11 +41,11 @@ pod install --repo-update ![img](/images/uikit/chatuikit/ios/buildError.png) -1. 在[环信即时通讯控制台](https://console.easemob.com/user/login)创建有效的环信即时通讯 IM 开发者账号和 [App Key](/product/enable_and_configure_IM.html#创建应用)。然后，将 App Key 填入 `appKey` 字段，运行项目。 +1. 在[环信即时通讯控制台](https://console.easemob.com/user/login)创建有效的环信即时通讯 IM 开发者账号和 [App Key](/product/console/app_create.html)。然后，将 App Key 填入 `appKey` 字段，运行项目。 在键盘上按 `cmd+B` 重新编译程序即可跑通项目。 -4. [创建有效的环信 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)，将用户的 ID 和 token 分别填入下图的两个输入框，点击 **Login**。 +4. [创建有效的环信 IM 用户](/product/console/operation_user.html#创建用户)，将用户的 ID 和 token 分别填入下图的两个输入框，点击 **Login**。 diff --git a/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md b/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md index ee2b19567..a5f2a1795 100644 --- a/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/react-native/chatuikit_quickstart.md @@ -216,8 +216,8 @@ export default function App(): React.JSX.Element { 在 [环信控制台](https://console.easemob.com/) 获取 App Key 和用户 ID 和 token，然后填入配置选项： -- 在 **应用详情** 页面 [获取 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 -- 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +- 在 **应用详情** 页面 [获取 App Key](/product/console/app_manage.html#查看应用信息)。 +- 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 ```tsx const appKey = ""; diff --git a/docs/uikit/chatuikit/react-native/ui_quickstart.md b/docs/uikit/chatuikit/react-native/ui_quickstart.md index 3c9a2c61b..e7536daa9 100644 --- a/docs/uikit/chatuikit/react-native/ui_quickstart.md +++ b/docs/uikit/chatuikit/react-native/ui_quickstart.md @@ -7,7 +7,7 @@ 在集成之前，需要满足以下条件： 1. 有效的环信即时通讯 IM 开发者账号，创建应用并获取 App Key。 -2. 在[环信控制台](https://console.easemob.com/index)[创建两个用户用于聊天](/product/enable_and_configure_IM.html#创建-im-用户)。 +2. 在[环信控制台](https://console.easemob.com/index)[创建两个用户用于聊天](/product/console/operation_user.html#创建用户)。 ## 开发环境需求 diff --git a/docs/uikit/chatuikit/web/chatuikit_integrated_react.md b/docs/uikit/chatuikit/web/chatuikit_integrated_react.md index 8228e5fdf..058e9e7fd 100644 --- a/docs/uikit/chatuikit/web/chatuikit_integrated_react.md +++ b/docs/uikit/chatuikit/web/chatuikit_integrated_react.md @@ -10,7 +10,7 @@ - React 16.8.0 或以上版本； - React DOM 16.8.0 或以上版本； -- [即时通讯 IM 应用和 App Key](/product/enable_and_configure_IM.html#创建应用)。 +- [即时通讯 IM 应用和 App Key](/product/console/app_create.html)。 ## 操作步骤 @@ -45,7 +45,7 @@ import "easemob-chat-uikit/style.css"; 若要实现自动登录，初始化时需传入 `userId`、`password` 或 `token`。 -你需要在环信控制台[创建 IM 用户](/product/enable_and_configure_IM.html#创建-im-用户)，获取用户 ID 和密码。如果使用 token，你需要从你的 App Server 获取用户 token，详见[使用环信用户 token 鉴权](/product/easemob_user_token.html) 。 +你需要在环信控制台[创建 IM 用户](/product/console/operation_user.html#创建用户)，获取用户 ID 和密码。如果使用 token，你需要从你的 App Server 获取用户 token，详见[使用环信用户 token 鉴权](/product/easemob_user_token.html) 。 ```jsx import React from 'react'; diff --git a/docs/uikit/chatuikit/web/chatuikit_integrated_vue.md b/docs/uikit/chatuikit/web/chatuikit_integrated_vue.md index 6d52f1a2d..f4b1894e8 100644 --- a/docs/uikit/chatuikit/web/chatuikit_integrated_vue.md +++ b/docs/uikit/chatuikit/web/chatuikit_integrated_vue.md @@ -6,7 +6,7 @@ 开始前，确保你的开发环境满足如下条件： - 已安装 [Node.js](https://nodejs.org/)。 -- [即时通讯 IM 应用和 App Key](/product/enable_and_configure_IM.html#创建应用)。 +- [即时通讯 IM 应用和 App Key](/product/console/app_create.html)。 ## 操作步骤 diff --git a/docs/uikit/chatuikit/web/chatuikit_quickstart.md b/docs/uikit/chatuikit/web/chatuikit_quickstart.md index 06265c303..2c1a653d5 100644 --- a/docs/uikit/chatuikit/web/chatuikit_quickstart.md +++ b/docs/uikit/chatuikit/web/chatuikit_quickstart.md @@ -10,7 +10,7 @@ - React 16.8.0 或以上版本； - React DOM 16.8.0 或以上版本； -- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。 ## 支持的浏览器 @@ -70,7 +70,7 @@ yarn add easemob-chat-uikit #### 使用 easemob-chat-uikit 组件构建应用 -在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)。 +在 [环信控制台](https://console.easemob.com/user/login) 创建用户，获取用户 ID 和用户 token。详见 [创建用户文档](/product/console/operation_user.html#创建用户)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 From b3ae61a5182c78f4ed3364893c7ef06a3c392d43 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Mon, 29 Sep 2025 16:24:32 +0800 Subject: [PATCH 2/9] Replace Easemob IM Console with Easemob Console --- docs/README.md | 2 +- docs/document/android/conversation_list.md | 2 +- docs/document/android/initialization.md | 2 +- docs/document/android/login.md | 8 ++-- docs/document/android/message_recall.md | 2 +- docs/document/android/message_receipt.md | 2 +- docs/document/android/message_translation.md | 2 +- docs/document/android/moderation.md | 14 +++--- docs/document/android/push/push_display.md | 2 +- docs/document/android/push/push_fcm.md | 4 +- docs/document/android/push/push_honor.md | 6 +-- docs/document/android/push/push_huawei.md | 6 +-- docs/document/android/push/push_meizu.md | 4 +- .../push/push_notification_mode_dnd.md | 2 +- docs/document/android/push/push_oppo.md | 4 +- docs/document/android/push/push_overview.md | 6 +-- docs/document/android/push/push_solution.md | 2 +- docs/document/android/push/push_vivo.md | 4 +- docs/document/android/push/push_xiaomi.md | 4 +- docs/document/android/quickstart.md | 2 +- docs/document/applet/initialization.md | 4 +- docs/document/applet/login.md | 2 +- docs/document/applet/push/push_overview.md | 4 +- docs/document/applet/push/uniapp_push.md | 8 ++-- docs/document/flutter/conversation_list.md | 2 +- docs/document/flutter/initialization.md | 2 +- docs/document/flutter/login.md | 8 ++-- docs/document/flutter/message_recall.md | 2 +- docs/document/flutter/message_receipt.md | 2 +- docs/document/flutter/message_translation.md | 2 +- docs/document/flutter/moderation.md | 14 +++--- docs/document/flutter/overview.md | 2 +- docs/document/flutter/push/push_display.md | 6 +-- .../flutter/push/push_easemob_console.md | 12 ++--- .../push/push_notification_mode_dnd.md | 2 +- docs/document/flutter/push/push_overview.md | 8 ++-- docs/document/flutter/quickstart.md | 2 +- docs/document/flutter/thread.md | 2 +- docs/document/flutter/thread_message.md | 4 +- docs/document/flutter/user_relationship.md | 2 +- docs/document/harmonyos/conversation_list.md | 2 +- docs/document/harmonyos/initialization.md | 2 +- docs/document/harmonyos/login.md | 10 ++--- docs/document/harmonyos/message_recall.md | 2 +- docs/document/harmonyos/message_receipt.md | 2 +- docs/document/harmonyos/overview.md | 2 +- docs/document/harmonyos/push/push_display.md | 6 +-- docs/document/harmonyos/push/push_harmony.md | 2 +- .../push/push_notification_mode_dnd.md | 2 +- docs/document/harmonyos/push/push_overview.md | 10 ++--- docs/document/harmonyos/quickstart.md | 2 +- docs/document/harmonyos/user_relationship.md | 2 +- docs/document/ios/conversation_list.md | 2 +- docs/document/ios/initialization.md | 2 +- docs/document/ios/login.md | 8 ++-- docs/document/ios/message_recall.md | 2 +- docs/document/ios/message_receipt.md | 2 +- docs/document/ios/message_translation.md | 2 +- docs/document/ios/moderation.md | 14 +++--- docs/document/ios/push/push_apns.md | 8 ++-- docs/document/ios/push/push_display.md | 6 +-- .../ios/push/push_notification_mode_dnd.md | 2 +- docs/document/ios/push/push_overview.md | 8 ++-- docs/document/ios/push/push_solution.md | 2 +- docs/document/ios/user_relationship.md | 2 +- .../react-native/conversation_list.md | 2 +- docs/document/react-native/initialization.md | 2 +- docs/document/react-native/login.md | 4 +- docs/document/react-native/message_recall.md | 2 +- docs/document/react-native/message_receipt.md | 2 +- .../react-native/message_translation.md | 2 +- docs/document/react-native/moderation.md | 14 +++--- docs/document/react-native/overview.md | 2 +- .../react-native/push/push_display.md | 6 +-- .../react-native/push/push_easemob_console.md | 12 ++--- .../push/push_notification_mode_dnd.md | 2 +- .../react-native/push/push_overview.md | 10 ++--- .../push/push_send_token_to_server.md | 6 +-- docs/document/react-native/thread_message.md | 2 +- .../react-native/user_relationship.md | 2 +- docs/document/server-side/account_system.md | 4 +- .../document/server-side/callback_overview.md | 2 +- .../server-side/chatroom_attribute.md | 4 +- .../server-side/chatroom_label_mute.md | 4 +- docs/document/server-side/chatroom_manage.md | 4 +- .../server-side/chatroom_member_add_delete.md | 4 +- .../server-side/chatroom_member_admin.md | 4 +- .../server-side/chatroom_member_allowlist.md | 4 +- .../server-side/chatroom_member_blocklist.md | 4 +- .../server-side/chatroom_member_mutelist.md | 4 +- .../server-side/chatroom_member_obtain.md | 4 +- .../server-side/chatroom_superadmin.md | 4 +- .../server-side/conversation_delete.md | 4 +- .../easemob_user_token_password.md | 2 +- docs/document/server-side/error.md | 4 +- docs/document/server-side/group_file.md | 4 +- docs/document/server-side/group_manage.md | 4 +- .../server-side/group_member_add_delete.md | 4 +- .../server-side/group_member_admin.md | 4 +- .../server-side/group_member_allowlist.md | 4 +- .../server-side/group_member_attribute.md | 4 +- .../server-side/group_member_blocklist.md | 4 +- .../server-side/group_member_mutelist.md | 4 +- .../server-side/group_member_obtain.md | 4 +- docs/document/server-side/group_thread.md | 44 +++++++++---------- docs/document/server-side/keyword_add.md | 2 +- docs/document/server-side/keyword_delete.md | 2 +- .../server-side/keyword_delete_batch.md | 2 +- .../server-side/keyword_list_create.md | 2 +- .../server-side/keyword_list_delete.md | 2 +- .../server-side/keyword_list_modify.md | 2 +- .../server-side/keyword_list_query.md | 2 +- docs/document/server-side/keyword_modify.md | 2 +- docs/document/server-side/keyword_query.md | 2 +- .../server-side/message_attachment_storage.md | 4 +- docs/document/server-side/message_chatroom.md | 4 +- docs/document/server-side/message_delete.md | 4 +- docs/document/server-side/message_download.md | 8 ++-- docs/document/server-side/message_group.md | 6 +-- .../server-side/message_historical.md | 4 +- docs/document/server-side/message_import.md | 4 +- docs/document/server-side/message_modify.md | 4 +- docs/document/server-side/message_offline.md | 2 +- docs/document/server-side/message_recall.md | 6 +-- docs/document/server-side/message_single.md | 6 +-- .../server-side/message_translation_detect.md | 2 +- .../message_translation_language_list.md | 2 +- .../server-side/message_translation_text.md | 2 +- docs/document/server-side/presence.md | 2 +- docs/document/server-side/push.md | 8 ++-- docs/document/server-side/push_extension.md | 24 +++++----- .../server-side/push_result_statistics.md | 4 +- docs/document/server-side/reaction.md | 6 +-- docs/document/server-side/user_favorite.md | 4 +- docs/document/server-side/user_global_mute.md | 4 +- .../user_relationship_blocklist_add.md | 4 +- .../user_relationship_blocklist_check.md | 2 +- .../user_relationship_blocklist_obtain.md | 2 +- .../user_relationship_blocklist_remove.md | 4 +- .../user_relationship_friend_add.md | 4 +- .../user_relationship_friend_check.md | 4 +- .../user_relationship_friend_import.md | 2 +- .../user_relationship_friend_list_obtain.md | 2 +- .../user_relationship_friend_list_paged.md | 2 +- .../user_relationship_friend_remove.md | 4 +- .../user_relationship_friend_remove_all.md | 4 +- .../user_relationship_remark_set.md | 2 +- docs/document/server-side/userprofile.md | 4 +- docs/document/unity/conversation_list.md | 2 +- docs/document/unity/initialization.md | 2 +- docs/document/unity/login.md | 2 +- docs/document/unity/message_recall.md | 2 +- docs/document/unity/message_receipt.md | 2 +- docs/document/unity/message_translation.md | 2 +- docs/document/unity/moderation.md | 14 +++--- docs/document/unity/overview.md | 2 +- docs/document/unity/thread_message.md | 2 +- docs/document/unity/user_relationship.md | 2 +- docs/document/web/conversation_list.md | 2 +- docs/document/web/initialization.md | 2 +- docs/document/web/message_recall.md | 2 +- docs/document/web/message_receipt.md | 2 +- docs/document/web/message_send.md | 2 +- docs/document/web/message_translation.md | 2 +- docs/document/web/moderation.md | 14 +++--- .../web/push/push_notification_mode_dnd.md | 2 +- docs/document/web/push/push_overview.md | 6 +-- docs/document/web/push/push_template.md | 4 +- docs/document/web/user_relationship.md | 2 +- docs/document/windows/conversation_list.md | 2 +- docs/document/windows/initialization.md | 2 +- docs/document/windows/login.md | 2 +- docs/document/windows/message_recall.md | 2 +- docs/document/windows/message_receipt.md | 2 +- docs/document/windows/message_translation.md | 2 +- docs/document/windows/moderation.md | 18 ++++---- docs/document/windows/overview.md | 2 +- docs/document/windows/user_relationship.md | 2 +- docs/product/aigc/aigc_rest_api.md | 4 +- .../aigc/aigc_run_through_demo_server.md | 8 ++-- docs/product/aigc/aigc_selection.md | 4 +- docs/product/aigc/aigc_use.md | 6 +-- docs/product/circle/category_mgmt_rest.md | 2 +- docs/product/circle/channel_mgmt_rest.md | 2 +- docs/product/circle/server_mgmt_rest.md | 2 +- docs/product/conversation_function.md | 10 ++--- docs/product/easemob_app_token.md | 16 +++---- docs/product/easemob_user_token.md | 2 +- docs/product/enable_and_configure_IM.md | 44 +++++++++---------- docs/product/faq_integration_issues.md | 2 +- docs/product/faq_quality_issues.md | 10 ++--- docs/product/limitation.md | 4 +- docs/product/message_single_chat.md | 4 +- docs/product/product_function.md | 8 ++-- docs/product/product_message_format.md | 20 ++++----- docs/product/product_offline_push_overview.md | 10 ++--- .../product_user_registration_login.md | 6 +-- .../client_implementation_android.md | 2 +- .../voiceroom/client_implementation_ios.md | 2 +- docs/push/push_by_tag.md | 4 +- docs/push/push_send_notification.md | 2 +- .../android/roomuikit_best_practice.md | 2 +- .../android/roomuikit_quickstart.md | 4 +- .../flutter/roomuikit_best_practice.md | 2 +- .../flutter/roomuikit_quickstart.md | 2 +- .../chatroomuikit/ios/roomuikit_quickstart.md | 4 +- .../react-native/roomuikit_best_practice.md | 2 +- .../react-native/roomuikit_config_item.md | 2 +- .../react-native/roomuikit_run.md | 2 +- .../uikit/chatuikit/android/chatuikit_chat.md | 2 +- .../chatuikit/ios/chatuikit_advancedusage.md | 2 +- .../chatuikit/ios/chatuikit_custom_chat.md | 4 +- .../chatuikit/ios/chatuikit_quickstart.md | 4 +- docs/uikit/chatuikit/ios/chatuikit_run.md | 2 +- .../chatuikit/web/chatuikit_quickstart.md | 2 +- 215 files changed, 482 insertions(+), 482 deletions(-) diff --git a/docs/README.md b/docs/README.md index 34bc6aeee..130810b53 100644 --- a/docs/README.md +++ b/docs/README.md @@ -590,7 +590,7 @@ projects: text: Windows link: /document/windows/message_pin.html - text: 消息审核（举报） - desc: 你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在环信即时通讯云控制台展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 + desc: 你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在环信控制台展示。你可在环信控制台查看举报记录，并进行相应处理。 sdks: - icon: /sdk/android.svg text: Android diff --git a/docs/document/android/conversation_list.md b/docs/document/android/conversation_list.md index 0a5e88486..389f1e7de 100644 --- a/docs/document/android/conversation_list.md +++ b/docs/document/android/conversation_list.md @@ -33,7 +33,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.0.3。而且，只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `asyncFilterConversationsFromDB`、`getAllConversationsBySort` 或 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/android/initialization.md b/docs/document/android/initialization.md index 213cc106d..79ba74f71 100644 --- a/docs/document/android/initialization.md +++ b/docs/document/android/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/android/login.md b/docs/document/android/login.md index 43ba402c8..1d66de187 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#开放注册单个用户)开放注册用户。 示例代码如下所示： @@ -25,7 +25,7 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 +测试环境下，你在[环信控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（4.15.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token，例如，每次登录时更新 token。 @@ -130,4 +130,4 @@ EMClient.getInstance().logout(true, new EMCallBack() { ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/android/message_recall.md b/docs/document/android/message_recall.md index 13a445c39..4a8f82e61 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 f93d3ee3e..c43f473ac 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/message_translation.md b/docs/document/android/message_translation.md index 6a2ffa857..b288b58c9 100644 --- a/docs/document/android/message_translation.md +++ b/docs/document/android/message_translation.md @@ -13,7 +13,7 @@ 1. 完成 `3.9.1 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供，因此开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/android/moderation.md b/docs/document/android/moderation.md index 42e89d17d..c18321fb2 100644 --- a/docs/document/android/moderation.md +++ b/docs/document/android/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -22,7 +22,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -50,9 +50,9 @@ EMClient.getInstance().chatManager().asyncReportMessage(msgid, tag, reason, new | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `msgid` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) diff --git a/docs/document/android/push/push_display.md b/docs/document/android/push/push_display.md index 0b6888eb7..736167b26 100644 --- a/docs/document/android/push/push_display.md +++ b/docs/document/android/push/push_display.md @@ -64,7 +64,7 @@ EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle(); 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/console/push_template.html)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/console/push_template.html)。 使用推送模板有以下优势： diff --git a/docs/document/android/push/push_fcm.md b/docs/document/android/push/push_fcm.md index 69de86318..5f17e11ba 100644 --- a/docs/document/android/push/push_fcm.md +++ b/docs/document/android/push/push_fcm.md @@ -44,7 +44,7 @@ ### **步骤三 上传推送证书** -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书，选择你的应用 > **即时通讯** > **功能配置** > **消息推送** > **证书管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)上传推送证书，选择你的应用 > **即时通讯** > **功能配置** > **消息推送** > **证书管理**。 ![image](/images/android/push/fcm_certificate_v1.png) @@ -239,7 +239,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 44262af4f..d6a5ec5b8 100644 --- a/docs/document/android/push/push_honor.md +++ b/docs/document/android/push/push_honor.md @@ -6,9 +6,9 @@ 详见[荣耀推送官网说明](https://developer.honor.com/cn/docs/11002/guides/kit-history)。 -## **步骤二 在环信即时通讯云控制台上传荣耀推送证书** +## **步骤二 在环信控制台上传荣耀推送证书** -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 @@ -194,7 +194,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_huawei.md b/docs/document/android/push/push_huawei.md index 2bdfc89ec..d277c1064 100644 --- a/docs/document/android/push/push_huawei.md +++ b/docs/document/android/push/push_huawei.md @@ -8,11 +8,11 @@ 详见华为官方介绍：[华为 HMS 消息推送服务集成](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section19884105518498)。 -## **步骤二 在环信即时通讯云控制台上传推送证书** +## **步骤二 在环信控制台上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传华为推送证书。 +在[环信控制台](https://console.easemob.com/user/login)上传华为推送证书。 -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 diff --git a/docs/document/android/push/push_meizu.md b/docs/document/android/push/push_meizu.md index ef96379ea..73f9eb663 100644 --- a/docs/document/android/push/push_meizu.md +++ b/docs/document/android/push/push_meizu.md @@ -8,9 +8,9 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传魅族推送证书。 +在[环信控制台](https://console.easemob.com/user/login)上传魅族推送证书。 -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 diff --git a/docs/document/android/push/push_notification_mode_dnd.md b/docs/document/android/push/push_notification_mode_dnd.md index d5678fd2a..cc85f2f00 100644 --- a/docs/document/android/push/push_notification_mode_dnd.md +++ b/docs/document/android/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 环信即时通讯 IM 3.9.2 及以上版本对离线消息推送进行了优化。你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/android/push/push_android_enable_push.png) diff --git a/docs/document/android/push/push_oppo.md b/docs/document/android/push/push_oppo.md index 31077a967..bcf1193b1 100644 --- a/docs/document/android/push/push_oppo.md +++ b/docs/document/android/push/push_oppo.md @@ -8,9 +8,9 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传 OPPO 推送证书。 +在[环信控制台](https://console.easemob.com/user/login)上传 OPPO 推送证书。 -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 diff --git a/docs/document/android/push/push_overview.md b/docs/document/android/push/push_overview.md index fcd4d9e3d..ebc519272 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 不会发送离线推送通知：** @@ -52,7 +52,7 @@ 9. 第三方推送服务器将消息发送给用户 B。 :::tip -1. 开发者通过[环信即时通讯云控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 +1. 开发者通过[环信控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 2. 推送 token（device token） 是 FCM 推送提供的推送 token，即初次启动你的应用时，FCM SDK 为客户端应用实例生成的注册令牌 (registration token)。该 token 用于标识每台设备上的每个应用，FCM 通过该 token 明确消息是发送给哪个设备的，然后将消息转发给设备，设备再通知应用程序。你可以调用 `FirebaseMessaging.getInstance().getToken()` 方法获得 token。另外，如果退出即时通讯 IM 登录时不解绑 device token（调用 `logout` 方法时对 `unbindToken` 参数传 `false` 时不解绑 device token，传 `true` 表示解绑 token），用户在推送证书有效期和 token 有效期内仍会接收到离线推送通知。 ::: @@ -74,7 +74,7 @@ SDK 内部会按照以上顺序检测设备的推送支持情况。如果未设 **如果你的 App 有海外使用场景，建议开启 FCM 推送；由于各推送使用条件不同，建议尽可能同时支持各家推送。** -5. 使用消息推送前，需要你在对应的厂商推送服务上注册项目，并将设备的推送证书上传到[环信即时通讯云控制台](https://console.easemob.com/user/login)。 +5. 使用消息推送前，需要你在对应的厂商推送服务上注册项目，并将设备的推送证书上传到[环信控制台](https://console.easemob.com/user/login)。 ## 配置推送接口 diff --git a/docs/document/android/push/push_solution.md b/docs/document/android/push/push_solution.md index c7b2bd9ab..26698aba4 100644 --- a/docs/document/android/push/push_solution.md +++ b/docs/document/android/push/push_solution.md @@ -20,7 +20,7 @@ 4. 查看推送证书是否存和证书推送测试。 -在[环信即时通讯控制台](https://console.easemob.com) 的 **即时通讯** > **功能配置** > **消息推送** > **证书管理**页面选择要测试的推送证书（用户绑定的推送证书），选择 **更多** > **测试**。 +在[环信控制台](https://console.easemob.com) 的 **即时通讯** > **功能配置** > **消息推送** > **证书管理**页面选择要测试的推送证书（用户绑定的推送证书），选择 **更多** > **测试**。 ![image](/images/android/push/push_notification_test.png) diff --git a/docs/document/android/push/push_vivo.md b/docs/document/android/push/push_vivo.md index 625baa5c2..03608e3cb 100644 --- a/docs/document/android/push/push_vivo.md +++ b/docs/document/android/push/push_vivo.md @@ -10,9 +10,9 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书： +在[环信控制台](https://console.easemob.com/user/login)上传推送证书： -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 diff --git a/docs/document/android/push/push_xiaomi.md b/docs/document/android/push/push_xiaomi.md index 6d418b317..d5c4164fc 100644 --- a/docs/document/android/push/push_xiaomi.md +++ b/docs/document/android/push/push_xiaomi.md @@ -8,9 +8,9 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书： +在[环信控制台](https://console.easemob.com/user/login)上传推送证书： -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 diff --git a/docs/document/android/quickstart.md b/docs/document/android/quickstart.md index 828f11544..5733ec0d5 100644 --- a/docs/document/android/quickstart.md +++ b/docs/document/android/quickstart.md @@ -17,7 +17,7 @@ - targetVersion 33 及以上 - Android SDK API 21 及以上 - JDK 17 及以上 -- 有效的环信即时通讯 IM 开发者账号和 App key，见 [环信即时通讯云控制台](https://console.easemob.com/user/login)。 +- 有效的环信即时通讯 IM 开发者账号和 App key，见 [环信控制台](https://console.easemob.com/user/login)。 ## 准备开发环境 diff --git a/docs/document/applet/initialization.md b/docs/document/applet/initialization.md index fcb40cba9..ad0dcc5e8 100644 --- a/docs/document/applet/initialization.md +++ b/docs/document/applet/initialization.md @@ -4,7 +4,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## SDK 初始化 @@ -22,7 +22,7 @@ const conn = new EC.connection({ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------------------------- | -| `appKey` | String | 是 | 环信即时通讯云控制台为你的应用生成的唯一标识，由应用名称（`Appname`）和组织名称（`Orgname`）组成。 | +| `appKey` | String | 是 | 环信控制台为你的应用生成的唯一标识，由应用名称（`Appname`）和组织名称（`Orgname`）组成。 | | `isHttpDNS` | Bool | 否 | 是否开启 DNS，防止 DNS 劫持。
-（默认）`true`：开启 DNS；
- `false`：关闭 DNS。 | | `delivery` | Bool | 否 | 是否开启送达回执：
- `true`：开启；
-（默认）`false`：关闭。 | | `enableReportLogs` | Bool | 否 | 小程序平台是否允许上传日志：
- `true`：开启；
-（默认）`false`：关闭。 | diff --git a/docs/document/applet/login.md b/docs/document/applet/login.md index 2f969ed7d..65fa16eb3 100644 --- a/docs/document/applet/login.md +++ b/docs/document/applet/login.md @@ -18,7 +18,7 @@ 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 +测试环境下，你在[环信控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（4.15.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token，例如，每次登录时更新 token。 diff --git a/docs/document/applet/push/push_overview.md b/docs/document/applet/push/push_overview.md index 45fe702a4..531f9b31b 100644 --- a/docs/document/applet/push/push_overview.md +++ b/docs/document/applet/push/push_overview.md @@ -16,7 +16,7 @@ **多设备离线推送策略** -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -39,6 +39,6 @@ - 设置推送模板。 - 设置推送扩展功能：包括强制推送和发送静默消息。 -其中，**推送高级功能包括设置推送通知方式、免打扰模式和自定义推送模板**。使用前，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +其中，**推送高级功能包括设置推送通知方式、免打扰模式和自定义推送模板**。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/web/push_web_enable_push.png) diff --git a/docs/document/applet/push/uniapp_push.md b/docs/document/applet/push/uniapp_push.md index e624617ac..5f9c6fac8 100644 --- a/docs/document/applet/push/uniapp_push.md +++ b/docs/document/applet/push/uniapp_push.md @@ -8,7 +8,7 @@ 1. 在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 2. 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -3. 你已在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。高级功能激活后，你可以设置推送通知方式、免打扰模式和自定义推送模板。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +3. 你已在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。高级功能激活后，你可以设置推送通知方式、免打扰模式和自定义推送模板。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** 4. 各推送使用的条件： - 小米推送：在小米设备上可用； - 华为推送：在华为设备上可用； @@ -23,11 +23,11 @@ ## 实现流程 -### 步骤一 上传推送证书至环信即时通讯控制台 +### 步骤一 上传推送证书至环信控制台 1. 在第三方推送服务后台注册应用，获取应用信息，开启推送服务。 -2. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置获取到的应用信息，上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 +2. 在[环信控制台](https://console.easemob.com/user/login)配置获取到的应用信息，上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 :::tip 更多详情，参见 [Android 离线推送](/document/android/push/push_fcm.html)和 [APNs 离线推送](/document/ios/push/push_apns.html)。 @@ -169,7 +169,7 @@ onLaunch(() => { 2. 即时通讯 IM 是否支持多设备离线推送？ -你可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置多设备推送策略。该策略配置对所有推送通道生效： +你可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置多设备推送策略。该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 diff --git a/docs/document/flutter/conversation_list.md b/docs/document/flutter/conversation_list.md index 66a1b6d62..3726126d2 100644 --- a/docs/document/flutter/conversation_list.md +++ b/docs/document/flutter/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表) ，并将 SDK 升级至 V4.5.0 或以上版本。只有开通该功能，你才能使用置顶会话功能。** 2. 建议在 app 安装时或本地没有会话时调用该方法，否则调用 `loadAllConversations` 获取本地会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/flutter/initialization.md b/docs/document/flutter/initialization.md index e0bb8c7ab..c99a00e70 100644 --- a/docs/document/flutter/initialization.md +++ b/docs/document/flutter/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/flutter/login.md b/docs/document/flutter/login.md index 636c71fce..e0a6f97be 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) 创建用户： @@ -18,7 +18,7 @@ 1. **用户 ID + token** 是更加安全的登录方式。token 可以通过调用 REST API 获取。 详见 [环信用户 token 的获取](/document/server-side/easemob_user_token.html)。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 +测试环境下，你在[环信控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 @@ -84,4 +84,4 @@ try { ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/flutter/message_recall.md b/docs/document/flutter/message_recall.md index 352a9ef63..53b071f3a 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 fdf06bb70..1d48cd5e2 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/message_translation.md b/docs/document/flutter/message_translation.md index 8246a44cf..4eeead206 100644 --- a/docs/document/flutter/message_translation.md +++ b/docs/document/flutter/message_translation.md @@ -13,7 +13,7 @@ 1. 完成 `1.0.5 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供，因此开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/flutter/moderation.md b/docs/document/flutter/moderation.md index 584cb14f5..499ab64d4 100644 --- a/docs/document/flutter/moderation.md +++ b/docs/document/flutter/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -44,9 +44,9 @@ try { | 参数 | 类型 | 是否必需 | | :--------- | :----- | :------- | | `messageId` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) \ No newline at end of file diff --git a/docs/document/flutter/overview.md b/docs/document/flutter/overview.md index d73b76f55..dfae22d95 100644 --- a/docs/document/flutter/overview.md +++ b/docs/document/flutter/overview.md @@ -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_display.md b/docs/document/flutter/push/push_display.md index b2b9c3675..8156a5d60 100644 --- a/docs/document/flutter/push/push_display.md +++ b/docs/document/flutter/push/push_display.md @@ -64,7 +64,7 @@ try { 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 使用推送模板有以下优势： @@ -79,7 +79,7 @@ try { - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 :::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +1. 设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 ::: @@ -127,7 +127,7 @@ try { } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/flutter/push/push_easemob_console.md b/docs/document/flutter/push/push_easemob_console.md index d4c239ab5..8e853021b 100644 --- a/docs/document/flutter/push/push_easemob_console.md +++ b/docs/document/flutter/push/push_easemob_console.md @@ -1,23 +1,23 @@ # 上传推送证书及绑定推送信息 -1. 除了满足用户离线条件外，要使用第三方离线推送，你还需在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置推送证书信息，例如，对于 FCM 推送，需配置**证书类型**和**证书名称**，上传证书，并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 +1. 除了满足用户离线条件外，要使用第三方离线推送，你还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息，例如，对于 FCM 推送，需配置**证书类型**和**证书名称**，上传证书，并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 2. 从第三方服务获取推送 token 后，将你的用户 ID 与推送证书和推送 token `deviceToken` 进行绑定。 ## 上传推送证书 -在第三方推送服务后台注册应用，获取应用信息，开启推送服务后，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 +在第三方推送服务后台注册应用，获取应用信息，开启推送服务后，你需要在[环信控制台](https://console.easemob.com/user/login)上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 ![img](/images/react-native/push/push_add_certificate.png) -关于各推送证书相关信息以及[环信即时通讯云控制台](https://console.easemob.com/user/login)上的推送证书参数描述，详见下表中 [iOS 离线推送文档](/document/ios/push/push_overview.html)和 [Android 离线推送文档](/document/android/push/push_overview.html)中的相关链接。 +关于各推送证书相关信息以及[环信控制台](https://console.easemob.com/user/login)上的推送证书参数描述，详见下表中 [iOS 离线推送文档](/document/ios/push/push_overview.html)和 [Android 离线推送文档](/document/android/push/push_overview.html)中的相关链接。 -| 推送服务类型 | 在推送厂商后台获取推送证书信息 | 在环信即时通讯控制台上传推送证书 | +| 推送服务类型 | 在推送厂商后台获取推送证书信息 | 在环信控制台上传推送证书 | | :--------- | :----- | :------- | | APNs 推送 | 详见 [iOS 端 APNs 推送集成文档](/document/ios/push/push_apns.html#创建推送证书)。 | 详见 [iOS 端 APNs 推送文档](/document/ios/push/push_apns.html#上传推送证书)。 | | FCM 推送 | 详见 [Android 端 FCM 推送集成文档](/document/android/push/push_fcm.html#fcm-推送集成)。 | 详见 [Android 端 FCM 推送集成文档](/document/android/push/push_fcm.html#步骤三-上传推送证书)。 | -| 华为推送 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤一-在华为开发者后台创建应用)。 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤二-在环信即时通讯云控制台上传推送证书)。 | -| 荣耀推送 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤一-在荣耀开发者服务平台创建应用并申请开通推送服务)。 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤二-在环信即时通讯云控制台上传荣耀推送证书)。 | +| 华为推送 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤一-在华为开发者后台创建应用)。 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤二-在环信控制台上传推送证书)。 | +| 荣耀推送 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤一-在荣耀开发者服务平台创建应用并申请开通推送服务)。 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤二-在环信控制台上传荣耀推送证书)。 | | OPPO 推送 | 详见 [Android 端 OPPO 推送集成文档](/document/android/push/push_oppo.html#步骤一-在-oppo-开发者后台创建应用)。 | 详见 [Android 端 OPPO 推送集成文档](/document/android/push/push_oppo.html#步骤二-上传推送证书)。 | | vivo 推送 | 详见 [Android 端 vivo 推送集成文档](/document/android/push/push_vivo.html#步骤一-在-vivo-开发者后台创建应用)。 | 详见 [Android 端 vivo 推送集成文档](/document/android/push/push_vivo.html#步骤二-上传推送证书)。 | | 小米推送 | 详见 [Android 端小米推送集成文档](/document/android/push/push_xiaomi.html#步骤一-在小米开放平台创建应用)。 | 详见 [Android 端小米推送集成文档](/document/android/push/push_xiaomi.html#步骤二-上传推送证书)。 | diff --git a/docs/document/flutter/push/push_notification_mode_dnd.md b/docs/document/flutter/push/push_notification_mode_dnd.md index 263fc9ee7..108ad7362 100644 --- a/docs/document/flutter/push/push_notification_mode_dnd.md +++ b/docs/document/flutter/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 为优化用户在处理大量推送通知时的体验，即时通讯 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/android/push/push_android_enable_push.png) diff --git a/docs/document/flutter/push/push_overview.md b/docs/document/flutter/push/push_overview.md index 336e85e82..b9fb97d02 100644 --- a/docs/document/flutter/push/push_overview.md +++ b/docs/document/flutter/push/push_overview.md @@ -14,11 +14,11 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -46,7 +46,7 @@ 9. 第三方推送服务器将消息发送给用户 B。 :::tip -1. 开发者通过[环信即时通讯云控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 +1. 开发者通过[环信控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 2. 关于推送 token，详见[绑定推送信息页面相关描述](push_easemob_console.html#绑定推送信息)。 ::: @@ -69,7 +69,7 @@ 1. 已开启即时通讯 IM ，详见[开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 2. 了解即时通讯 IM 套餐包中的 API 调用频率限制，详见[使用限制](/product/limitation.html)。 -3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 +3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信控制台](https://console.easemob.com/user/login)上激活。 4. 各推送使用的条件： - APNs：在苹果设备上可用； - Google FCM：设备启用了 Google Play 服务且可连接至 Google 服务器； diff --git a/docs/document/flutter/quickstart.md b/docs/document/flutter/quickstart.md index a6d848831..d771704e6 100644 --- a/docs/document/flutter/quickstart.md +++ b/docs/document/flutter/quickstart.md @@ -27,7 +27,7 @@ 配置开发或者运行环境如果遇到问题，请参考 [这里](https://docs.flutter.dev/get-started/install)。 -- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信即时通讯云控制台](https://console.easemob.com/user/login)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台](https://console.easemob.com/user/login)。 ## 项目设置 diff --git a/docs/document/flutter/thread.md b/docs/document/flutter/thread.md index 33d6e57f2..9761fabd4 100644 --- a/docs/document/flutter/thread.md +++ b/docs/document/flutter/thread.md @@ -27,7 +27,7 @@ - 完成 `1.0.5 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 - 了解子区和子区成员数量限制，详见 [使用限制](/product/limitation.html)。 -- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。 +- 已在[环信控制台](https://console.easemob.com/user/login)开通子区功能。 ## 实现方法 diff --git a/docs/document/flutter/thread_message.md b/docs/document/flutter/thread_message.md index eb0f6ef4b..a1f91a7f4 100644 --- a/docs/document/flutter/thread_message.md +++ b/docs/document/flutter/thread_message.md @@ -2,7 +2,7 @@ -子区消息消息类型属于群聊消息类型，与普通群组消息的区别是需要添加 `isChatThread` 标记。使用子区消息功能前，你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 +子区消息消息类型属于群聊消息类型，与普通群组消息的区别是需要添加 `isChatThread` 标记。使用子区消息功能前，你需要在[环信控制台](https://console.easemob.com/user/login)开通。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 本文介绍即时通讯 IM Flutter SDK 如何发送、接收以及撤回子区消息。 @@ -24,7 +24,7 @@ - 已集成 `1.0.5 或版本` SDK 的基本功能，完成 SDK 初始化，详见 [快速开始](quickstart.html)。 - 了解即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。 +- 已在[环信控制台](https://console.easemob.com/user/login)开通子区功能。 ## 实现方法 diff --git a/docs/document/flutter/user_relationship.md b/docs/document/flutter/user_relationship.md index 835afb212..a0b6641fb 100644 --- a/docs/document/flutter/user_relationship.md +++ b/docs/document/flutter/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/harmonyos/conversation_list.md b/docs/document/harmonyos/conversation_list.md index 1ca848685..751d964d1 100644 --- a/docs/document/harmonyos/conversation_list.md +++ b/docs/document/harmonyos/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表) 。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `getAllConversationsBySort`、`getConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/harmonyos/initialization.md b/docs/document/harmonyos/initialization.md index eceb7ba68..71580a6ee 100644 --- a/docs/document/harmonyos/initialization.md +++ b/docs/document/harmonyos/initialization.md @@ -6,7 +6,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/harmonyos/login.md b/docs/document/harmonyos/login.md index cd711faa6..0792cafdc 100644 --- a/docs/document/harmonyos/login.md +++ b/docs/document/harmonyos/login.md @@ -6,19 +6,19 @@ 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) 创建用户： -可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 **用户 ID + token** 是更加安全的登录方式。 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 +测试环境下，你在[环信控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%（1.8.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire`。 @@ -88,4 +88,4 @@ ChatClient.getInstance().logout().then(()=> { ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/harmonyos/message_recall.md b/docs/document/harmonyos/message_recall.md index b441dfd08..b51a0d286 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 633aec32f..0f37a3c2f 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/overview.md b/docs/document/harmonyos/overview.md index da2a24c1f..289e883af 100644 --- a/docs/document/harmonyos/overview.md +++ b/docs/document/harmonyos/overview.md @@ -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_display.md b/docs/document/harmonyos/push/push_display.md index 5964d1a3f..6463646d2 100644 --- a/docs/document/harmonyos/push/push_display.md +++ b/docs/document/harmonyos/push/push_display.md @@ -42,7 +42,7 @@ ChatClient.getInstance().pushManager()?.updatePushDisplayStyle(displayStyle).the 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 使用推送模板有以下优势： @@ -62,7 +62,7 @@ ChatClient.getInstance().pushManager()?.updatePushDisplayStyle(displayStyle).the 4. 发送消息时通过消息扩展字段指定模板名称。 :::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +1. 设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 ::: @@ -123,7 +123,7 @@ if (message) { } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/harmonyos/push/push_harmony.md b/docs/document/harmonyos/push/push_harmony.md index cc70efe33..3640aa1c7 100644 --- a/docs/document/harmonyos/push/push_harmony.md +++ b/docs/document/harmonyos/push/push_harmony.md @@ -20,7 +20,7 @@ ## 步骤二 上传推送证书 -注册完成后，需要在环信即时通讯云控制台上传推送证书，选择你的应用 > **即时通讯** > **功能配置** > **消息推送** > **证书管理**。点击 **添加推送证书**，在 **添加推送证书** 窗口选择 **鸿蒙** 页签，然后设置推送证书相关参数。 +注册完成后，需要在环信控制台上传推送证书，选择你的应用 > **即时通讯** > **功能配置** > **消息推送** > **证书管理**。点击 **添加推送证书**，在 **添加推送证书** 窗口选择 **鸿蒙** 页签，然后设置推送证书相关参数。 :::tip 该步骤须在登录环信 IM SDK 成功后进行。 diff --git a/docs/document/harmonyos/push/push_notification_mode_dnd.md b/docs/document/harmonyos/push/push_notification_mode_dnd.md index 21bc61953..6552c96a6 100644 --- a/docs/document/harmonyos/push/push_notification_mode_dnd.md +++ b/docs/document/harmonyos/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 环信即时通讯 IM 支持你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/android/push/push_android_enable_push.png) diff --git a/docs/document/harmonyos/push/push_overview.md b/docs/document/harmonyos/push/push_overview.md index d80687cec..c98212842 100644 --- a/docs/document/harmonyos/push/push_overview.md +++ b/docs/document/harmonyos/push/push_overview.md @@ -10,7 +10,7 @@ 客户端断开连接或应用进程被关闭等原因导致用户离线时，即时通讯 IM 会通过第三方消息推送服务向该离线用户的设备推送消息通知。当用户再次上线时，服务器会将离线期间的消息发送给用户（这里角标表示的是离线消息数，并不是实际的未读消息数）。例如，当你离线时，有用户向你发送了消息，你的手机的通知中心会弹出消息通知，当你再次打开 app 并登录成功，即时通讯 IM SDK 会主动拉取你不在线时的消息。 -除了满足用户离线条件外，要使用 HarmonyOS 离线推送，用户还需在[环信即时通讯云控制台](https://console.easemob.com/user/login)配置推送证书信息，并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 +除了满足用户离线条件外，要使用 HarmonyOS 离线推送，用户还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息，并调用客户端 SDK 提供的 API 向环信服务器上传 device token。 **以下两种情况，即时通讯 IM 不会发送离线推送通知：** @@ -20,11 +20,11 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -52,7 +52,7 @@ - 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 - 确保已经在 [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html) 网站开通开通推送服务。 -- 检查并提醒用户允许接收通知消息，并将设备的推送证书上传到[环信即时通讯云控制台](https://console.easemob.com/user/login)。 -- 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 +- 检查并提醒用户允许接收通知消息，并将设备的推送证书上传到[环信控制台](https://console.easemob.com/user/login)。 +- 若使用[推送高级功能](#离线推送高级功能)，需在[环信控制台](https://console.easemob.com/user/login)上激活。 diff --git a/docs/document/harmonyos/quickstart.md b/docs/document/harmonyos/quickstart.md index 786eefaed..563ad587a 100644 --- a/docs/document/harmonyos/quickstart.md +++ b/docs/document/harmonyos/quickstart.md @@ -15,7 +15,7 @@ - DevEco Studio NEXT Release（5.0.3.900）及以上； - HarmonyOS SDK API 12 及以上； -- 有效的环信即时通讯 IM 开发者账号和 App key，见 [环信即时通讯云控制台](https://console.easemob.com/user/login)。 +- 有效的环信即时通讯 IM 开发者账号和 App key，见 [环信控制台](https://console.easemob.com/user/login)。 ## 准备开发环境 diff --git a/docs/document/harmonyos/user_relationship.md b/docs/document/harmonyos/user_relationship.md index 947936cf2..f2234a07c 100644 --- a/docs/document/harmonyos/user_relationship.md +++ b/docs/document/harmonyos/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/ios/conversation_list.md b/docs/document/ios/conversation_list.md index 620213bcd..9973a6bae 100644 --- a/docs/document/ios/conversation_list.md +++ b/docs/document/ios/conversation_list.md @@ -33,7 +33,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.0.3。只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `filterConversationsFromDB`、`getAllConversations:` 或 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/ios/initialization.md b/docs/document/ios/initialization.md index c548c239d..7b74ec921 100644 --- a/docs/document/ios/initialization.md +++ b/docs/document/ios/initialization.md @@ -6,7 +6,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/ios/login.md b/docs/document/ios/login.md index dc0d161ee..29cce3c51 100644 --- a/docs/document/ios/login.md +++ b/docs/document/ios/login.md @@ -6,13 +6,13 @@ 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) 创建用户： -可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建用户，详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 主动登录 @@ -109,4 +109,4 @@ EMClient.shared().logout(true) { aError in ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/ios/message_recall.md b/docs/document/ios/message_recall.md index 3606da4d3..6dff31daf 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 cba36306b..e3385aed0 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/message_translation.md b/docs/document/ios/message_translation.md index 0dfa0a3d8..34c4984fb 100644 --- a/docs/document/ios/message_translation.md +++ b/docs/document/ios/message_translation.md @@ -18,7 +18,7 @@ 1. 完成 `3.9.1 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的[使用限制](/product/limitation.html)。 -3. 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通翻译功能。 +3. 已在[环信控制台](https://console.easemob.com/user/login)开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供，因此开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 如下为按需翻译示例： diff --git a/docs/document/ios/moderation.md b/docs/document/ios/moderation.md index 9d2081110..0b926dd8c 100644 --- a/docs/document/ios/moderation.md +++ b/docs/document/ios/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -40,9 +40,9 @@ | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `msgid` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) \ No newline at end of file diff --git a/docs/document/ios/push/push_apns.md b/docs/document/ios/push/push_apns.md index 3bf735954..48caca040 100644 --- a/docs/document/ios/push/push_apns.md +++ b/docs/document/ios/push/push_apns.md @@ -110,9 +110,9 @@ ## **上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传 APNs 推送证书。 +在[环信控制台](https://console.easemob.com/user/login)上传 APNs 推送证书。 -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 +1. 在[环信控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 @@ -198,7 +198,7 @@ DeviceToken 注册后，iOS 系统会通过以下方式将 DeviceToken 回调给 2. 杀掉应用进程。 -3. 在[环信即时通讯控制台](https://console.easemob.com/user/login)发送测试消息。 +3. 在[环信控制台](https://console.easemob.com/user/login)发送测试消息。 在左侧导航栏中选择 **即时通讯** > **运营服务** > **用户管理**。在**用户管理**页面中，在对应用户 ID 的**操作**栏中点击**更多**，然后选择**发送rest消息**。在弹出的对话框中选择消息类型，输入消息内容，然后点击**发送**。 @@ -214,7 +214,7 @@ DeviceToken 注册后，iOS 系统会通过以下方式将 DeviceToken 回调给 在左侧导航栏中选择**运营服务** > **用户管理**。在**用户管理**页面中，在对应用户 ID 的**操作**栏中选择**查看IM用户绑定推送证书**。在弹出框中查看是否正确显示了证书名称和 device token。 -2. 检查是否在[环信即时通讯控制台](https://console.easemob.com/user/login)上传了正确的 APNs 证书且设置了正确的证书环境。 +2. 检查是否在[环信控制台](https://console.easemob.com/user/login)上传了正确的 APNs 证书且设置了正确的证书环境。 3. 检查是否在聊天室中推送消息。聊天室不支持离线消息推送。 diff --git a/docs/document/ios/push/push_display.md b/docs/document/ios/push/push_display.md index 8036bbf96..d4e28fa5c 100644 --- a/docs/document/ios/push/push_display.md +++ b/docs/document/ios/push/push_display.md @@ -80,7 +80,7 @@ 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 使用推送模板有以下优势： @@ -95,7 +95,7 @@ - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 :::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +1. 设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 ::: @@ -146,7 +146,7 @@ message.chatType = EMChatTypeChat; } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/ios/push/push_notification_mode_dnd.md b/docs/document/ios/push/push_notification_mode_dnd.md index fa198510f..47bab5bde 100644 --- a/docs/document/ios/push/push_notification_mode_dnd.md +++ b/docs/document/ios/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 环信即时通讯 IM 3.9.2 及以上版本对离线消息推送进行了优化。你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -推送通知方式和免打扰模式为推送的高级功能，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +推送通知方式和免打扰模式为推送的高级功能，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/ios/push/push_ios_27_enable_push.png) diff --git a/docs/document/ios/push/push_overview.md b/docs/document/ios/push/push_overview.md index 53e45405b..2543e531f 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 不会发送离线推送通知：** @@ -18,11 +18,11 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -56,4 +56,4 @@ - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](/document/ios/quickstart.html)。 - 了解环信即时通讯 IM API 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 \ No newline at end of file +- 若使用[推送高级功能](#离线推送高级功能)，需在[环信控制台](https://console.easemob.com/user/login)上激活。 \ No newline at end of file diff --git a/docs/document/ios/push/push_solution.md b/docs/document/ios/push/push_solution.md index 661f25bae..586fc1635 100644 --- a/docs/document/ios/push/push_solution.md +++ b/docs/document/ios/push/push_solution.md @@ -20,7 +20,7 @@ 4. 查看推送证书是否存和证书推送测试。 -在[环信即时通讯控制台](https://console.easemob.com) 的 **即时通讯** > **功能配置** > **消息推送** > **证书管理**页面选择要测试的推送证书（用户绑定的推送证书），选择 **更多** > **测试**。 +在[环信控制台](https://console.easemob.com) 的 **即时通讯** > **功能配置** > **消息推送** > **证书管理**页面选择要测试的推送证书（用户绑定的推送证书），选择 **更多** > **测试**。 ![image](/images/android/push/push_notification_test.png) diff --git a/docs/document/ios/user_relationship.md b/docs/document/ios/user_relationship.md index cf03025e0..372c8fc7a 100644 --- a/docs/document/ios/user_relationship.md +++ b/docs/document/ios/user_relationship.md @@ -12,7 +12,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 黑名单管理：查询黑名单列表、将添加用户至黑名单以及从黑名单中移出用户等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/react-native/conversation_list.md b/docs/document/react-native/conversation_list.md index 93baf0f06..9b2ba0065 100644 --- a/docs/document/react-native/conversation_list.md +++ b/docs/document/react-native/conversation_list.md @@ -31,7 +31,7 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 1.2.0 或以上版本。而且，只有开通该功能，你才能使用置顶会话功能。** 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `getAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/react-native/initialization.md b/docs/document/react-native/initialization.md index d9d4fa58c..71ad9fcfd 100644 --- a/docs/document/react-native/initialization.md +++ b/docs/document/react-native/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/react-native/login.md b/docs/document/react-native/login.md index 103827ac4..3d4297733 100644 --- a/docs/document/react-native/login.md +++ b/docs/document/react-native/login.md @@ -16,7 +16,7 @@ ## 主动登录 -测试环境下，你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 +测试环境下，你在[环信控制台](https://console.easemob.com/user/login)创建用户后，环信服务器会自动为这些用户分配用户 Token，详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。 在生产环境中，为了安全考虑，你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑，使你的用户从你的应用服务器获取 Token。 @@ -87,4 +87,4 @@ ChatClient.getInstance() ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK 会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK 会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/react-native/message_recall.md b/docs/document/react-native/message_recall.md index a98b27bb9..5c665ae89 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 2f1a259cd..1fe9e042a 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/message_translation.md b/docs/document/react-native/message_translation.md index 5b563582d..5a61d3f16 100644 --- a/docs/document/react-native/message_translation.md +++ b/docs/document/react-native/message_translation.md @@ -13,7 +13,7 @@ 1. 完成 SDK 初始化，详见 [初始化](initialization.html)文档。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供，因此开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/react-native/moderation.md b/docs/document/react-native/moderation.md index 20e4d98a7..07c8c02eb 100644 --- a/docs/document/react-native/moderation.md +++ b/docs/document/react-native/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -21,7 +21,7 @@ 1. 完成 SDK 初始化，详见 [初始化](initialization.html)文档。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +3. 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 ## 实现方法 @@ -43,9 +43,9 @@ ChatClient.getInstance() | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `msgId` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) \ No newline at end of file diff --git a/docs/document/react-native/overview.md b/docs/document/react-native/overview.md index 07a09b6e5..ba7d7a956 100644 --- a/docs/document/react-native/overview.md +++ b/docs/document/react-native/overview.md @@ -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_display.md b/docs/document/react-native/push/push_display.md index 0876798fe..74eca50f0 100644 --- a/docs/document/react-native/push/push_display.md +++ b/docs/document/react-native/push/push_display.md @@ -70,7 +70,7 @@ ChatClient.getInstance() 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 使用推送模板有以下优势： @@ -85,7 +85,7 @@ ChatClient.getInstance() - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 :::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +1. 设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 ::: @@ -138,7 +138,7 @@ ChatClient.getInstance().chatManager.sendMessage(message, { } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/react-native/push/push_easemob_console.md b/docs/document/react-native/push/push_easemob_console.md index bf479e362..18e6019d5 100644 --- a/docs/document/react-native/push/push_easemob_console.md +++ b/docs/document/react-native/push/push_easemob_console.md @@ -1,17 +1,17 @@ -# 在环信即时通讯控制台上传推送证书 +# 在环信控制台上传推送证书 -在第三方推送服务后台注册应用，获取应用信息，开启推送服务后，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 +在第三方推送服务后台注册应用，获取应用信息，开启推送服务后，你需要在[环信控制台](https://console.easemob.com/user/login)上传推送证书，实现第三方推送服务与环信即时通讯 IM 的通信。 ![img](/images/react-native/push/push_add_certificate.png) -关于各推送证书相关信息以及[环信即时通讯云控制台](https://console.easemob.com/user/login)上的推送证书参数描述，详见下表中 [iOS 离线推送文档](/document/ios/push/push_overview.html)和 [Android 离线推送文档](/document/android/push/push_overview.html)中的相关链接。 +关于各推送证书相关信息以及[环信控制台](https://console.easemob.com/user/login)上的推送证书参数描述，详见下表中 [iOS 离线推送文档](/document/ios/push/push_overview.html)和 [Android 离线推送文档](/document/android/push/push_overview.html)中的相关链接。 -| 推送服务类型 | 在推送厂商后台获取推送证书信息 | 在环信即时通讯控制台上传推送证书 | +| 推送服务类型 | 在推送厂商后台获取推送证书信息 | 在环信控制台上传推送证书 | | :--------- | :----- | :------- | | APNs 推送 | 详见 [iOS 端 APNs 推送集成文档](/document/ios/push/push_apns.html#创建推送证书)。 | 详见 [iOS 端 APNs 推送文档](/document/ios/push/push_apns.html#上传推送证书)。 | | FCM 推送 | 详见 [Android 端 FCM 推送集成文档](/document/android/push/push_fcm.html#fcm-推送集成)。 | 详见 [Android 端 FCM 推送集成文档](/document/android/push/push_fcm.html#步骤三-上传推送证书)。 | -| 华为推送 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤一-在华为开发者后台创建应用)。 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤二-在环信即时通讯云控制台上传推送证书)。 | -| 荣耀推送 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤一-在荣耀开发者服务平台创建应用并申请开通推送服务)。 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤二-在环信即时通讯云控制台上传荣耀推送证书)。 | +| 华为推送 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤一-在华为开发者后台创建应用)。 | 详见 [Android 端华为推送集成文档](/document/android/push/push_huawei.html#步骤二-在环信控制台上传推送证书)。 | +| 荣耀推送 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤一-在荣耀开发者服务平台创建应用并申请开通推送服务)。 | 详见 [Android 端荣耀推送集成文档](/document/android/push/push_honor.html#步骤二-在环信控制台上传荣耀推送证书)。 | | OPPO 推送 | 详见 [Android 端 OPPO 推送集成文档](/document/android/push/push_oppo.html#步骤一-在-oppo-开发者后台创建应用)。 | 详见 [Android 端 OPPO 推送集成文档](/document/android/push/push_oppo.html#步骤二-上传推送证书)。 | | vivo 推送 | 详见 [Android 端 vivo 推送集成文档](/document/android/push/push_vivo.html#步骤一-在-vivo-开发者后台创建应用)。 | 详见 [Android 端 vivo 推送集成文档](/document/android/push/push_vivo.html#步骤二-上传推送证书)。 | | 小米推送 | 详见 [Android 端小米推送集成文档](/document/android/push/push_xiaomi.html#步骤一-在小米开放平台创建应用)。 | 详见 [Android 端小米推送集成文档](/document/android/push/push_xiaomi.html#步骤二-上传推送证书)。 | diff --git a/docs/document/react-native/push/push_notification_mode_dnd.md b/docs/document/react-native/push/push_notification_mode_dnd.md index 4bec3b2c4..2a4091b82 100644 --- a/docs/document/react-native/push/push_notification_mode_dnd.md +++ b/docs/document/react-native/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 为优化用户在处理大量推送通知时的体验，环信即时通讯 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ![image](/images/android/push/push_android_enable_push.png) diff --git a/docs/document/react-native/push/push_overview.md b/docs/document/react-native/push/push_overview.md index d71410669..daec490a8 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 不会发送离线推送通知：** @@ -18,11 +18,11 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -50,7 +50,7 @@ 9. 第三方推送服务器将消息发送给用户 B。 :::tip -1. 开发者通过[环信即时通讯云控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 +1. 开发者通过[环信控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key）。该步骤须在登录环信 IM SDK 成功后进行。证书名称是环信服务器用于判断目标设备使用哪种推送通道的唯一条件，因此必须确保与 Android 终端设备上传的证书名称一致。 2. 关于获取和发送推送 token（device token），详见[获取或更新推送 token](push_get_device_token.html)和[发送推送 token 到服务器端](push_send_token_to_server.html)。 ::: @@ -77,7 +77,7 @@ 1. 在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 2. 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 +3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信控制台](https://console.easemob.com/user/login)上激活。 4. 各推送使用的条件： - APNs：在苹果设备上可用； - Google FCM：设备启用了 Google Play 服务且可连接至 Google 服务器； 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 a9b3ff9c8..1fb50bdae 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 @@ -14,9 +14,9 @@ yarn add react-native-chat-sdk ### 步骤二 获取推送证书信息 -从[环信即时通讯云控制台](https://console.easemob.com/user/login)获取推送证书信息，配置应用的 App Key（`appKey`）和推送证书名称（`pushId`）信息。 +从[环信控制台](https://console.easemob.com/user/login)获取推送证书信息，配置应用的 App Key（`appKey`）和推送证书名称（`pushId`）信息。 -- `appKey`：在[环信即时通讯云控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 +- `appKey`：在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看。 - `pushId`：推送证书名称。不同厂商的推送证书名称也不同。 ![img](/images/react-native/push/push_get_appkey.png) @@ -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/thread_message.md b/docs/document/react-native/thread_message.md index e3d168e3c..73996d9a0 100644 --- a/docs/document/react-native/thread_message.md +++ b/docs/document/react-native/thread_message.md @@ -24,7 +24,7 @@ - 已集成 `1.0.5 或以上版本` SDK 的基本功能，完成 SDK 初始化，详见 [初始化](initialization.html)文档。 - 了解即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 +- 已在[环信控制台](https://console.easemob.com/user/login)开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 ## 实现方法 diff --git a/docs/document/react-native/user_relationship.md b/docs/document/react-native/user_relationship.md index ac81029f8..478e01941 100644 --- a/docs/document/react-native/user_relationship.md +++ b/docs/document/react-native/user_relationship.md @@ -9,7 +9,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信即时通讯云控制台](https://console.easemob.com/user/login) [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在 [环信控制台](https://console.easemob.com/user/login) [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md index 6515618c8..ed4b103ce 100644 --- a/docs/document/server-side/account_system.md +++ b/docs/document/server-side/account_system.md @@ -14,7 +14,7 @@ | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -23,7 +23,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON Array | 响应实体。 | diff --git a/docs/document/server-side/callback_overview.md b/docs/document/server-side/callback_overview.md index 8a4dd1fcc..7053f3446 100644 --- a/docs/document/server-side/callback_overview.md +++ b/docs/document/server-side/callback_overview.md @@ -42,7 +42,7 @@ - 回调 ID：回调请求体中的 `callId` 参数。 - - 环信服务器为回调规则生成的 secret：你可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**消息回调**页面的回调规则列表中查看。 + - 环信服务器为回调规则生成的 secret：你可以在[环信控制台](https://console.easemob.com/user/login)的**消息回调**页面的回调规则列表中查看。 ![img](/images/product/callback_secret.png) diff --git a/docs/document/server-side/chatroom_attribute.md b/docs/document/server-side/chatroom_attribute.md index 1215ef587..022b3e688 100644 --- a/docs/document/server-side/chatroom_attribute.md +++ b/docs/document/server-side/chatroom_attribute.md @@ -22,7 +22,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | @@ -37,7 +37,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_label_mute.md b/docs/document/server-side/chatroom_label_mute.md index f60b08f78..47a95fab1 100644 --- a/docs/document/server-side/chatroom_label_mute.md +++ b/docs/document/server-side/chatroom_label_mute.md @@ -20,7 +20,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -32,7 +32,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_manage.md b/docs/document/server-side/chatroom_manage.md index 626ae5bd0..7994c22ee 100644 --- a/docs/document/server-side/chatroom_manage.md +++ b/docs/document/server-side/chatroom_manage.md @@ -24,7 +24,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | @@ -39,7 +39,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_member_add_delete.md b/docs/document/server-side/chatroom_member_add_delete.md index 6a2554874..f78ea2ac1 100644 --- a/docs/document/server-side/chatroom_member_add_delete.md +++ b/docs/document/server-side/chatroom_member_add_delete.md @@ -20,7 +20,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 @@ -31,7 +31,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/chatroom_member_admin.md b/docs/document/server-side/chatroom_member_admin.md index 088747e76..c14e78ee4 100644 --- a/docs/document/server-side/chatroom_member_admin.md +++ b/docs/document/server-side/chatroom_member_admin.md @@ -28,7 +28,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 @@ -39,7 +39,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_member_allowlist.md b/docs/document/server-side/chatroom_member_allowlist.md index 4b8125ddb..1bac37c93 100644 --- a/docs/document/server-side/chatroom_member_allowlist.md +++ b/docs/document/server-side/chatroom_member_allowlist.md @@ -28,7 +28,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 @@ -39,7 +39,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_member_blocklist.md b/docs/document/server-side/chatroom_member_blocklist.md index b321f9881..53b98cbd8 100644 --- a/docs/document/server-side/chatroom_member_blocklist.md +++ b/docs/document/server-side/chatroom_member_blocklist.md @@ -22,7 +22,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 响应参数 @@ -33,7 +33,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_member_mutelist.md b/docs/document/server-side/chatroom_member_mutelist.md index 2010cc6d3..af506d24f 100644 --- a/docs/document/server-side/chatroom_member_mutelist.md +++ b/docs/document/server-side/chatroom_member_mutelist.md @@ -20,7 +20,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -32,7 +32,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/chatroom_member_obtain.md b/docs/document/server-side/chatroom_member_obtain.md index 406f79d29..1d37864bd 100644 --- a/docs/document/server-side/chatroom_member_obtain.md +++ b/docs/document/server-side/chatroom_member_obtain.md @@ -48,7 +48,7 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?pagenum={ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | #### 查询参数 @@ -85,7 +85,7 @@ GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?pagenum={ | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `count` | Number | 本次调用实际获取的聊天室成员数量。 | 其他字段及描述详见 [公共参数](#公共参数)。 diff --git a/docs/document/server-side/chatroom_superadmin.md b/docs/document/server-side/chatroom_superadmin.md index ce735be1b..86eff14b8 100644 --- a/docs/document/server-side/chatroom_superadmin.md +++ b/docs/document/server-side/chatroom_superadmin.md @@ -19,7 +19,7 @@ | :------------ | :----- | :------- | :---------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `chatroom_id` | String | 是 | 聊天室 ID。 | | `username` | String | 是 | 用户 ID。 | | `name` | String | 是 | 聊天室名称，最大长度为 128 个字符。 | @@ -34,7 +34,7 @@ | `host` | String | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名，与请求参数 `host` 相同。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `id` | String | 聊天室 ID，聊天室唯一标识，由环信即时通讯 IM 服务器生成。 | diff --git a/docs/document/server-side/conversation_delete.md b/docs/document/server-side/conversation_delete.md index 778b4bdc6..0e14abc26 100644 --- a/docs/document/server-side/conversation_delete.md +++ b/docs/document/server-side/conversation_delete.md @@ -33,7 +33,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/user_channel | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 要删除会话的用户的唯一标识符，即用户 ID。 | #### 请求 header @@ -68,7 +68,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/user_channel | `data` | JSON | 删除结果详情。 | | `data.result` | String | 删除结果，`ok` 表示成功，失败则直接返回错误码和原因。 | | `duration` | Int | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 diff --git a/docs/document/server-side/easemob_user_token_password.md b/docs/document/server-side/easemob_user_token_password.md index bd2de9c9c..2a8b1c70b 100644 --- a/docs/document/server-side/easemob_user_token_password.md +++ b/docs/document/server-side/easemob_user_token_password.md @@ -32,7 +32,7 @@ POST https://{host}/{org_name}/{app_name}/token | :------------- | :----- | :------- | :--------------------- | | `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| #### 请求 header diff --git a/docs/document/server-side/error.md b/docs/document/server-side/error.md index e9a63db7c..2556040e3 100644 --- a/docs/document/server-side/error.md +++ b/docs/document/server-side/error.md @@ -80,12 +80,12 @@ | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | | :---------- | :---------- | :--------- | :----------- | -| 403 | group_error | thread not open. | 子区功能未开通。 | 请在环信即时通讯控制台开通子区服务。 | +| 403 | group_error | thread not open. | 子区功能未开通。 | 请在环信控制台开通子区服务。 | | 403 | forbidden_op | message broadcast service is unopened | 未开通发送聊天室广播消息的功能配置。| 联系商务开通。 | | 400 | service open exception | this appKey not open message roaming | 消息漫游服务未开通。 | 联系商务开通。 | | 400 | service open exception | the app not open presence | 没有开通 presence 服务。 | 联系商务开通 presence 服务。 | | 403 | message_rewrite_error | The rewrite message feature is not open. | 消息修改功能未开通。 | 联系商务开通消息修改功能。 | -| 400 | Bad Request | this appKey is not open reaction service! | Reaction 功能未开通。 | 请在环信即时通讯控制台开通 Reaction 服务。 | +| 400 | Bad Request | this appKey is not open reaction service! | Reaction 功能未开通。 | 请在环信控制台开通 Reaction 服务。 | | 403 | FORBIDDEN | {appkey} user metadata service not allow | 用户属性功能未开通。 | 联系商务开通用户属性功能。 | diff --git a/docs/document/server-side/group_file.md b/docs/document/server-side/group_file.md index 51d509b31..fa7ed2700 100644 --- a/docs/document/server-side/group_file.md +++ b/docs/document/server-side/group_file.md @@ -18,7 +18,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -29,7 +29,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_manage.md b/docs/document/server-side/group_manage.md index 7942558aa..18085a2a4 100644 --- a/docs/document/server-side/group_manage.md +++ b/docs/document/server-side/group_manage.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -31,7 +31,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON Array | 响应实体。 | diff --git a/docs/document/server-side/group_member_add_delete.md b/docs/document/server-side/group_member_add_delete.md index 1495023cf..397d1ef9c 100644 --- a/docs/document/server-side/group_member_add_delete.md +++ b/docs/document/server-side/group_member_add_delete.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -31,7 +31,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_admin.md b/docs/document/server-side/group_member_admin.md index 577513ca3..b860d46c4 100644 --- a/docs/document/server-side/group_member_admin.md +++ b/docs/document/server-side/group_member_admin.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | #### 响应参数 @@ -30,7 +30,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_allowlist.md b/docs/document/server-side/group_member_allowlist.md index 22a3ded97..fa3d3062b 100644 --- a/docs/document/server-side/group_member_allowlist.md +++ b/docs/document/server-side/group_member_allowlist.md @@ -26,7 +26,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -37,7 +37,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_attribute.md b/docs/document/server-side/group_member_attribute.md index a56b0b387..5d97597fa 100644 --- a/docs/document/server-side/group_member_attribute.md +++ b/docs/document/server-side/group_member_attribute.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -31,7 +31,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_blocklist.md b/docs/document/server-side/group_member_blocklist.md index 525e671b6..70822976a 100644 --- a/docs/document/server-side/group_member_blocklist.md +++ b/docs/document/server-side/group_member_blocklist.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -31,7 +31,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_mutelist.md b/docs/document/server-side/group_member_mutelist.md index 5314a2bc8..fc909cd2c 100644 --- a/docs/document/server-side/group_member_mutelist.md +++ b/docs/document/server-side/group_member_mutelist.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -31,7 +31,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/group_member_obtain.md b/docs/document/server-side/group_member_obtain.md index dbb065a5f..e51ec9516 100644 --- a/docs/document/server-side/group_member_obtain.md +++ b/docs/document/server-side/group_member_obtain.md @@ -48,7 +48,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N} | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | #### 查询参数 @@ -88,7 +88,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N} | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `count` | Int | 本次调用实际获取的群成员数量。 | 其他字段及描述详见 [公共参数](#公共参数)。 diff --git a/docs/document/server-side/group_thread.md b/docs/document/server-side/group_thread.md index f2ebc28cb..4446f9b74 100644 --- a/docs/document/server-side/group_thread.md +++ b/docs/document/server-side/group_thread.md @@ -1,6 +1,6 @@ # 子区管理 -环信即时通讯 IM 提供多个接口实现子区管理，包括子区的创建、获取、修改和删除等。使用子区功能前，你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通。 +环信即时通讯 IM 提供多个接口实现子区管理，包括子区的创建、获取、修改和删除等。使用子区功能前，你需要在[环信控制台](https://console.easemob.com/user/login)开通。 单个 app 下的子区总数默认为 10 万，如需调整请联系商务。 @@ -11,7 +11,7 @@ - 已在 [环信控制台](https://console.easemob.com/user/login) [注册账号](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 - 了解环信 IM RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 子区相关的限制，详见 [使用限制](limitation.html#子区)。 -- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。 +- 已在[环信控制台](https://console.easemob.com/user/login)开通子区功能。 ## 公共参数 @@ -21,7 +21,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `group_id` | String | 是 | 群组 ID。 | | `username` | String | 是 | 用户 ID。 | @@ -32,7 +32,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | @@ -59,7 +59,7 @@ - 分页获取应用下的子区列表。 - 单个 app 下的子区总数默认为 10 万，如需调整请联系商务。 -- 使用该接口前，你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。 +- 使用该接口前，你需要在[环信控制台](https://console.easemob.com/user/login)开通子区功能。 **调用频率上限**：100 次/秒/App Key @@ -142,7 +142,7 @@ curl -X GET https://XXXX/XXXX/XXXX/thread -H 'Authorization: Bearer - `success`：成功；
- `failed`：失败。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 响应字段及说明详见 [公共参数](#公共参数)。 diff --git a/docs/document/server-side/message_chatroom.md b/docs/document/server-side/message_chatroom.md index cf5dbfbf7..4520f1c00 100644 --- a/docs/document/server-side/message_chatroom.md +++ b/docs/document/server-side/message_chatroom.md @@ -142,7 +142,7 @@ | :--------- | :----- | :------- | :----------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -151,7 +151,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_delete.md b/docs/document/server-side/message_delete.md index b18bee63e..d06a38a5d 100644 --- a/docs/document/server-side/message_delete.md +++ b/docs/document/server-side/message_delete.md @@ -23,7 +23,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -32,7 +32,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_download.md b/docs/document/server-side/message_download.md index 136da313f..22b6b4307 100644 --- a/docs/document/server-side/message_download.md +++ b/docs/document/server-side/message_download.md @@ -19,7 +19,7 @@ | :--------- | :----- | :------- | :----------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -28,7 +28,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | @@ -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_group.md b/docs/document/server-side/message_group.md index 99647aa63..753fc676e 100644 --- a/docs/document/server-side/message_group.md +++ b/docs/document/server-side/message_group.md @@ -55,7 +55,7 @@ - 群组中发送的消息均同步给发送方。 - 你可以只将消息发送给在线用户，若群组中的用户离线则无法收到消息（`routetype` 参数）。 - 你可以设置哪些用户拉漫游消息时拉不到该消息（`roam_ignore_users` 参数）。 -- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 - 调用该接口会触发发送后回调事件，请查看 [回调事件文档](callback_message_send.html#发送群组消息)。 - [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 @@ -137,7 +137,7 @@ | :--------- | :----- | :------- | :----------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -146,7 +146,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_historical.md b/docs/document/server-side/message_historical.md index ad6bc5e0c..1a0ef35a1 100644 --- a/docs/document/server-side/message_historical.md +++ b/docs/document/server-side/message_historical.md @@ -28,7 +28,7 @@ | :--------- | :----- | :------- | :------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| ### 响应参数 @@ -37,7 +37,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_import.md b/docs/document/server-side/message_import.md index 0a5d5c1d7..fd4b430d1 100644 --- a/docs/document/server-side/message_import.md +++ b/docs/document/server-side/message_import.md @@ -26,7 +26,7 @@ | :--------- | :----- | :------- | :----------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -35,7 +35,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `entities` | JSON | 响应实体。 | diff --git a/docs/document/server-side/message_modify.md b/docs/document/server-side/message_modify.md index b753885be..6e75797d3 100644 --- a/docs/document/server-side/message_modify.md +++ b/docs/document/server-side/message_modify.md @@ -55,7 +55,7 @@ PUT https://{host}/{org_name}/{app_name}/messages/rewrite/{msg_id} | :--------- | :----- | :------- | :----------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `msg_id` | String| 是 | 要修改的消息的 ID。| ### 请求 header @@ -95,7 +95,7 @@ PUT https://{host}/{org_name}/{app_name}/messages/rewrite/{msg_id} | `action` | String | 请求方法。 | | `data` | String | 值为 `success`，表示消息成功修改。| | `duration` | Int | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [响应状态码](error.html) 了解可能的原因。 diff --git a/docs/document/server-side/message_offline.md b/docs/document/server-side/message_offline.md index 538206ae0..a26188544 100644 --- a/docs/document/server-side/message_offline.md +++ b/docs/document/server-side/message_offline.md @@ -12,7 +12,7 @@ | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 diff --git a/docs/document/server-side/message_recall.md b/docs/document/server-side/message_recall.md index db5a278db..89a3e3cb3 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。 @@ -34,7 +34,7 @@ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -43,7 +43,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_single.md b/docs/document/server-side/message_single.md index 3faf0f114..44388f117 100644 --- a/docs/document/server-side/message_single.md +++ b/docs/document/server-side/message_single.md @@ -57,7 +57,7 @@ - 你可以设置消息发送成功后，是否将消息同步到发送方的所有在线设备（`sync_device` 参数）。 - 你可以设置哪些用户拉漫游消息时拉不到该消息（`roam_ignore_users` 参数）。 - 你可以只将消息发送给在线用户，离线用户则无法收到消息（`routetype`）。 -- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +- 通过 RESTful 接口发送的消息默认不写入会话列表，若需要此类消息写入会话列表，需在 [环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 - 调用该接口会触发发送后回调事件，请参见 [回调事件文档](callback_message_send.html#发送单聊消息)。 - [内容审核服务会关注消息 body 中指定字段的内容，不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 @@ -141,7 +141,7 @@ | :--------- | :----- | :------- | :----------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -150,7 +150,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | diff --git a/docs/document/server-side/message_translation_detect.md b/docs/document/server-side/message_translation_detect.md index ef2400200..8384dcfb3 100644 --- a/docs/document/server-side/message_translation_detect.md +++ b/docs/document/server-side/message_translation_detect.md @@ -36,7 +36,7 @@ POST https://{host}/{org_name}/{app_name}/translate/detect | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/message_translation_language_list.md b/docs/document/server-side/message_translation_language_list.md index 50cb06983..7028050b9 100644 --- a/docs/document/server-side/message_translation_language_list.md +++ b/docs/document/server-side/message_translation_language_list.md @@ -36,7 +36,7 @@ GET https://{host}/{org_name}/{app_name}/translate/support/language | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/message_translation_text.md b/docs/document/server-side/message_translation_text.md index 2ce5464d9..dd1eaa820 100644 --- a/docs/document/server-side/message_translation_text.md +++ b/docs/document/server-side/message_translation_text.md @@ -41,7 +41,7 @@ POST https://{host}/{org_name}/{app_name}/translate | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/presence.md b/docs/document/server-side/presence.md index 2cef9f3a5..366c24599 100644 --- a/docs/document/server-side/presence.md +++ b/docs/document/server-side/presence.md @@ -30,7 +30,7 @@ | :------------ | :----- | :------ | :---------------- | | `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| | `username` | String | 是 |用户在即时通讯服务器上的唯一 ID。 | ## 认证方式 diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index 33fc9cce5..aecf434c3 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -18,7 +18,7 @@ | :--------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 响应参数 @@ -29,7 +29,7 @@ | `application` | String | 环信即时通讯服务分配给每个 app 的唯一内部标识，开发者无需关注。 | | `uri` | String | 请求 URL。 | | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `duration` | Int | 从发送 HTTP 请求到响应的时长，单位为毫秒。 | ## 认证方式 @@ -854,7 +854,7 @@ curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ ## 使用推送模板 -你可以使用推送模板设置推送标题和内容。你可以调用以下 REST API 配置默认推送模板 `default` 和自定义推送模板。除此之外，你也可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](enable_and_configure_IM.html#配置推送模板)。 +你可以使用推送模板设置推送标题和内容。你可以调用以下 REST API 配置默认推送模板 `default` 和自定义推送模板。除此之外，你也可以在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](enable_and_configure_IM.html#配置推送模板)。 对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 @@ -880,7 +880,7 @@ curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ #### 功能说明 -创建离线推送消息模板，包括默认模板 `default` 和自定模板。你可以通过[环信即时通讯云控制台](https://console.easemob.com/user/login)创建推送模板，详见[控制台文档](enable_and_configure_IM.html#配置推送模板)。 +创建离线推送消息模板，包括默认模板 `default` 和自定模板。你可以通过[环信控制台](https://console.easemob.com/user/login)创建推送模板，详见[控制台文档](enable_and_configure_IM.html#配置推送模板)。 若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 diff --git a/docs/document/server-side/push_extension.md b/docs/document/server-side/push_extension.md index 87714e0d8..592a3eaf9 100644 --- a/docs/document/server-side/push_extension.md +++ b/docs/document/server-side/push_extension.md @@ -77,24 +77,24 @@ | ------------------------- | ------- | ------------------------------------------------------------ | | `fcm_options` | Object | FCM SDK 功能选项。 | | `fcm_channel_id` | String | FCM 推送通道（最高优先级）。 | -| `honor_click_action` | String | 荣耀点击跳转，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **荣耀** 页面设置的 **Action** 参数的配置。 | +| `honor_click_action` | String | 荣耀点击跳转，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **荣耀** 页面设置的 **Action** 参数的配置。 | | `honor_importance` | String | 荣耀推送优先级：
- `LOW`：低优先级；
- （默认）`NORMAL`：普通优先级。 | | `honor_target_user_type` | Integer | 推送用户类型：
- `0`：普通
- `1`：测试 | | `huawei_target_user_type` | Integer | 推送用户类型：
- `0`：普通
- `1`：测试 | -| `huawei_category` | String | 完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)后，用于标识消息类型，确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718)，对特定类型消息加快发送，取值如下：[华为官方文档中category字段的解释](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/https-send-api-0000001050986197#section13271045101216)。该参数的设置优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Category** 参数的配置。 | +| `huawei_category` | String | 完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)后，用于标识消息类型，确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718)，对特定类型消息加快发送，取值如下：[华为官方文档中category字段的解释](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/https-send-api-0000001050986197#section13271045101216)。该参数的设置优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Category** 参数的配置。 | | `huawei_receipt_id` | String | 华为回执地址 ID。 | -| `huawei_click_action` | String | 华为点击跳转 action，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Action** 参数的配置。 | +| `huawei_click_action` | String | 华为点击跳转 action，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Action** 参数的配置。 | | `huawei_channel_id` | String | 华为推送通道（最高优先级）。 | -| `meizu_click_activity` | String | 魅族点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **魅族** 页面设置的 **Activity** 参数的配置。 | +| `meizu_click_activity` | String | 魅族点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **魅族** 页面设置的 **Activity** 参数的配置。 | | `meizu_notice_type` | Int | 通道类型：
- `0`：公信通道
- `1`：私信通道 | -| `oppo_channel_id` | String | OPPO 推送通道（最高优先级），优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | -| `oppo_click_activity` | String | OPPO 点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | -| `oppo_category` | String | 通道类别名，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Category** 参数的配置。 | -| `oppo_notify_level` | String | 通知栏消息提醒等级取值定义，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **NotifyLevel** 参数的配置。
- `1`：通知栏
- `2`：通知栏+锁屏
- `16`：通知栏+锁屏+横幅+震动+铃声
使用 `notify_level` 参数时，`oppo_category` 参数必传。| -| `vivo_category` | String | vivo 二级分类配置，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Category** 参数的配置。 | -| `vivo_click_activity` | String | vivo 点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Activity** 参数的配置。 | -| `xiaomi_channel_id` | String | 小米通道 ID，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Channel ID** 参数的配置。 | -| `xiaomi_click_action` | String | 小米点击跳转 action，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Action** 参数的配置。 | +| `oppo_channel_id` | String | OPPO 推送通道（最高优先级），优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | +| `oppo_click_activity` | String | OPPO 点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | +| `oppo_category` | String | 通道类别名，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Category** 参数的配置。 | +| `oppo_notify_level` | String | 通知栏消息提醒等级取值定义，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **NotifyLevel** 参数的配置。
- `1`：通知栏
- `2`：通知栏+锁屏
- `16`：通知栏+锁屏+横幅+震动+铃声
使用 `notify_level` 参数时，`oppo_category` 参数必传。| +| `vivo_category` | String | vivo 二级分类配置，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Category** 参数的配置。 | +| `vivo_click_activity` | String | vivo 点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Activity** 参数的配置。 | +| `xiaomi_channel_id` | String | 小米通道 ID，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Channel ID** 参数的配置。 | +| `xiaomi_click_action` | String | 小米点击跳转 action，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Action** 参数的配置。 | `em_harmony_push_ext` 结构如下： diff --git a/docs/document/server-side/push_result_statistics.md b/docs/document/server-side/push_result_statistics.md index 2f28ca1ae..20b7cb05f 100644 --- a/docs/document/server-side/push_result_statistics.md +++ b/docs/document/server-side/push_result_statistics.md @@ -6,7 +6,7 @@ 你可以通过以下方式查询离线推送的结果： -- 在[环信即时通讯控制台](https://console.easemob.com/user/login)上查看 IM 消息投递查询： +- 在[环信控制台](https://console.easemob.com/user/login)上查看 IM 消息投递查询： - 在 **应用列表** 中点击目标应用的 **操作** 栏中的 **管理** 按钮，进入 **应用详情** 页面。 - 选择 **即时通讯 > 实时查询 > IM消息投递查询**，查看推送结果记录，如下图所示： @@ -34,7 +34,7 @@ GET https://{host}/{org_name}/{app_name}/push/data/offline-push/begin/{startTime | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `startTime` | String | 是 | 查询数据的开始时间，格式为 yyyy-MM-dd，例如，`2024-04-01`。 | | `endTime` | String | 是 | 查询数据的结束时间，格式为 yyyy-MM-dd，例如，`2024-04-02`。 | diff --git a/docs/document/server-side/reaction.md b/docs/document/server-side/reaction.md index 993c49bae..8350fb757 100644 --- a/docs/document/server-side/reaction.md +++ b/docs/document/server-side/reaction.md @@ -26,7 +26,7 @@ | :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ## 认证方式 @@ -131,7 +131,7 @@ curl -g -X POST 'https://localhost:8089/easemob-demo/easeim/reaction/user/e1' -H | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 | |:---------|:--------------------|:-----------|:----------|:------------| -| 400 | Bad Request | this appKey is not open reaction service! | Reaction 功能未开通。 | 请在环信即时通讯控制台开通 Reaction 服务。 | +| 400 | Bad Request | this appKey is not open reaction service! | Reaction 功能未开通。 | 请在环信控制台开通 Reaction 服务。 | | 400 | Bad Request | The quantity has exceeded the limit! | 一条消息上的 Reaction 数量达到上限。| 每条消息默认可添加 20 个 Reaction。若需提升该上限，需联系环信商务。| | 400 | Bad Request | the user operation is illegal! | 不是会话双方。 | 只有会话双方才能操作 Reaction。 | | 400 | Bad Request | the user is already operation this message | 同一个用户重复添加相同的 Reaction。 | 同一用户不能重复添加相同的 Reaction。 | @@ -328,7 +328,7 @@ curl -g -X DELETE 'https://localhost:8089/easemob-demo/easeim/reaction/user/wz?m | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 | | :----------- | :--- | :------------- |:-------------------------|:------------| | 400 | Bad Request | the user operation is illegal! | 传入的用户 ID 没有操作过该 Reaction。 | 传入正确的用户 ID。 | -| 400 | Bad Request | this appKey is not open reaction service! | Reaction 服务未开通。 | 请在环信即时通讯控制台开通 Reaction 服务。 | +| 400 | Bad Request | this appKey is not open reaction service! | Reaction 服务未开通。 | 请在环信控制台开通 Reaction 服务。 | 关于其他错误，你可以参考 [响应状态码](error.html) 了解可能的原因。 diff --git a/docs/document/server-side/user_favorite.md b/docs/document/server-side/user_favorite.md index 8505ad844..841bdfc9f 100644 --- a/docs/document/server-side/user_favorite.md +++ b/docs/document/server-side/user_favorite.md @@ -12,7 +12,7 @@ | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -21,7 +21,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `data` | JSON | 实际获取的数据详情。 | diff --git a/docs/document/server-side/user_global_mute.md b/docs/document/server-side/user_global_mute.md index 31f3f4397..1ec27c26f 100644 --- a/docs/document/server-side/user_global_mute.md +++ b/docs/document/server-side/user_global_mute.md @@ -20,7 +20,7 @@ | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 响应参数 @@ -29,7 +29,7 @@ | `action` | String | 请求方法。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 系统内为应用生成的唯一标识，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `uri` | String | 请求 URL。 | | `path` | String | 请求路径，属于请求 URL 的一部分，开发者无需关注。 | | `data` | JSON | 实际获取的数据详情。 | diff --git a/docs/document/server-side/user_relationship_blocklist_add.md b/docs/document/server-side/user_relationship_blocklist_add.md index 25d528b0c..4397c1d79 100644 --- a/docs/document/server-side/user_relationship_blocklist_add.md +++ b/docs/document/server-side/user_relationship_blocklist_add.md @@ -40,7 +40,7 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users | :--------------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 添加到哪个用户的黑名单。 | ### 请求 header @@ -71,7 +71,7 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users | `timestamp` | Long | Unix 时间戳，单位为毫秒。 | | `duration` | String | 请求响应时间，单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_blocklist_check.md b/docs/document/server-side/user_relationship_blocklist_check.md index 352b57486..8800c84b9 100644 --- a/docs/document/server-side/user_relationship_blocklist_check.md +++ b/docs/document/server-side/user_relationship_blocklist_check.md @@ -35,7 +35,7 @@ POST https://{host}/{org_name}/{app_name}/blocks/check | :--------------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | ### 请求 header diff --git a/docs/document/server-side/user_relationship_blocklist_obtain.md b/docs/document/server-side/user_relationship_blocklist_obtain.md index 70f48ac61..f3e49a68b 100644 --- a/docs/document/server-side/user_relationship_blocklist_obtain.md +++ b/docs/document/server-side/user_relationship_blocklist_obtain.md @@ -35,7 +35,7 @@ GET https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users?pag | :--------------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 获取哪个用户的黑名单。 | ### 查询参数 diff --git a/docs/document/server-side/user_relationship_blocklist_remove.md b/docs/document/server-side/user_relationship_blocklist_remove.md index 48752dddf..43239af26 100644 --- a/docs/document/server-side/user_relationship_blocklist_remove.md +++ b/docs/document/server-side/user_relationship_blocklist_remove.md @@ -38,7 +38,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users/ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 从哪个用户的黑名单中移除用户。 | | `blocked_username` | String | 是 | 要移出黑名单的用户 ID。 | @@ -70,7 +70,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users/ | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_friend_add.md b/docs/document/server-side/user_relationship_friend_add.md index 1e30f1ca4..f6af5e0bf 100644 --- a/docs/document/server-side/user_relationship_friend_add.md +++ b/docs/document/server-side/user_relationship_friend_add.md @@ -36,7 +36,7 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/users/ | :--------- | :----- | :------- | :--------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 为哪个用户添加好友。 | | `friend_username` | String | 是 | 要添加的用户 ID。 | @@ -69,7 +69,7 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/users/ | `timestamp` | Long | Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_friend_check.md b/docs/document/server-side/user_relationship_friend_check.md index e25673280..865de9b9d 100644 --- a/docs/document/server-side/user_relationship_friend_check.md +++ b/docs/document/server-side/user_relationship_friend_check.md @@ -33,7 +33,7 @@ POST https://{host}/{org_name}/{app_name}/contacts/check | :--------------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 添加到哪个用户的黑名单。 | ### 请求 header @@ -71,7 +71,7 @@ POST https://{host}/{org_name}/{app_name}/contacts/check | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_friend_import.md b/docs/document/server-side/user_relationship_friend_import.md index 92e2a27d1..d1de286a6 100644 --- a/docs/document/server-side/user_relationship_friend_import.md +++ b/docs/document/server-side/user_relationship_friend_import.md @@ -34,7 +34,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/contacts/import | :---------------- | :----- | :------- |:-------------| | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 为哪个用户导入好友列表。 | ### 请求参数 diff --git a/docs/document/server-side/user_relationship_friend_list_obtain.md b/docs/document/server-side/user_relationship_friend_list_obtain.md index 51fb66c83..4eb280f2c 100644 --- a/docs/document/server-side/user_relationship_friend_list_obtain.md +++ b/docs/document/server-side/user_relationship_friend_list_obtain.md @@ -36,7 +36,7 @@ GET https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/users | :--------------- | :----- | :------- | :------------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 好友列表所有者的用户 ID。 | ### 请求 header diff --git a/docs/document/server-side/user_relationship_friend_list_paged.md b/docs/document/server-side/user_relationship_friend_list_paged.md index 5537bded4..03e0e3b77 100644 --- a/docs/document/server-side/user_relationship_friend_list_paged.md +++ b/docs/document/server-side/user_relationship_friend_list_paged.md @@ -34,7 +34,7 @@ GET https://{host}/{org_name}/{app_name}/user/{username}/contacts?limit={N}&curs | :---------------- | :----- | :------- |:-------------| | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 要获取哪个用户的好友列表。 | ### 查询参数 diff --git a/docs/document/server-side/user_relationship_friend_remove.md b/docs/document/server-side/user_relationship_friend_remove.md index 5dc9c0ed9..55fea8a83 100644 --- a/docs/document/server-side/user_relationship_friend_remove.md +++ b/docs/document/server-side/user_relationship_friend_remove.md @@ -34,7 +34,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/user | :---------------- | :----- | :------- | :-------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 删除哪个用户的好友。 | | `friend_username` | String | 是 | 被删除好友的用户 ID。 | @@ -66,7 +66,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/user | `timestamp` | Long | Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_friend_remove_all.md b/docs/document/server-side/user_relationship_friend_remove_all.md index df8c09a51..ad3237b2e 100644 --- a/docs/document/server-side/user_relationship_friend_remove_all.md +++ b/docs/document/server-side/user_relationship_friend_remove_all.md @@ -36,7 +36,7 @@ DELETE https://{host}/{org_name}/{app_name}/contacts/users/{username} | :--------------- | :----- | :------- | :------------------ | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 要删除该用户 ID 的所有好友。 | 其他参数及描述详见 [公共参数](#公共参数)。 @@ -65,7 +65,7 @@ DELETE https://{host}/{org_name}/{app_name}/contacts/users/{username} | `timestamp` | Long | HTTP 响应的 Unix 时间戳，单位为毫秒。 | | `duration` | Long | 从发送 HTTP 请求到响应的时长, 单位为毫秒。 | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | 如果返回的 HTTP 状态码非 `200`，表示请求失败。你可以参考 [错误码](#错误码) 了解可能的原因。 diff --git a/docs/document/server-side/user_relationship_remark_set.md b/docs/document/server-side/user_relationship_remark_set.md index 075e36ccc..e6e08ee75 100644 --- a/docs/document/server-side/user_relationship_remark_set.md +++ b/docs/document/server-side/user_relationship_remark_set.md @@ -35,7 +35,7 @@ PUT https://{host}/{org_name}/{app_name}/user/{owner_username}/contacts/users/{f | :---------------- | :----- | :------- |:-------------| | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `owner_username` | String | 是 | 要设置哪个用户的好友备注。 | | `friend_username` | String | 是 | 要设置备注的用户 ID。 | diff --git a/docs/document/server-side/userprofile.md b/docs/document/server-side/userprofile.md index a2477915f..112efbffc 100644 --- a/docs/document/server-side/userprofile.md +++ b/docs/document/server-side/userprofile.md @@ -27,7 +27,7 @@ | :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `username` | String | 是 | 用户 ID。 | #### 响应参数 @@ -36,7 +36,7 @@ | :---------------- | :----- | :----------------------------------------------------------------------------- | | `organization` | String | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 `org_name` 相同。 | | `application` | String | 应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。 | -| `applicationName` | String | 你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | +| `applicationName` | String | 你在环信控制台创建应用时填入的应用名称，与请求参数 `app_name` 相同。 | | `entities` | Object | 响应实体。 | | `username` | String | 用户 ID。 | | `data.nickname` | String | 用户昵称。 | diff --git a/docs/document/unity/conversation_list.md b/docs/document/unity/conversation_list.md index a220a897e..d3845d1df 100644 --- a/docs/document/unity/conversation_list.md +++ b/docs/document/unity/conversation_list.md @@ -34,7 +34,7 @@ :::tip 1. 若使用该方法，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 V1.2.0 或以上版本。 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `LoadAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: ```csharp diff --git a/docs/document/unity/initialization.md b/docs/document/unity/initialization.md index 6c6b4cc10..3776e2761 100644 --- a/docs/document/unity/initialization.md +++ b/docs/document/unity/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/unity/login.md b/docs/document/unity/login.md index bd2afd0ee..b6cc5a1f5 100644 --- a/docs/document/unity/login.md +++ b/docs/document/unity/login.md @@ -128,4 +128,4 @@ SDKClient.Instance.Logout(false, ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/unity/message_recall.md b/docs/document/unity/message_recall.md index 7360837a1..0fe8299ea 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 952a55ef5..b2425c7c5 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/message_translation.md b/docs/document/unity/message_translation.md index d1fd5420f..4c71cfe63 100644 --- a/docs/document/unity/message_translation.md +++ b/docs/document/unity/message_translation.md @@ -13,7 +13,7 @@ 1. 完成 `1.0.5 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供。开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/unity/moderation.md b/docs/document/unity/moderation.md index 1dfd08d88..0d34506a0 100644 --- a/docs/document/unity/moderation.md +++ b/docs/document/unity/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -45,9 +45,9 @@ SDKClient.Instance.ChatManager.ReportMessage(msgId, tag, reason, new CallBack( | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `msgId` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) diff --git a/docs/document/unity/overview.md b/docs/document/unity/overview.md index 1680d10c0..5d6f3c098 100644 --- a/docs/document/unity/overview.md +++ b/docs/document/unity/overview.md @@ -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/thread_message.md b/docs/document/unity/thread_message.md index 296e7181a..a563d161a 100644 --- a/docs/document/unity/thread_message.md +++ b/docs/document/unity/thread_message.md @@ -25,7 +25,7 @@ - 已集成环信 IM `(1.0.5 或以上版本)` 的基本功能，账户登录成功。 - 完成 SDK 初始化，详见 [快速开始](quickstart.html)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 -- 已在 [环信即时通讯控制台](https://console.easemob.com/user/login) 开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 +- 已在 [环信控制台](https://console.easemob.com/user/login) 开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)。 ## 实现方法 diff --git a/docs/document/unity/user_relationship.md b/docs/document/unity/user_relationship.md index 10f947027..6ea80521e 100644 --- a/docs/document/unity/user_relationship.md +++ b/docs/document/unity/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/web/conversation_list.md b/docs/document/web/conversation_list.md index 574972435..02f632fb5 100644 --- a/docs/document/web/conversation_list.md +++ b/docs/document/web/conversation_list.md @@ -31,7 +31,7 @@ 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.1.7 或以上版本。而且，只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 登录用户的 ID 大小写混用会导致拉取会话列表时提示会话列表为空，因此建议用户 ID 使用小写字母。 3. 服务端会话列表的更新存在延时，建议你仅在登录时调用该方法。 -4. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +4. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: 示例代码如下： diff --git a/docs/document/web/initialization.md b/docs/document/web/initialization.md index 268692526..7d034c3a0 100644 --- a/docs/document/web/initialization.md +++ b/docs/document/web/initialization.md @@ -4,7 +4,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化参数说明 diff --git a/docs/document/web/message_recall.md b/docs/document/web/message_recall.md index 2b3393396..492166a35 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 352ff4f98..35a8eded8 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 5b78d2bbf..1c507410e 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/message_translation.md b/docs/document/web/message_translation.md index a045e195a..9382157ee 100644 --- a/docs/document/web/message_translation.md +++ b/docs/document/web/message_translation.md @@ -12,7 +12,7 @@ 1. 完成 4.0.4 或以上版本 SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供，因此开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/web/moderation.md b/docs/document/web/moderation.md index bc904dc17..e736a5fe2 100644 --- a/docs/document/web/moderation.md +++ b/docs/document/web/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -40,9 +40,9 @@ connection.reportMessage({ | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `messageId` | String | 要举报的消息 ID。 | -| `reportType` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reportReason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `reportType` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reportReason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) \ No newline at end of file diff --git a/docs/document/web/push/push_notification_mode_dnd.md b/docs/document/web/push/push_notification_mode_dnd.md index 2ca034b2d..3c1a74d6b 100644 --- a/docs/document/web/push/push_notification_mode_dnd.md +++ b/docs/document/web/push/push_notification_mode_dnd.md @@ -2,7 +2,7 @@ 为优化用户在处理大量推送通知时的体验，环信 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 +**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 ## 推送通知方式 diff --git a/docs/document/web/push/push_overview.md b/docs/document/web/push/push_overview.md index 29564b72f..5de42455c 100644 --- a/docs/document/web/push/push_overview.md +++ b/docs/document/web/push/push_overview.md @@ -16,11 +16,11 @@ ## 离线推送高级功能 -如果需要离线推送的高级功能，需在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +如果需要离线推送的高级功能，需在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活。高级功能包括[推送通知方式](push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](push_notification_mode_dnd.html#免打扰模式)和[推送模板](push_display.html#使用推送模板)。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ## 多设备离线推送策略 -多设备登录时，可在[环信即时通讯控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在[环信控制台](https://console.easemob.com/user/login)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -31,7 +31,7 @@ ## 上传推送证书 -除了满足用户离线条件外，要使用第三方离线推送，用户还需在[环信即时通讯控制台](https://console.easemob.com/user/login)配置推送证书信息，详见 [Android 推送](/document/android/push/push_fcm.html)和 [APNs 推送](/document/ios/push/push_apns.html)文档中各厂商证书配置描述。 +除了满足用户离线条件外，要使用第三方离线推送，用户还需在[环信控制台](https://console.easemob.com/user/login)配置推送证书信息，详见 [Android 推送](/document/android/push/push_fcm.html)和 [APNs 推送](/document/ios/push/push_apns.html)文档中各厂商证书配置描述。 例如，对于华为推送，需配置**证书名称**和**推送密钥**，并调用客户端 Web SDK 提供的 `uploadPushToken` 方法向环信服务器上传 device token（Android 或 iOS 平台使用 Web SDK）。 diff --git a/docs/document/web/push/push_template.md b/docs/document/web/push/push_template.md index 90b63e20b..36728b82a 100644 --- a/docs/document/web/push/push_template.md +++ b/docs/document/web/push/push_template.md @@ -3,7 +3,7 @@ 推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板，你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： @@ -55,7 +55,7 @@ option.ext = { } ``` -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 +内置参数的介绍，详见[环信控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 这种方式的示例代码与“使用固定内容的推送模板”的相同。 diff --git a/docs/document/web/user_relationship.md b/docs/document/web/user_relationship.md index 678fc92fa..19124a26f 100644 --- a/docs/document/web/user_relationship.md +++ b/docs/document/web/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移出黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/document/windows/conversation_list.md b/docs/document/windows/conversation_list.md index 07e7f2ca2..b2faf3488 100644 --- a/docs/document/windows/conversation_list.md +++ b/docs/document/windows/conversation_list.md @@ -34,7 +34,7 @@ :::tip 1. 若使用该方法，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 1.2.0 或以上版本。 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `LoadAllConversations` 方法获取本地所有会话即可。 -3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 +3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。 ::: ```csharp diff --git a/docs/document/windows/initialization.md b/docs/document/windows/initialization.md index 6c6b4cc10..3776e2761 100644 --- a/docs/document/windows/initialization.md +++ b/docs/document/windows/initialization.md @@ -10,7 +10,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/console/app_create.html)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化 diff --git a/docs/document/windows/login.md b/docs/document/windows/login.md index bd8f815f6..80741613b 100644 --- a/docs/document/windows/login.md +++ b/docs/document/windows/login.md @@ -127,4 +127,4 @@ SDKClient.Instance.Logout(false, ### 登录被封禁账号的提示 -在环信即时通讯控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 +在环信控制台或调用 REST API 封禁用户账号后，若仍使用该账号登录，SDK会返回 "service is disabled"（305 错误）, 可以根据用户这个返回值来进行相应的提示或者处理。 diff --git a/docs/document/windows/message_recall.md b/docs/document/windows/message_recall.md index 7360837a1..0fe8299ea 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 6bf1408e6..cc2db401a 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/message_translation.md b/docs/document/windows/message_translation.md index 4a5018a09..b60ab9744 100644 --- a/docs/document/windows/message_translation.md +++ b/docs/document/windows/message_translation.md @@ -13,7 +13,7 @@ 1. 完成 `1.0.5 或以上版本` SDK 初始化，详见 [快速开始](quickstart.html)。 2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)。 -3. 已在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 开通翻译功能。 +3. 已在 [环信控制台](https://console.easemob.com/user/login) 开通翻译功能。 4. 该功能由 Microsoft Azure Translation API 提供。开始前请确保你了解该功能支持的目标语言。详见 [翻译语言支持](https://learn.microsoft.com/zh-cn/azure/ai-services/translator/language-support)。 ## 技术原理 diff --git a/docs/document/windows/moderation.md b/docs/document/windows/moderation.md index 42c0ab51c..7b6f6a408 100644 --- a/docs/document/windows/moderation.md +++ b/docs/document/windows/moderation.md @@ -2,14 +2,14 @@ -即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +即时通讯 IM SDK 提供消息举报接口。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 :::tip -1. 使用前，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login) 开通该功能。 +1. 使用前，你需要在[环信控制台](https://console.easemob.com/user/login) 开通该功能。 2. 消息举报功能与内容审核功能为两个独立的功能，没有任何关联，因此使用该功能无需提前开通内容审核功能。 ::: -关于如何开通消息举报和查看举报记录，详见[环信即时通讯云控制台文档说明](/product/console/moderation_message_report.html)。 +关于如何开通消息举报和查看举报记录，详见[环信控制台文档说明](/product/console/moderation_message_report.html)。 ## 技术原理 @@ -20,7 +20,7 @@ 开始前，请确保满足以下条件： - 完成 SDK 初始化，并连接到服务器，详见 [快速开始](quickstart.html)。 -- 已在 [环信即时通讯云控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 +- 已在 [环信控制台开通消息举报功能](/product/console/moderation_message_report.html#开通服务)。 - 了解环信即时通讯 IM 的使用限制，详见 [使用限制](/product/limitation.html)。 ## 实现方法 @@ -29,8 +29,8 @@ ```csharp // msgId：要举报的消息 ID。 -// tag：非法消息的标签。你需要自定义标签，例如`涉政`或`广告`。该字段对应环信即时通讯云控制台的消息举报记录页面的`词条标记`字段。 -// reason：举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的`举报原因`字段。 +// tag：非法消息的标签。你需要自定义标签，例如`涉政`或`广告`。该字段对应环信控制台的消息举报记录页面的`词条标记`字段。 +// reason：举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的`举报原因`字段。 SDKClient.Instance.ChatManager.ReportMessage(msgId, tag, reason, new CallBack( onSuccess: () => { @@ -48,9 +48,9 @@ SDKClient.Instance.ChatManager.ReportMessage(msgId, tag, reason, new CallBack( | 参数 | 类型 | 描述 | | :--------- | :----- | :------- | | `msgId` | String | 要举报的消息 ID。 | -| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信即时通讯云控制台的消息举报记录页面的**词条标记**字段。 | -| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信即时通讯云控制台的消息举报记录页面的**举报原因**字段。 | +| `tag` | String | 非法消息的标签。你需要自定义标签，例如**涉政**或**广告**。该字段对应环信控制台的消息举报记录页面的**词条标记**字段。 | +| `reason` | String | 举报原因。你需要自行填写举报原因，最长不能超过 512 字节。该字段对应环信控制台的消息举报记录页面的**举报原因**字段。 | -要在[环信即时通讯云控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 +要在[环信控制台](https://console.easemob.com/user/login)上查询消息举报页面，需在首页选择应用，点击**操作**一栏中的**管理**，选择**即时通讯 > 内容审核 > 消息举报**。 ![img](/images/android/message_report.png) \ No newline at end of file diff --git a/docs/document/windows/overview.md b/docs/document/windows/overview.md index 9b0f7fb85..e8f9d465e 100644 --- a/docs/document/windows/overview.md +++ b/docs/document/windows/overview.md @@ -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/windows/user_relationship.md b/docs/document/windows/user_relationship.md index d25f82680..2f1d899ad 100644 --- a/docs/document/windows/user_relationship.md +++ b/docs/document/windows/user_relationship.md @@ -7,7 +7,7 @@ SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理 - 好友列表管理：查询好友列表、请求添加好友、同意好友请求、拒绝好友请求和删除好友等操作。 - 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前，你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 -此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 +此外，环信即时通讯 IM 默认支持陌生人之间发送单聊消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/console/basic_user.html#好友关系检查)。该功能开启后，SDK 会在用户发起单聊时检查好友关系，若用户向陌生人发送单聊消息，SDK 会提示错误码 221。 ## 技术原理 diff --git a/docs/product/aigc/aigc_rest_api.md b/docs/product/aigc/aigc_rest_api.md index 34793d85c..3df99684f 100644 --- a/docs/product/aigc/aigc_rest_api.md +++ b/docs/product/aigc/aigc_rest_api.md @@ -36,7 +36,7 @@ GET https://{host}/{org_name}/{app_name}/robot/rule?&page={page}&size={size} | :--------- | :----- | :------- | :------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 查询参数 @@ -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 d3f0238f5..8f9161aa4 100644 --- a/docs/product/aigc/aigc_run_through_demo_server.md +++ b/docs/product/aigc/aigc_run_through_demo_server.md @@ -35,7 +35,7 @@ src/main/resources/application.yml #### 1. 创建应用 -登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，点击**添加应用**，填写应用相关信息。 +登录[环信控制台](https://console.easemob.com/user/login)，点击**添加应用**，填写应用相关信息。 ![img](/images/aigc/app_create.png) @@ -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 4b470000d..64f4e7a53 100644 --- a/docs/product/aigc/aigc_selection.md +++ b/docs/product/aigc/aigc_selection.md @@ -29,9 +29,9 @@ ## 方案二 -使用环信即时通讯 IM 提供的 AI 机器人聊天。你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通 AI 智能功能，创建机器人，即实现与机器人的**单聊**功能。 +使用环信即时通讯 IM 提供的 AI 机器人聊天。你需要在[环信控制台](https://console.easemob.com/user/login)开通 AI 智能功能，创建机器人，即实现与机器人的**单聊**功能。 -此外，你可以在[环信即时通讯控制台](https://console.easemob.com/user/login)查看机器人账号消耗的 token 数和消耗趋势。 +此外，你可以在[环信控制台](https://console.easemob.com/user/login)查看机器人账号消耗的 token 数和消耗趋势。 有关更多信息，请参见[使用 AI 机器人聊天](aigc_use.html)和[调用 REST API 获取 app 下的机器人列表](aigc_rest_api.html)相关文档。 diff --git a/docs/product/aigc/aigc_use.md b/docs/product/aigc/aigc_use.md index c38e656c0..f6be30c47 100644 --- a/docs/product/aigc/aigc_use.md +++ b/docs/product/aigc/aigc_use.md @@ -4,9 +4,9 @@ ## 1. 开通 AI 智能功能 -你可以在[环信即时通讯控制台](https://console.easemob.com/user/login)开通 AI 智能功能。 +你可以在[环信控制台](https://console.easemob.com/user/login)开通 AI 智能功能。 -1. 登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，在首页的**应用列表**区域点击目标应用的**操作**一栏中的**管理**。 +1. 登录[环信控制台](https://console.easemob.com/user/login)，在首页的**应用列表**区域点击目标应用的**操作**一栏中的**管理**。 ![img](/images/aigc/app_select.png) @@ -61,7 +61,7 @@ ## 4. 查看数据统计 -你可以在[环信即时通讯控制台](https://console.easemob.com/user/login)的左侧导航栏选择 **即时通讯** > **AI 智能** > **数据统计**，查看机器人账号消耗的 token 数和消耗趋势。 +你可以在[环信控制台](https://console.easemob.com/user/login)的左侧导航栏选择 **即时通讯** > **AI 智能** > **数据统计**，查看机器人账号消耗的 token 数和消耗趋势。 目前，大模型平台只能选择 **MINIMAX**。 diff --git a/docs/product/circle/category_mgmt_rest.md b/docs/product/circle/category_mgmt_rest.md index 2564da4e3..524116ddd 100644 --- a/docs/product/circle/category_mgmt_rest.md +++ b/docs/product/circle/category_mgmt_rest.md @@ -28,7 +28,7 @@ | :--------- | :----- | :------- | :----------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `channel_category_id` | String | 是 | 频道分组 ID。 | diff --git a/docs/product/circle/channel_mgmt_rest.md b/docs/product/circle/channel_mgmt_rest.md index fc91eba28..2c29262f7 100644 --- a/docs/product/circle/channel_mgmt_rest.md +++ b/docs/product/circle/channel_mgmt_rest.md @@ -26,7 +26,7 @@ | :--------- | :----- | :------- | :----------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `user_id` | String | 是 | 用户 ID。 | diff --git a/docs/product/circle/server_mgmt_rest.md b/docs/product/circle/server_mgmt_rest.md index 72e72f191..c9324f04b 100644 --- a/docs/product/circle/server_mgmt_rest.md +++ b/docs/product/circle/server_mgmt_rest.md @@ -26,7 +26,7 @@ | :--------- | :----- | :------- | :----------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见[获取环信即时通讯 IM 的信息](http://doc.easemob.com/product/console/app_manage.html#查看应用信息)。 | | `server_id` | String | 是 | 社区 ID。 | | `channel_id` | String | 是 | 频道 ID。 | | `user_id` | String | 是 | 用户 ID。 | diff --git a/docs/product/conversation_function.md b/docs/product/conversation_function.md index bd7cc1359..12884ce61 100644 --- a/docs/product/conversation_function.md +++ b/docs/product/conversation_function.md @@ -15,7 +15,7 @@ | 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关，详见 [产品价格](https://www.easemob.com/pricing/im)。 | | 离线消息推送 |
- 用户离线时，可向消息接收方发送推送通知。
- 支持离线消息存储，默认为 7 天。 | | 搜索消息 | 按照关键字搜索本地会话中的各类消息。 | -| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台设置消息撤回时长，该时长不超过 7 天。 | +| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信控制台设置消息撤回时长，该时长不超过 7 天。 | | 消息回执 | 消息送达回执和消息已读回执。 | | 修改消息 | 编辑发送成功的消息。 | | 表情回复 | 对消息添加、删除表情。 | @@ -41,7 +41,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#好友关系检查)。 | 功能 | 描述 | | :-------------- | :----- | @@ -64,7 +64,7 @@ | 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关，详见 [产品价格](https://www.easemob.com/pricing/im)。 | | 离线消息推送 |
- 用户离线时，可向消息接收方发送推送通知。
- 支持离线消息存储，默认为 7 天。 | | 搜索消息 | 按照关键字搜索本地会话中的各类消息。 | -| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台设置消息撤回时长，该时长不超过 7 天。 | +| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信控制台设置消息撤回时长，该时长不超过 7 天。 | | 消息回执 | 消息送达回执和消息已读回执。 | | 修改消息 | 编辑发送成功的消息。 | | 表情回复 | 对消息添加、删除表情。 | @@ -176,7 +176,7 @@ | :------------- | :---------------------- | | 发送和接收消息 | 发送和接收各类消息，包括文本、图片、音频、视频、文件消息、位置消息、命令消息、自定义消息以及合并消息。 | | 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关，详见 [产品价格](https://www.easemob.com/pricing/im)。要从服务器拉取聊天室的历史消息，需升级 SDK 到特定版本，并联系环信商务开通。 | -| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台设置消息撤回时长，该时长不超过 7 天。 | +| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信控制台设置消息撤回时长，该时长不超过 7 天。 | | 修改消息 | 编辑发送成功的消息。 | | 定向消息 | 只向聊天室的单个或多个指定的成员发送消息，其他成员不会收到该消息。| | 合并消息 | 将多个消息合并在一起进行转发。 | @@ -234,7 +234,7 @@ | 本地存储 | 接收的消息存储在本地。 | | 历史消息 | 环信服务器可存储消息。消息存储时间与你的产品套餐包相关，详见 [产品价格](https://www.easemob.com/pricing/im)。 | | 搜索消息 | 按照关键字搜索本地会话中的各类消息。 | -| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台设置消息撤回时长，该时长不超过 7 天。 | +| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信控制台设置消息撤回时长，该时长不超过 7 天。 | | 表情回复 | 对消息添加、删除表情。 | | 导入和插入消息 | 在本地导入和插入消息。 | | 删除消息 | 单向删除服务端和本地的历史消息、清除聊天记录。 | diff --git a/docs/product/easemob_app_token.md b/docs/product/easemob_app_token.md index 09257973c..2418dfea4 100644 --- a/docs/product/easemob_app_token.md +++ b/docs/product/easemob_app_token.md @@ -26,7 +26,7 @@ POST https://{host}/{org_name}/{app_name}/token | :--------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | #### 请求 header @@ -40,9 +40,9 @@ 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/)的`应用详情`页面。 | -| `ttl` | Long | 否 | token 有效期，单位为秒。
- 若传入该参数，token 有效期以传入的值为准。
- 若不传该参数，以 [环信即时通讯云控制台](https://console.easemob.com/user/login/)的 **用户管理** 页面的 token 有效期的设置为准。
- 若设置为 `0`，则 token 永久有效。
注意：VIP 5 集群该参数单位为毫秒。| +| `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 对应的 **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 中传入的与该参数一致。 | | 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/easemob_user_token.md b/docs/product/easemob_user_token.md index d800f4920..5101c2715 100644 --- a/docs/product/easemob_user_token.md +++ b/docs/product/easemob_user_token.md @@ -56,7 +56,7 @@ POST https://{host}/{org_name}/{app_name}/token | :------------- | :----- | :------- | :---------------------------------- | | `host`| String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](/product/console/app_manage.html#查看应用信息)。| #### 请求 header diff --git a/docs/product/enable_and_configure_IM.md b/docs/product/enable_and_configure_IM.md index 89c802b28..1a86c279f 100644 --- a/docs/product/enable_and_configure_IM.md +++ b/docs/product/enable_and_configure_IM.md @@ -10,9 +10,9 @@ ## 创建应用 -参照以下步骤在环信即时通讯云控制台创建应用和购买即时通讯 IM 服务。 +参照以下步骤在环信控制台创建应用和购买即时通讯 IM 服务。 -1. 登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，在首页的**应用列表**区域点击 **添加应用** 按钮，创建即时通讯 IM 应用。 +1. 登录[环信控制台](https://console.easemob.com/user/login)，在首页的**应用列表**区域点击 **添加应用** 按钮，创建即时通讯 IM 应用。 ![img](/images/product/console.png) @@ -70,21 +70,21 @@ ## 获取环信即时通讯 IM 的信息 -在环信即时通讯云控制台，你可以查看你的环信即时通讯 IM 服务的如下信息： +在环信控制台，你可以查看你的环信即时通讯 IM 服务的如下信息： | 应用信息 | 描述 | 如何查看 | | :--------- | :----- | :------- | -| `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)的 **服务概览** 页面查看。 | +| `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)的 **服务概览** 页面查看。 | ## 查看和配置功能 -创建应用后，参照以下步骤在环信即时通讯云控制台上查看环信即时通讯 IM 服务的详情以及进行配置。 +创建应用后，参照以下步骤在环信控制台上查看环信即时通讯 IM 服务的详情以及进行配置。 -在环信即时通讯云控制台的首页的 **应用列表** 中，点击目标应用的 **操作** 栏中的 **管理** 按钮，在左侧导航栏选择 **即时通讯** > **功能配置** > **功能配置总览**，您可以查看到当前 App Key 的服务配置并根据实际业务需求管理相关配置，具体操作说明如下： +在环信控制台的首页的 **应用列表** 中，点击目标应用的 **操作** 栏中的 **管理** 按钮，在左侧导航栏选择 **即时通讯** > **功能配置** > **功能配置总览**，您可以查看到当前 App Key 的服务配置并根据实际业务需求管理相关配置，具体操作说明如下： 1. **免费开通**：指该功能当前服务版本里已包含，可根据实际业务需求选择是否开通；点击 **免费开通**，则可立即开通该功能； 2. **设置**：指该功能已开通且有需要设置的配置项，点击 **设置**，即可进入对应设置页配置； @@ -123,7 +123,7 @@ 开启环信即时通讯 IM 服务后，按照以下步骤添加消息推送证书： -1. 在环信即时通讯云控制台首页的**应用列表**中，在目标应用的 **操作** 栏中，点击 **管理**。 +1. 在环信控制台首页的**应用列表**中，在目标应用的 **操作** 栏中，点击 **管理**。 ![img](/images/product/push/push_app_list.png) @@ -142,7 +142,7 @@ ## 配置推送模板 -若使用推送模板，你首先要在环信即时通讯云控制台选择 **即时通讯** > **功能配置** > **功能配置总览** 开启离线推送高级功能。 +若使用推送模板，你首先要在环信控制台选择 **即时通讯** > **功能配置** > **功能配置总览** 开启离线推送高级功能。 开启后，你可以配置默认推送模板和自定义推送模板。 @@ -152,11 +152,11 @@ 默认推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。 -要使用默认模板，你需要在环信即时通讯云控制台或[调用 RESTful 接口](/document/server-side/push.html#创建离线推送模板)创建默认推送模板，模板名称为 **default**。设置完毕，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 +要使用默认模板，你需要在环信控制台或[调用 RESTful 接口](/document/server-side/push.html#创建离线推送模板)创建默认推送模板，模板名称为 **default**。设置完毕，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 按照以下步骤创建默认推送模板： -1. 在环信即时通讯云控制台首页的**应用列表**中，在目标应用的 **操作** 栏中，点击 **管理**。 +1. 在环信控制台首页的**应用列表**中，在目标应用的 **操作** 栏中，点击 **管理**。 ![img](/images/product/push/push_app_list.png) @@ -219,7 +219,7 @@ 自定义推送模板，即名称为 `default` 之外的推送模板。你可以参考以下步骤使用自定义推送模板： -1. 若使用自定义推送模板，你需要在环信即时通讯云控制台或[调用 RESTful 接口](/document/server-side/push.html#创建离线推送模板)创建自定义推送模板。**添加推送模板** 对话框中参数的描述，详见[使用默认推送模板](#使用默认推送模板)。使用自定义模板时，**标题** 和 **内容** 参数无论通过哪种方式设置，创建消息时均需通过扩展字段传入。 +1. 若使用自定义推送模板，你需要在环信控制台或[调用 RESTful 接口](/document/server-side/push.html#创建离线推送模板)创建自定义推送模板。**添加推送模板** 对话框中参数的描述，详见[使用默认推送模板](#使用默认推送模板)。使用自定义模板时，**标题** 和 **内容** 参数无论通过哪种方式设置，创建消息时均需通过扩展字段传入。 2. 创建消息时需通过使用扩展字段传入模板名称、推送标题和推送内容，通知栏中的推送标题和内容分别使用模板中的格式。 @@ -229,7 +229,7 @@ ### 开通消息回调 -1. 在环信即时通讯云控制台首页的**应用列表**中，在目标应用的 **操作** 栏中点击 **管理**。 +1. 在环信控制台首页的**应用列表**中，在目标应用的 **操作** 栏中点击 **管理**。 ![img](/images/product/push/push_app_list.png) @@ -307,7 +307,7 @@ ## 消息举报 -环信即时通讯 IM 提供消息举报功能。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信即时通讯云控制台](https://console.easemob.com/user/login)展示。你可在环信即时通讯云控制台查看举报记录，并进行相应处理。 +环信即时通讯 IM 提供消息举报功能。你的用户可以在客户端举报违规消息。当服务器收到举报消息后，会将举报消息存储到数据库，并在[环信控制台](https://console.easemob.com/user/login)展示。你可在环信控制台查看举报记录，并进行相应处理。 1. 开通消息举报功能。 @@ -325,7 +325,7 @@ 2. 查看消息举报记录。 -消息举报服务开通后，你可以在环信即时通讯云控制台的左侧导航栏中选择 **内容审核 > 消息举报** 查看消息举报记录。 +消息举报服务开通后，你可以在环信控制台的左侧导航栏中选择 **内容审核 > 消息举报** 查看消息举报记录。 ## 敏感词设置 @@ -419,7 +419,7 @@ ## IM 用户设备日志 -环信即时通讯云控制台支持查询用户设备端的日志，或将设备端的日志上传到环信日志服务器。目前，仅支持使用了高于 3.3.2 的 Android/iOS SDK 的设备。 +环信控制台支持查询用户设备端的日志，或将设备端的日志上传到环信日志服务器。目前，仅支持使用了高于 3.3.2 的 Android/iOS SDK 的设备。 ![img](/images/product/enable_and_configure/user_device_log.png) @@ -439,13 +439,13 @@ ## 账户中心 -登录环信即时通讯云控制台，选择 **费用中心** > **账户中心**，可查看你当前的账户余额和支出明细。 +登录环信控制台，选择 **费用中心** > **账户中心**，可查看你当前的账户余额和支出明细。 ![img](/images/product/account-bills.png) ## 查看订单记录 -登录环信即时通讯云控制台，选择 **费用中心** > **订单中心**，可查看你当前的所有订单记录。 +登录环信控制台，选择 **费用中心** > **订单中心**，可查看你当前的所有订单记录。 ![img](/images/product/order-records.png) @@ -463,6 +463,6 @@ ## 查看账单记录 -登录环信即时通讯云控制台，选择 **费用中心** > **消费账单**，可查看你当前的已生成的账单记录。 +登录环信控制台，选择 **费用中心** > **消费账单**，可查看你当前的已生成的账单记录。 ![img](/images/product/bill-records.png) \ No newline at end of file diff --git a/docs/product/faq_integration_issues.md b/docs/product/faq_integration_issues.md index 3287f24b0..39cf8517d 100644 --- a/docs/product/faq_integration_issues.md +++ b/docs/product/faq_integration_issues.md @@ -4,7 +4,7 @@ ## 如何实现跨 app 聊天 -如果您需要两个 app 之间可以互相通信，只要将 AppKey 写成同一个就可以实现跨 app 聊天。同时，您需要在环信即时通讯云控制台上传对应 app 的推送证书（可以是多个），这样可以确保您的两个 app 都能收到推送。 +如果您需要两个 app 之间可以互相通信，只要将 AppKey 写成同一个就可以实现跨 app 聊天。同时，您需要在环信控制台上传对应 app 的推送证书（可以是多个），这样可以确保您的两个 app 都能收到推送。 ## 获取设备本地日志文件 diff --git a/docs/product/faq_quality_issues.md b/docs/product/faq_quality_issues.md index be4dfeb1f..2f641a24e 100644 --- a/docs/product/faq_quality_issues.md +++ b/docs/product/faq_quality_issues.md @@ -35,7 +35,7 @@ #### 二、APP 已经上线后，线上用户出现消息丢失 1. 先与自己的客户确认是否存在 “用户 B 不在线时，用户 A 给用户 B 发消息，用户 B 重新登录后收不到消息”下描述的 1，2 两种情况。 -2. 提供 App Key、环信即时通讯 IM ID、丢失的消息内容和发送消息的时间，然后登录环信即时通讯云控制台，提交工单，让环信即时通讯 IM 的技术支持排查。[环信即时通讯云控制台](https://console.easemob.com/user/login)）。 +2. 提供 App Key、环信即时通讯 IM ID、丢失的消息内容和发送消息的时间，然后登录环信控制台，提交工单，让环信即时通讯 IM 的技术支持排查。[环信控制台](https://console.easemob.com/user/login)）。 ## 排查环信即时通讯 IM 群聊消息丢失 @@ -68,9 +68,9 @@ - “用户 B 在线的情况下收不到用户 A 发的群组消息”的 3、4 和 5 的情况 - “用户 B 不在线时，用户 A 向群组中发送消息，用户 B 重新登录后收不到群组消息”的 1 和 2 的情况。 -2.若排除以上情况，可根据 App Key、发送者 ID 或消息 ID、消息发送时间在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 自行查询消息投递状态，具体操作如下： +2.若排除以上情况，可根据 App Key、发送者 ID 或消息 ID、消息发送时间在 [环信控制台](https://console.easemob.com/user/login) 自行查询消息投递状态，具体操作如下： -1. 登录环信即时通讯云控制台。 +1. 登录环信控制台。 2. 在首页的 应用列表 区域中，点击具体应用的 **操作** 栏中的 **管理**。 3. 在界面左侧导航栏中选择**应用详情**下的**即时通讯** > **实时查询** > **IM消息投递查询**。 @@ -82,9 +82,9 @@ 在使用环信即时通讯 IM 基础聊天业务的场景下，处理特定业务需求时需知晓某些用户是否在线。为此，环信即时通讯 IM 提供单个用户以及批量用户是否在线状态的查询，详见 [用户在线状态回调](/document/server-side/callback_login_logout.html)。 -除此之外，可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 上查询用户连接状态，具体操作如下： +除此之外，可以在 [环信控制台](https://console.easemob.com/user/login) 上查询用户连接状态，具体操作如下： -1. 登录环信即时通讯云控制台。 +1. 登录环信控制台。 2. 在首页的 **应用列表** 区域中，点击具体应用的 **操作** 栏中的 **管理**。 3. 在界面左侧导航栏中选择 **应用详情** 下的 **即时通讯** > **实时查询** > **IM用户连接状态**。 diff --git a/docs/product/limitation.md b/docs/product/limitation.md index 17cba1d52..3ba1cf542 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 10a82a8ee..466108e39 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/product_function.md b/docs/product/product_function.md index bc2a81e48..5ff96d869 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)的 **即时通讯** > **功能配置** > **功能配置总览** > **基础功能** 页面上查找 **多端多设备在线**，开启该功能。此外，可以在 **基础功能**页签下点击 **多端多设备在线** 操作栏中的 **设置**，在弹出的对话框中设置各端设备的数量。 ## 消息类型 @@ -74,7 +74,7 @@ | 离线消息推送 |
- 用户离线时，可向消息接收方发送推送通知。
- 支持离线消息存储，默认为 7 天。 | | 多端同步 | 多端多设备消息同步，同时收到消息。 | | 本地搜索 | 按照关键字搜索本地会话中的各类消息。 | -| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台设置消息撤回时长，该时长不超过 7 天。 | +| 消息撤回 | 撤回发送成功的消息。默认可撤回发出 2 分钟内的消息。你可以在环信控制台设置消息撤回时长，该时长不超过 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,7 +163,7 @@ ## 环信控制台 -你可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)对你的应用进行配置和管理。 +你可以在[环信控制台](https://console.easemob.com/user/login)对你的应用进行配置和管理。 | 功能 | 描述 | | :------ | :----------- | diff --git a/docs/product/product_message_format.md b/docs/product/product_message_format.md index 320bcb761..87c23f811 100644 --- a/docs/product/product_message_format.md +++ b/docs/product/product_message_format.md @@ -290,22 +290,22 @@ | ------------------------- | ------- | ------------------------------------------------------------ | | `fcm_options` | Object | FCM SDK 功能选项。 | | `fcm_channel_id` | String | FCM 推送通道（最高优先级）。 | -| `honor_click_action` | String | 荣耀点击跳转，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **荣耀** 页面设置的 **Action** 参数的配置。 | +| `honor_click_action` | String | 荣耀点击跳转，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **荣耀** 页面设置的 **Action** 参数的配置。 | | `honor_importance` | String | 荣耀推送优先级：
- `LOW`：低优先级；
- （默认）`NORMAL`：普通优先级。 | | `honor_target_user_type` | Integer | 推送用户类型：
- `0`：普通
- `1`：测试 | | `huawei_target_user_type` | Integer | 推送用户类型：
- `0`：普通
- `1`：测试 | -| `huawei_category` | String | 完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)后，用于标识消息类型，确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718)，对特定类型消息加快发送，取值如下：[华为官方文档中category字段的解释](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/https-send-api-0000001050986197#section13271045101216)。该参数的设置优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Category** 参数的配置。 | +| `huawei_category` | String | 完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)后，用于标识消息类型，确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718)，对特定类型消息加快发送，取值如下：[华为官方文档中category字段的解释](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-References/https-send-api-0000001050986197#section13271045101216)。该参数的设置优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Category** 参数的配置。 | | `huawei_receipt_id` | String | 华为回执地址 ID。 | -| `huawei_click_action` | String | 华为点击跳转 action，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Action** 参数的配置。 | +| `huawei_click_action` | String | 华为点击跳转 action，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **华为** 页面设置的 **Action** 参数的配置。 | | `huawei_channel_id` | String | 华为推送通道（最高优先级）。 | -| `meizu_click_activity` | String | 魅族点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **魅族** 页面设置的 **Activity** 参数的配置。 | +| `meizu_click_activity` | String | 魅族点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **魅族** 页面设置的 **Activity** 参数的配置。 | | `meizu_notice_type` | Int | 通道类型：
- `0`：公信通道
- `1`：私信通道 | -| `oppo_channel_id` | String | OPPO 推送通道（最高优先级），优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | -| `oppo_click_activity` | String | OPPO 点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | -| `vivo_category` | String | vivo 二级分类配置，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Category** 参数的配置。 | -| `vivo_click_activity` | String | vivo 点击跳转 activity，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Activity** 参数的配置。 | -| `xiaomi_channel_id` | String | 小米通道 ID，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Channel ID** 参数的配置。 | -| `xiaomi_click_action` | String | 小米点击跳转 action，优先级高于在环信即时通讯控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Action** 参数的配置。 | +| `oppo_channel_id` | String | OPPO 推送通道（最高优先级），优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | +| `oppo_click_activity` | String | OPPO 点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **OPPO** 页面设置的 **Activity** 参数的配置。 | +| `vivo_category` | String | vivo 二级分类配置，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Category** 参数的配置。 | +| `vivo_click_activity` | String | vivo 点击跳转 activity，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **VIVO** 页面设置的 **Activity** 参数的配置。 | +| `xiaomi_channel_id` | String | 小米通道 ID，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Channel ID** 参数的配置。 | +| `xiaomi_click_action` | String | 小米点击跳转 action，优先级高于在环信控制台的**即时通讯** > **功能配置** > **消息推送** > **证书管理** > **添加推送证书** > **小米** 页面设置的 **Action** 参数的配置。 | `em_harmony_push_ext` 结构如下： diff --git a/docs/product/product_offline_push_overview.md b/docs/product/product_offline_push_overview.md index 4b028edbd..abc484d4b 100644 --- a/docs/product/product_offline_push_overview.md +++ b/docs/product/product_offline_push_overview.md @@ -31,13 +31,13 @@ ## 上传推送证书 -在第三方推送服务控制台创建应用后，下载推送证书并获取证书相关信息，将推送证书上传至环信即时通讯控制台，并配置证书相关信息。 +在第三方推送服务控制台创建应用后，下载推送证书并获取证书相关信息，将推送证书上传至环信控制台，并配置证书相关信息。 例如，对于 FCM 推送证书相关配置，详见 [FCM 推送集成文档](/document/android/push/push_fcm.html#步骤三-上传推送证书)。 ## 多设备离线推送策略 -多设备登录时，可在环信即时通讯控制台的证书管理页面配置推送策略，该策略配置对所有推送通道生效： +多设备登录时，可在环信控制台的证书管理页面配置推送策略，该策略配置对所有推送通道生效： - 所有设备离线时，才发送推送消息； - 任一设备离线时，都发送推送消息。 @@ -46,7 +46,7 @@ ## 推送高级功能 -要使用离线推送的高级功能，包括推送通知方式、免打扰模式和使用推送模板，你可以在环信即时通讯控制台的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** +要使用离线推送的高级功能，包括推送通知方式、免打扰模式和使用推送模板，你可以在环信控制台的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。**如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。** ### 推送通知方式 @@ -73,14 +73,14 @@ ### 使用推送模板 -设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。 +设置推送模板为推送的高级功能，使用前需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。 推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 你可以通过以下两种方式设置： - [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 +- 在[环信控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 使用推送模板有以下优势： diff --git a/docs/product/product_user_registration_login.md b/docs/product/product_user_registration_login.md index 9f2ebf08a..12257c05e 100644 --- a/docs/product/product_user_registration_login.md +++ b/docs/product/product_user_registration_login.md @@ -6,10 +6,10 @@ 用户注册模式分为以下两种： -- 开放注册：一般在体验 Demo 和测试环境时使用，正式环境中不推荐使用该方式注册环信账号。要使用开放注册，需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域，将**用户注册模式**设置为**开放注册**。只有打开该开关，才能使用客户端或 [REST API](/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#开放注册单个用户)开放注册用户。 +- 授权注册：通过环信提供的 REST API 注册环信用户账号，注册后保存到你的服务器或返给客户端。要使用授权注册，你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域，将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍，详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -除此以外，可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户，详见[创建用户相关介绍](/product/console/operation_user.html#创建用户)。 +除此以外，可以在[环信控制台](https://console.easemob.com/user/login)创建用户，详见[创建用户相关介绍](/product/console/operation_user.html#创建用户)。 ## 用户登录 diff --git a/docs/product/voiceroom/client_implementation_android.md b/docs/product/voiceroom/client_implementation_android.md index d6d82b117..9380f5c70 100644 --- a/docs/product/voiceroom/client_implementation_android.md +++ b/docs/product/voiceroom/client_implementation_android.md @@ -99,7 +99,7 @@ Demo 中创建或加入语聊房的流程如下： - Android Studio 3.0 或以上版本； - Android SDK API 等级 23 或以上； - Android 6.0 或以上版本的设备； -- 有效的环信 IM 开发者账号和 App key，详见[环信即时通讯云控制台](https://console.easemob.com/user/login)； +- 有效的环信 IM 开发者账号和 App key，详见[环信控制台](https://console.easemob.com/user/login)； - [有效的 Agora 项目，获取项目的 App ID 以及一个 RTC Token，实现语音通话](https://docportal.shengwang.cn/cn/voice-call-4.x/start_call_audio_android_ng?platform=Android)； - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 diff --git a/docs/product/voiceroom/client_implementation_ios.md b/docs/product/voiceroom/client_implementation_ios.md index 9374b17e7..606fcd195 100644 --- a/docs/product/voiceroom/client_implementation_ios.md +++ b/docs/product/voiceroom/client_implementation_ios.md @@ -94,7 +94,7 @@ - Xcode 13.0 或以上版本。 - CocoaPods。你可以参考 [CocoaPods 安装指南](https://guides.cocoapods.org/using/getting-started.html#getting-started) 安装。 - iOS 13.0 或以上版本的设备。部分模拟机可能无法支持本项目的全部功能，所以推荐使用真机。 -- 有效的环信 IM 开发者账号和 App key，详见[环信即时通讯云控制台](https://console.easemob.com/user/login)。 +- 有效的环信 IM 开发者账号和 App key，详见[环信控制台](https://console.easemob.com/user/login)。 - [有效的 Agora 项目，获取项目的 App ID 以及一个 RTC Token，实现语音通话](https://docportal.shengwang.cn/cn/voice-call-4.x/start_call_audio_ios_ng?platform=iOS)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 diff --git a/docs/push/push_by_tag.md b/docs/push/push_by_tag.md index e27a59587..1b3c3cb2b 100644 --- a/docs/push/push_by_tag.md +++ b/docs/push/push_by_tag.md @@ -2,7 +2,7 @@ 即时通讯服务支持通过设置标签自定义推送用户，实现精准推送。标签用于描述用户的生活习惯、兴趣爱好、行为特征等信息。对用户设置标签后，推送消息时，指定某一推送标签，即可向该标签下的用户发送消息。例如，可以为一些用户打上“时尚弄潮儿”标签后，可定期向该人群推送国内外潮流品牌的相关信息。 -你可以通过环信即时通讯控制台创建和管理标签，也可以通过 REST API 进行标签管理。用户与标签是多对多的关系，即一个用户可以对应多个标签，一个标签也可以对应多个用户。 +你可以通过环信控制台创建和管理标签，也可以通过 REST API 进行标签管理。用户与标签是多对多的关系，即一个用户可以对应多个标签，一个标签也可以对应多个用户。 本文档主要介绍如何调用即时推送 REST API 实现创建及管理推送标签。调用以下方法前，请先参考 [接口频率限制](/product/limitation.html)了解即时通讯 RESTful API 的调用频率限制。 @@ -16,7 +16,7 @@ | :--------- | :----- | :------- | :-------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。 | | `username` | String | 是 | 用户 ID。 | ### 响应参数 diff --git a/docs/push/push_send_notification.md b/docs/push/push_send_notification.md index 12e080b7d..a26a85686 100644 --- a/docs/push/push_send_notification.md +++ b/docs/push/push_send_notification.md @@ -21,7 +21,7 @@ | :--------- | :----- | :------- | :-------------------------------------------------- | | `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。 | | `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。 | -| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。 | +| `app_name` | String | 是 | 你在环信控制台创建应用时填入的应用名称。 | | `username` | String | 是 | 用户 ID。 | ### 响应参数 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md b/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md index 734890838..c30aa556d 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_best_practice.md @@ -40,7 +40,7 @@ ChatroomUIKitClient.getInstance().login(YourAppUser, token, onSuccess = {}, onEr ## 初始化聊天室视图 -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 加载聊天室视图 `ComposeChatroom`，传入的参数包括聊天室 ID、布局参数、聊天室所有者的用户 ID 及一些选项。 diff --git a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md index 31c977bec..c973518c1 100644 --- a/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/android/roomuikit_quickstart.md @@ -11,7 +11,7 @@ - 使用 Kotlin 语言开发，1.5.21 或以上版本； - JDK 1.8 或以上版本； - Gradle 7.0.0 或以上版本； -- 已在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。 +- 已在[环信控制台](https://console.easemob.com/user/login)创建了有效的环信即时通讯 IM 开发者账号，并[获取了 App Key](/product/console/app_manage.html#查看应用信息)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 ## 创建项目引入 ChatroomUIKit 模块 @@ -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_best_practice.md b/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md index cb8b9d3b5..efb67e281 100644 --- a/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/flutter/roomuikit_best_practice.md @@ -74,7 +74,7 @@ try { } ``` -2. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上[创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 +2. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上[创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 3. 使用 `chatroom_uikit` 前，需要先创建 `ChatroomController`, 并使 `ChatRoomUIKit` 作为当前页面的根节点，并将其他组件作为 `ChatRoomUIKit` 的子节点。 diff --git a/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md b/docs/uikit/chatroomuikit/flutter/roomuikit_quickstart.md index c19e46fcd..f9bd98616 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 827d395df..ee7023df6 100644 --- a/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md +++ b/docs/uikit/chatroomuikit/ios/roomuikit_quickstart.md @@ -7,7 +7,7 @@ - Xcode (推荐最新版本)。 - 安装 iOS 13.0 或更高版本的 iOS 模拟器或 Apple 设备。 - 已使用 CocoaPods 添加了 ChatroomUIKit 依赖项。 -- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信即时通讯云控制台](https://console.easemob.com/user/login)。 +- 有效的环信即时通讯 IM 开发者账号和 App Key，详见 [环信控制台](https://console.easemob.com/user/login)。 - 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。 ## 创建项目 @@ -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_best_practice.md b/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md index f51dcfa8f..0bc066bd6 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_best_practice.md @@ -88,7 +88,7 @@ export function LoginScreen(props: Props) { ## 初始化聊天室视图 -1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信即时通讯云控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 +1. 获取聊天室列表，加入指定的聊天室。除此之外，你还可以在环信控制台上 [创建聊天室](/product/console/operation_chatroom.html#创建聊天室)，获取聊天室 ID。 2. 加载聊天室视图 `Chatroom`，传入的参数包括聊天室 ID、聊天室所有者的用户 ID 及一些选项。 diff --git a/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md b/docs/uikit/chatroomuikit/react-native/roomuikit_config_item.md index 8e8795866..e3979e438 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_run.md b/docs/uikit/chatroomuikit/react-native/roomuikit_run.md index e09beb1ae..a3eca5e0c 100644 --- a/docs/uikit/chatroomuikit/react-native/roomuikit_run.md +++ b/docs/uikit/chatroomuikit/react-native/roomuikit_run.md @@ -43,7 +43,7 @@ cd examples/room-example 修改 `examples/room-example/src/env.ts` 文件内容，填写 appKey 参数。 -您可以在[环信即时通讯云控制台](https://console.easemob.com/)创建应用并获取 appKey。 +您可以在[环信控制台](https://console.easemob.com/)创建应用并获取 appKey。 3. 运行项目： diff --git a/docs/uikit/chatuikit/android/chatuikit_chat.md b/docs/uikit/chatuikit/android/chatuikit_chat.md index 8ae2b4802..1770af6a7 100644 --- a/docs/uikit/chatuikit/android/chatuikit_chat.md +++ b/docs/uikit/chatuikit/android/chatuikit_chat.md @@ -681,7 +681,7 @@ builder.setCustomAdapter(CustomMessageAdapter()) #### 设置消息翻译 - `ChatUIKitClient.getConfig()?.chatConfig?.enableTranslationMessage`：是否开启文本消息长按翻译功能，默认为 `false`，即该功能默认关闭。如需开启该特性，需设置为 `true`。 -- `ChatUIKitClient.getConfig()?.chatConfig?.targetTranslationLanguage = "zh"`：翻译目标语言，默认为中文。文本消息长按后出现**翻译**菜单，点击**翻译**后，设置翻译的目标语言。使用前，你需在[环信即时通讯云控制台](https://console.easemob.com/user/login)申请试用翻译功能，然后将 `ChatUIKitClient.getConfig()?.chatConfig?.enableTranslationMessage` 设置为 `true`，才会出现文本消息长按的翻译功能。若后台申请翻译未通过，前端无法成功调用 API 进行翻译。 +- `ChatUIKitClient.getConfig()?.chatConfig?.targetTranslationLanguage = "zh"`：翻译目标语言，默认为中文。文本消息长按后出现**翻译**菜单，点击**翻译**后，设置翻译的目标语言。使用前，你需在[环信控制台](https://console.easemob.com/user/login)申请试用翻译功能，然后将 `ChatUIKitClient.getConfig()?.chatConfig?.enableTranslationMessage` 设置为 `true`，才会出现文本消息长按的翻译功能。若后台申请翻译未通过，前端无法成功调用 API 进行翻译。 - `