diff --git a/docs/.vuepress/config.ts.69f76f9a.mjs b/docs/.vuepress/config.ts.69f76f9a.mjs index f4fa8cdd3..85d938e48 100644 --- a/docs/.vuepress/config.ts.69f76f9a.mjs +++ b/docs/.vuepress/config.ts.69f76f9a.mjs @@ -1415,7 +1415,7 @@ var PUSH_SIDEBAR = [ text: "\u5FEB\u901F\u5165\u95E8", children: [ { text: "\u521B\u5EFA\u4EA7\u54C1\u53CA\u5E94\u7528", link: "push_createproduct_app.html" }, - { text: "\u521B\u5EFA\u63A8\u9001", link: "push_createnotification.html" }, + { text: "\u521B\u5EFA\u63A8\u9001", link: "push_task_create.html" }, { text: "\u63A8\u9001\u4EFB\u52A1", link: "push_task.html" }, { text: "\u6807\u7B7E\u7BA1\u7406", link: "push_tag_mgmt.html" }, { text: "\u8BC1\u4E66\u914D\u7F6E", link: "push_certificate_config.html" }, @@ -1602,7 +1602,7 @@ var zhSidebar = sidebar({ }, { text: "\u89C4\u5219\u6D4B\u8BD5", link: "moderation/moderation_rule_test.html" }, { text: "\u5386\u53F2\u8BB0\u5F55", link: "moderation/moderation_history.html" }, - { text: "\u5173\u952E\u8BCD\u5BA1\u6838", link: "moderation/keyword_review.html" }, + { text: "\u5173\u952E\u8BCD\u5BA1\u6838", link: "moderation/moderation_keyword" }, { text: "\u6D88\u606F\u5BA1\u6838\u673A\u5236", link: "moderation/moderation_mechanism.html" diff --git a/docs/.vuepress/public/images/android/push/push_template_custom.png b/docs/.vuepress/public/images/android/push/push_template_custom.png index 76c78d9aa..abd874d97 100644 Binary files a/docs/.vuepress/public/images/android/push/push_template_custom.png and b/docs/.vuepress/public/images/android/push/push_template_custom.png differ diff --git a/docs/.vuepress/public/images/console/moderation_callback.png b/docs/.vuepress/public/images/console/moderation_callback.png new file mode 100644 index 000000000..d5aaafef1 Binary files /dev/null and b/docs/.vuepress/public/images/console/moderation_callback.png differ diff --git a/docs/.vuepress/public/images/console/moderation_callback_add.png b/docs/.vuepress/public/images/console/moderation_callback_add.png new file mode 100644 index 000000000..ddb7f9e2d Binary files /dev/null and b/docs/.vuepress/public/images/console/moderation_callback_add.png differ diff --git a/docs/.vuepress/public/images/console/operation_user_moderation.png b/docs/.vuepress/public/images/console/operation_user_moderation.png new file mode 100644 index 000000000..2c8291a5d Binary files /dev/null and b/docs/.vuepress/public/images/console/operation_user_moderation.png differ diff --git a/docs/.vuepress/public/images/console/value_added_config_moderation.png b/docs/.vuepress/public/images/console/value_added_config_moderation.png new file mode 100644 index 000000000..b09f95b56 Binary files /dev/null and b/docs/.vuepress/public/images/console/value_added_config_moderation.png differ diff --git a/docs/.vuepress/public/images/console/value_added_config_push.png b/docs/.vuepress/public/images/console/value_added_config_push.png new file mode 100644 index 000000000..61590fe97 Binary files /dev/null and b/docs/.vuepress/public/images/console/value_added_config_push.png differ diff --git a/docs/.vuepress/public/images/console/value_added_config_rtc.png b/docs/.vuepress/public/images/console/value_added_config_rtc.png new file mode 100644 index 000000000..0fd924018 Binary files /dev/null and b/docs/.vuepress/public/images/console/value_added_config_rtc.png differ diff --git a/docs/.vuepress/public/images/instantpush/push_bind_user.png b/docs/.vuepress/public/images/instantpush/push_bind_user.png index 418dc0f1c..4cae3c1c6 100644 Binary files a/docs/.vuepress/public/images/instantpush/push_bind_user.png and b/docs/.vuepress/public/images/instantpush/push_bind_user.png differ diff --git a/docs/.vuepress/public/images/instantpush/push_certificate_add.png b/docs/.vuepress/public/images/instantpush/push_certificate_add.png index d82824914..28b4bcd59 100644 Binary files a/docs/.vuepress/public/images/instantpush/push_certificate_add.png and b/docs/.vuepress/public/images/instantpush/push_certificate_add.png differ diff --git a/docs/.vuepress/public/images/instantpush/push_domain_name.png b/docs/.vuepress/public/images/instantpush/push_domain_name.png index ec898dab6..0dadb2a9c 100644 Binary files a/docs/.vuepress/public/images/instantpush/push_domain_name.png and b/docs/.vuepress/public/images/instantpush/push_domain_name.png differ diff --git a/docs/.vuepress/sidebar/index.ts b/docs/.vuepress/sidebar/index.ts index 695e00b39..77b7c2a79 100644 --- a/docs/.vuepress/sidebar/index.ts +++ b/docs/.vuepress/sidebar/index.ts @@ -146,11 +146,12 @@ export const zhSidebar = sidebar({ link: "moderation/moderation_rule_config.html", }, { text: "规则测试", link: "moderation/moderation_rule_test.html" }, + { text: "数据总览", link: "moderation/moderation_data_overview.html" }, { text: "历史记录", link: "moderation/moderation_history.html" }, - { text: "关键词审核", link: "moderation/keyword_review.html" }, - { - text: "消息审核机制", - link: "moderation/moderation_mechanism.html", + { text: "消息举报", link: "moderation/moderation_message_report.html" }, + { text: "关键词审核", link: "moderation/moderation_keyword" }, + { text: "标签管理", link: "moderation/moderation_user_tag" }, + { text: "消息审核机制", link: "moderation/moderation_mechanism.html", }, ], }, @@ -163,10 +164,10 @@ export const zhSidebar = sidebar({ link: "moderation/moderation_record_callback.html", }, { - text: "消息人工审核", + text: "群组/聊天室审核", link: "moderation/moderation_manual_review.html", }, - { text: "用户管理", link: "moderation/moderation_usermgmt.html" }, + { text: "用户审核", link: "moderation/moderation_usermgmt.html" }, ], }, ], @@ -245,20 +246,7 @@ export const zhSidebar = sidebar({ text: "配置增值功能", collapsible: true, children: [ - { - text: "内容审核", - collapsible: true, - children: [ - { text: "数据总览", link: "console/moderation_data_overview.html" }, - { text: "规则配置", link: "console/moderation_rule_config.html" }, - { text: "规则测试", link: "console/moderation_rule_test.html" }, - { text: "历史记录", link: "console/moderation_history.html" }, - { text: "关键词名单", link: "console/moderation_keyword.html" }, - { text: "审核记录导出", link: "console/moderation_history_export.html" }, - { text: "消息举报", link: "console/moderation_message_report.html" }, - { text: "标签管理", link: "console/moderation_user_tag.html" }, - ], - }, + { text: "内容审核", link: "console/value_added_config_moderation.html" }, { text: "即时推送", collapsible: true, @@ -272,6 +260,8 @@ export const zhSidebar = sidebar({ { text: "推送统计", link: "console/push_statistics.html" }, ], }, + { text: "即时推送", link: "console/value_added_config_push.html" }, + { text: "实时音视频", link: "console/value_added_config_rtc.html" }, ], }, ], diff --git a/docs/.vuepress/sidebar/push.ts b/docs/.vuepress/sidebar/push.ts index 580b3720f..b9b217502 100644 --- a/docs/.vuepress/sidebar/push.ts +++ b/docs/.vuepress/sidebar/push.ts @@ -22,7 +22,7 @@ export const PUSH_SIDEBAR = [ text: '快速入门', children: [ { text: '创建产品及应用', link: 'push_createproduct_app.html' }, - { text: '创建推送', link: 'push_createnotification.html' }, + { text: '创建推送', link: 'push_task_create.html' }, { text: '推送任务', link: 'push_task.html' }, { text: '标签管理', link: 'push_tag_mgmt.html' }, { text: '证书配置', link: 'push_certificate_config.html' }, diff --git a/docs/README.md b/docs/README.md index 34bc6aeee..a264a429c 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 @@ -2024,7 +2024,7 @@ projects: - text: 查看历史记录 link: /product/moderation/moderation_history.html - text: 关键词审核 - link: /product/moderation/keyword_review.html + link: /product/moderation/moderation_keyword.html - text: 消息审核机制 link: /product/moderation/moderation_mechanism.html - text: 审核记录回调 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..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/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..79ba74f71 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..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#开放注册单个用户)开放注册用户。 示例代码如下所示： @@ -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。 @@ -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 40e953d50..c43f473ac 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#增值服务费用)。 ## 实现方法 @@ -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_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/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 bd09ba57c..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/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)。 ## 实现方法 @@ -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 deleted file mode 100644 index fd0f41975..000000000 --- a/docs/document/android/push/push_display.md +++ /dev/null @@ -1,243 +0,0 @@ -# 设置推送通知的显示内容 - -通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： - -1. **设置推送通知的显示属性**：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`SimpleBanner`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 -2. **使用默认推送模板**：若有默认模板 `default`，发消息时无需指定。 -3. **使用消息扩展字段**：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 -4. **接收方设置了推送模板**。 -5. **使用自定义推送模板**：发送消息时通过消息扩展字段指定推送模板名称。 - -## 设置和获取推送通知的显示属性 - -### 设置推送通知的显示属性 - -你可以调用 `updatePushNickname` 方法设置推送通知中显示的昵称，如以下代码示例所示： - -```java -// 需要异步处理。 -EMClient.getInstance().pushManager().updatePushNickname("pushNickname"); -``` - -你也可以调用 `updatePushDisplayStyle` 设置推送通知的显示样式，如下代码示例所示： - -```java -// 设置为简单样式。 -EMPushManager.DisplayStyle displayStyle = EMPushManager.DisplayStyle.SimpleBanner; -// 需要异步处理。 -EMClient.getInstance().pushManager().updatePushDisplayStyle(displayStyle); -``` - -若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。`DisplayStyle` 是枚举类型，有如下两种设置： - -| 参数值 | 描述 | -| :--------------- | :---------------------- | -| （默认）`SimpleBanner` | 不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | -| `MessageSummary` | `MessageSummary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `MessageSummary` 时生效，在 `SimpleBanner` 时不生效。 | - -下表以**单聊文本消息**为例介绍显示属性的设置。 - -对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 - -| 参数设置 | 推送显示 | 图片 | -| :--------- | :----- |:------------- | -|
- `DisplayStyle`：（默认）`SimpleBanner`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| -|
- `DisplayStyle`：`MessageSummary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | -|
- `DisplayStyle`：`MessageSummary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| - -### 获取推送通知的显示属性 - -你可以调用 `getPushConfigsFromServer` 获取推送通知中的显示属性，如以下代码示例所示： - -```java -EMPushConfigs pushConfigs = EMClient.getInstance().pushManager().getPushConfigsFromServer(); -// 获取推送显示昵称。 -String nickname = pushConfigs.getDisplayNickname(); -// 获取推送通知的显示样式。 -EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle(); -``` - -## 使用推送模板 - -推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 - -你可以通过以下两种方式设置： - -- [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 - -使用推送模板有以下优势： - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式： - - - 使用自定义推送模板的优先级高于默认推送模板。 - - - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 - -:::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 -::: - -### 发消息时使用推送模板 - -创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： - -:::tip -若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 -::: - -1. 使用固定内容的推送模板，通过 `ext` 扩展字段指定推送模板名称。 - -这种情况下，创建消息时无需传入 `titleArgs` 和 `contentArgs` 参数。 - -```java -// 下面以文本消息为例，其他类型的消息设置方法相同。 -EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT); -EMTextMessageBody txtBody = new EMTextMessageBody("消息内容"); -message.setTo("6006"); -// 设置推送模板。 -JSONObject pushObject = new JSONObject(); -try { - // 设置推送模板名称。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 - //若为默认模板 `default`，无需传入模板名称。 - //若为自定义模板，需传入模板名称。 - pushObject.put("name", "test7"); - -} catch (JSONException e) { - e.printStackTrace(); -} -// 将推送扩展设置到消息中。 -message.setAttribute("em_push_template", pushObject); -// 设置消息状态回调。 -message.setMessageStatusCallback(new EMCallBack() {...}); -// 发送消息。 -EMClient.getInstance().chatManager().sendMessage(message); -``` - -2. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数： - -- `{$dynamicFrom}`：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。 -- `{$fromNickname}`：推送昵称。 -- `{$msg}`：消息内容。 - -群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下： - -```json - { - "ext":{ - "em_push_ext":{ - "group_user_nickname":"Jane" - } - } - } -``` - -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 - -这种方式的示例代码与“使用固定内容的推送模板”的相同。 - -3. 使用自定义推送模板，而且推送标题和推送内容为自定义参数： - -例如，推送模板的设置如下图所示： - -![img](/images/android/push/push_template_custom.png) - -使用下面的示例代码后，通知栏中弹出的推送通知为： - -![img](/images/android/push/push_template_custom_example.png) - -```java -// 下面以文本消息为例，其他类型的消息设置方法相同。 -EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT); -EMTextMessageBody txtBody = new EMTextMessageBody("消息内容"); -message.setTo("6006"); -// 设置推送模板。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 -JSONObject pushObject = new JSONObject(); -JSONArray titleArgs = new JSONArray(); -JSONArray contentArgs = new JSONArray(); -try { - // 设置推送模板名称。若不指定，设置默认推送模板的信息。 - pushObject.put("name", "push"); - // 设置填写模板标题的 value 数组。 - titleArgs.put("您"); - titleArgs.put("消息,"); - //... - pushObject.put("title_args", titleArgs); - // 设置填写模板内容的 value 数组。 - contentArgs.put("请"); - contentArgs.put("查看"); - //... - pushObject.put("content_args", contentArgs); -} catch (JSONException e) { - e.printStackTrace(); -} -// 将推送扩展设置到消息中。 -message.setAttribute("em_push_template", pushObject); -// 设置消息状态回调。 -message.setMessageStatusCallback(new EMCallBack() {...}); -// 发送消息。 -EMClient.getInstance().chatManager().sendMessage(message); -``` - -### 消息接收方使用推送模板 - -消息接收方可以调用 `setPushTemplate` 方法传入推送模板名称，选择要使用的模板。 - -:::tip -若发送方在发送消息时使用了推送模板，则推送通知栏中的显示内容以发送方的推送模板为准。 -::: - -```java -EMClient.getInstance().pushManager().setPushTemplate("Template Name", new EMCallBack() { - @Override - public void onSuccess() { - - } - - @Override - public void onError(int code, String error) { - - } -}); -``` - -## 使用消息扩展字段设置推送通知显示内容 - -创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 - -```java -// 这里以文本消息为例，附件等类型的消息设置方法相同。 -EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT); -EMTextMessageBody txtBody = new EMTextMessageBody("message content"); -// 设置要发送用户的用户 ID。 -message.setTo("toChatUsername"); -// 设置自定义推送提示。 -JSONObject extObject = new JSONObject(); -try { - extObject.put("em_push_title", "custom push title"); - extObject.put("em_push_content", "custom push content"); -} catch (JSONException e) { - e.printStackTrace(); -} -// 将推送扩展设置到消息中。 -message.setAttribute("em_apns_ext", extObject); -// 设置消息体。 -message.addBody(txtBody); -// 设置消息回调。 -message.setMessageStatusCallback(new CallBack() {...}); -// 发送消息。 -EMClient.getInstance().chatManager().sendMessage(message); -``` - -| 参数 | 描述 | -| :---------------- | :----------- | -| `toChatUsername` | 消息接收方 ID。 | -| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | -| `em_push_title` | 自定义字段 key，用于设置自定义的标题，该值为固定值，不可修改。 | -| `em_push_content` | 自定义字段 key，用于设置自定义的内容，该值为固定值，不可修改。 | \ No newline at end of file diff --git a/docs/document/android/push/push_display_attribute.md b/docs/document/android/push/push_display_attribute.md new file mode 100644 index 000000000..e44dd0089 --- /dev/null +++ b/docs/document/android/push/push_display_attribute.md @@ -0,0 +1,48 @@ +# 设置和获取推送通知的显示属性 + +## 设置推送通知的显示属性 + +调用 `updatePushNickname` 方法设置推送通知中显示的昵称，如以下代码示例所示： + +```java +// 需要异步处理。 +EMClient.getInstance().pushManager().updatePushNickname("pushNickname"); +``` + +调用 `updatePushDisplayStyle` 设置推送通知的显示样式，如下代码示例所示： + +```java +// 设置为简单样式。 +EMPushManager.DisplayStyle displayStyle = EMPushManager.DisplayStyle.SimpleBanner; +// 需要异步处理。 +EMClient.getInstance().pushManager().updatePushDisplayStyle(displayStyle); +``` + +若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。`DisplayStyle` 是枚举类型，有如下两种设置： + +| 参数值 | 描述 | +| :--------------- | :---------------------- | +| （默认）`SimpleBanner` | 不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | +| `MessageSummary` | `MessageSummary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `MessageSummary` 时生效，在 `SimpleBanner` 时不生效。 | + +下表以**单聊文本消息**为例介绍显示属性的设置。 + +对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 + +| 参数设置 | 推送显示 | 图片 | +| :--------- | :----- |:------------- | +|
- `DisplayStyle`：（默认）`SimpleBanner`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| +|
- `DisplayStyle`：`MessageSummary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | +|
- `DisplayStyle`：`MessageSummary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| + +## 获取推送通知的显示属性 + +你可以调用 `getPushConfigsFromServer` 获取推送通知中的显示属性，如以下代码示例所示： + +```java +EMPushConfigs pushConfigs = EMClient.getInstance().pushManager().getPushConfigsFromServer(); +// 获取推送显示昵称。 +String nickname = pushConfigs.getDisplayNickname(); +// 获取推送通知的显示样式。 +EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle(); +``` \ No newline at end of file diff --git a/docs/document/android/push/push_display_field.md b/docs/document/android/push/push_display_field.md new file mode 100644 index 000000000..17a2e370e --- /dev/null +++ b/docs/document/android/push/push_display_field.md @@ -0,0 +1,34 @@ +# 使用消息扩展字段设置推送通知显示内容 + +创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 + +```java +// 这里以文本消息为例，附件等类型的消息设置方法相同。 +EMMessage message = EMMessage.createSendMessage(EMMessage.Type.TXT); +EMTextMessageBody txtBody = new EMTextMessageBody("message content"); +// 设置要发送用户的用户 ID。 +message.setTo("toChatUsername"); +// 设置自定义推送提示。 +JSONObject extObject = new JSONObject(); +try { + extObject.put("em_push_title", "custom push title"); + extObject.put("em_push_content", "custom push content"); +} catch (JSONException e) { + e.printStackTrace(); +} +// 将推送扩展设置到消息中。 +message.setAttribute("em_apns_ext", extObject); +// 设置消息体。 +message.addBody(txtBody); +// 设置消息回调。 +message.setMessageStatusCallback(new CallBack() {...}); +// 发送消息。 +EMClient.getInstance().chatManager().sendMessage(message); +``` + +| 参数 | 描述 | +| :---------------- | :----------- | +| `toChatUsername` | 消息接收方 ID。 | +| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | +| `em_push_title` | 自定义字段 key，用于设置自定义的标题，该值为固定值，不可修改。 | +| `em_push_content` | 自定义字段 key，用于设置自定义的内容，该值为固定值，不可修改。 | \ No newline at end of file diff --git a/docs/document/android/push/push_display_overview.md b/docs/document/android/push/push_display_overview.md new file mode 100644 index 000000000..b87fb0a5b --- /dev/null +++ b/docs/document/android/push/push_display_overview.md @@ -0,0 +1,13 @@ +# 设置推送通知的显示内容 + +通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： + +1. [**设置推送通知的显示属性**](push_display_attribute.html)：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`SimpleBanner`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 +2. [**使用默认推送模板**](push_template.html#编辑默认推送模板)：若有默认模板 `default`，发消息时无需指定。 +3. [**使用消息扩展字段**](push_display_field.html)：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 +4. [**接收方设置了推送模板**](push_template.html#消息接收方使用推送模板)。 +5. [**使用自定义推送模板**](push_template.html#)：发送消息时通过消息扩展字段指定推送模板名称。 + +:::tip +推送模板为离线推送的高级功能，使用前需要 [在环信控制台开启](push_template.html#开通服务)。 +::: \ No newline at end of file diff --git a/docs/document/android/push/push_fcm.md b/docs/document/android/push/push_fcm.md index 69de86318..442dc99ed 100644 --- a/docs/document/android/push/push_fcm.md +++ b/docs/document/android/push/push_fcm.md @@ -14,15 +14,15 @@ ![image](/images/android/push/fcmproject.png) -1. 选择该项目下的应用。 +2. 选择该项目下的应用。 ![image](/images/android/push/appsetting.png) -1. 选择**服务账号**页签，点击**生成新的私钥**。 +3. 选择**服务账号**页签，点击**生成新的私钥**。 ![image](/images/android/push/v1json.png) -1. 下载证书，保存备用。 +4. 下载证书，保存备用。 下载证书文件，例如 `myapplication-72d8c-firebase-adminsdk-yqa7z-4766fefcaf.json`。 @@ -44,47 +44,40 @@ ### **步骤三 上传推送证书** -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传推送证书，选择你的应用 > **即时通讯** > **功能配置** > **消息推送** > **证书管理**。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)，选择你的应用 > **功能配置** > **增值功能** > **即时推送**。 -![image](/images/android/push/fcm_certificate_v1.png) +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框打开后，默认显示 **谷歌** 页签。你可以在该页面配置谷歌 FCM 推送证书。 -1. 点击 **添加推送证书**。在默认打开的 **谷歌** 页签中，配置 FCM 推送： - -![image](/images/android/push/fcm_v1.png) +![img](/images/console/push_certificate_fcm.png) | 参数 | 类型 | 是否必需 | 描述 | | :-------------- | :----- | :------- | :---------------------------- | | 证书类型 | 文件 | 是 | 选择使用 V1 或旧版证书。
- **V1**：推荐使用。你需要点击 **上传证书** 上传FCM V1 版本证书文件，并且设置 **证书名称**。
-**旧版**：已弃用，不推荐使用。你需要配置 **证书名称** 和 **推送密钥**。 | | 上传文件 | 文件 | 是 | 点击 **上传证书** 上传获取的 FCM V1 版本证书文件（.json 文件）。此项仅对 V1 证书有效。 | -| 证书名称 | String | 是 | FCM 的发送者 ID。
- v1 证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn) 的 **项目设置** > **云消息传递** 页面的 **Firebase Cloud Messaging API（V1）** 区域中获取发送者 ID，如下图所示。
- 旧版证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn)的 **项目设置 > 云消息传递** 页面的 **Cloud Messaging API（旧版）** 区域中获取发送者 ID。 | -| 推送密钥 | String | 是 | FCM 服务器密钥。你需在 [Firebase 控制台](https://console.firebase.google.com/) 的 **项目设置** > **云消息传递**页面的 **云消息传递 API（旧版）** 区域中获取服务器密钥。此参数仅对旧版证书有效。| +| 证书名称 | String | 是 | FCM 的发送者 ID。
- v1 证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn) 的 **项目设置** > **云消息传递** 页面的 **Firebase Cloud Messaging API（V1）** 区域中获取发送者 ID，如下图所示。
- 旧版证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn)的 **项目设置 > 云消息传递** 页面的 **Cloud Messaging API（旧版）** 区域中获取发送者 ID，如下图所示。 | +| 推送密钥 | String | 是 | FCM 服务器密钥。你需在 [Firebase 控制台](https://console.firebase.google.com/) 的 **项目设置** > **云消息传递**页面的 **云消息传递 API（旧版）** 区域中获取服务器密钥，如下图所示。此参数仅对旧版证书有效。| | 通道 ID | String | 否 | FCM 通道 ID。该参数仅对离线推送有效。 | | 推送优先级设置 | | 否 | 消息传递优先级。请参见 [设置消息优先级](https://firebase.google.cn/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message)。
该参数仅对离线推送有效。| | 推送消息类型 | | 否 | 通过 FCM 发送给客户端的消息类型：
- **数据**：数据消息，由客户端应用程序处理。
- **通知**：通知消息，由 FCM SDK 自动处理。**数据+通知**：通知消息和数据消息都可以通过 FCM 客户端发送。
请参见 FCM 的 [消息类型介绍](https://firebase.google.com/docs/cloud-messaging/concept-options#notifications_and_data_messages)。
该参数仅对离线推送有效。| | APNs跨平台推送支持 | String | 否 | 是否开启 APNs 跨平台推送支持。非跨平台应用建议不要启用。该参数仅对离线推送有效。| -#### **旧版证书无缝切换至 V1 证书** - -若你仍使用旧版证书，即 **证书类型** 选择 **旧版**，你需要将 **证书名称** 设置为 FCM 的发送者 ID，**推送密钥** 设置为 FCM 的服务器密钥。你需在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn)的 **项目设置 > 云消息传递** 页面中，在 **Cloud Messaging API（旧版）** 区域中获取发送者 ID 和服务器密钥，如下图所示。配置完毕，设置 **铃声**、**推送优先级设置** 和 **推送消息类型** 参数。 +- 获取 V1 版证书名称 -![image](/images/android/push/fcm_old_version.png) - -**旧版 HTTP 或 XMPP API 于 2024 年 6 月 20 日停用，请尽快迁移到最新的 FCM API（HTTP v1）版本证书。详见 [FCM 控制台](https://console.firebase.google.com)。请确保 V1 证书可用，因为执行转换证书后，旧证书会被删除，若此时新证书不可用，会导致推送失败。** +![image](/images/android/push/fcm_v1.png) -你可以参考以下步骤从旧版证书无缝切换到 V1 新证书： +- 获取旧版证书名称和推送密钥 -1. 在 **证书管理** 页面的旧版证书的 **操作** 栏中点击 **编辑**。 +![image](/images/android/push/fcm_old_version.png) -![image](/images/android/push/hxconsoleedit.png) +#### **旧版证书无缝切换至 V1 证书** -1. 在**编辑推送证书** 窗口的 **谷歌** 页签，将**证书类型**切换为 **V1**。 +旧版 HTTP 或 XMPP API 已在 2024 年 6 月 20 日停用，请尽快迁移到最新的 FCM API（HTTP v1）版本证书，详见 [FCM 控制台](https://console.firebase.google.com)。请确保 V1 证书可用，因为执行转换证书后，旧证书会被删除，若 V1 证书不可用会导致推送失败。 -![fcmapp](/images/android/push/old2V1.png) +你可以参考以下步骤从旧版证书无缝切换到 V1 新证书： +1. 在 **证书管理** 页面的旧版证书的 **操作** 栏中点击 **编辑**。 +2. 在**编辑推送证书** 窗口的 **谷歌** 页签，将**证书类型**切换为 **V1**。 3. 点击 **上传证书** 上传本地保存的 V1 证书文件（.json）。 - -![fcmapp](/images/android/push/v1Chosefile.png) - 4. 点击 **保存** 完成切换。 ### **步骤四 FCM 推送集成** diff --git a/docs/document/android/push/push_honor.md b/docs/document/android/push/push_honor.md index 44262af4f..fdd7a8606 100644 --- a/docs/document/android/push/push_honor.md +++ b/docs/document/android/push/push_honor.md @@ -1,31 +1,29 @@ -# 在即时通讯 IM 中集成荣耀推 +# 在即时通讯 IM 中集成荣耀推送 环信即时通讯 IM SDK 4.0.3 版本中集成了荣耀推送。本节介绍如何集成荣耀厂商的离线推送通道，使消息通过荣耀推送服务推送至离线的用户。 -## **步骤一 在[荣耀开发者服务平台](https://developer.hihonor.com/cn/)创建应用并申请开通推送服务** +## **步骤一 在 [荣耀开发者服务平台](https://developer.hihonor.com/cn/) 创建应用并申请开通推送服务** -详见[荣耀推送官网说明](https://developer.honor.com/cn/docs/11002/guides/kit-history)。 +关于如何在 [荣耀开发者服务平台](https://developer.hihonor.com/cn/) 创建应用并申请开通推送服务，详见 [荣耀推送官网说明](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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择**荣耀**页签，配置荣耀推送参数。 +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **荣耀** 页签，配置荣耀推送参数。 -![image](/images/android/push/add_honor_push_template.png) +![img](/images/console/push_certificate_rongyao.png) | 推送证书参数 | 类型 | 是否必需 | 描述 | | :-------------- | :----- | :------- | :--------------------------------------- | -| `App ID` | String | 是 | 应用标识符，应用的唯一标识，在荣耀开发者服务平台开通对应用的荣耀推送服务时生成。 | -| `Client ID` | String | 是 | 应用的客户 ID，用于获取发送消息令牌的 ID，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | -| `Client Secret` | String | 是 | 应用的客户密钥，用于获取发送消息令牌的密钥，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | -| `Badge Class` | String | 否 | 应用入口 Activity 类全路径，例如 com.example.test.MainActivity。 | -| `Action` | String | 否 | 消息接收方在收到离线推送通知时单击通知栏时打开的应用指定页面的自定义标记。该参数需要与客户端 `AndroidManifest.xml` 文件中注册启动的 `Activity` 类中 `intent-filter` 标签中设置的 `action` 一致。 | +| App ID | String | 是 | 应用标识符，应用的唯一标识，在荣耀开发者服务平台开通对应用的荣耀推送服务时生成。 | +| Client ID | String | 是 | 应用的客户 ID，用于获取发送消息令牌的 ID，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | +| Client Secret | String | 是 | 应用的客户密钥，用于获取发送消息令牌的密钥，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | +| Badge Class | String | 否 | 应用入口 Activity 类全路径，例如 com.example.test.MainActivity。
该参数仅对离线推送有效。 | +| Action | String | 否 | 消息接收方在收到离线推送通知时，单击通知栏时打开的应用指定页面的自定义标记。
- 该参数需要与客户端 `AndroidManifest.xml` 文件中注册启动的 `Activity` 类中 `intent-filter` 页签中设置的 `action` 一致。
- 该参数仅对离线推送有效。 | :::tip -关于**App ID**、**Client ID**和**Client Secret**，可在荣耀开发者服务平台申请开通推送服务后，在**推送服务**页面选择创建的应用，在[**查看推送服务**](https://developer.honor.com/cn/docs/11002/guides/app-registration#申请开通推送服务)页面查看。 +关于 **App ID**、**Client ID** 和 **Client Secret**，可在荣耀开发者服务平台申请开通推送服务后，在 **推送服务** 页面选择创建的应用，在 [**查看推送服务**](https://developer.honor.com/cn/docs/11002/guides/app-registration#申请开通推送服务)页面查看。 ::: ![image](/images/android/push/view_push_service.png) diff --git a/docs/document/android/push/push_huawei.md b/docs/document/android/push/push_huawei.md index 2bdfc89ec..b6d8e5f1c 100644 --- a/docs/document/android/push/push_huawei.md +++ b/docs/document/android/push/push_huawei.md @@ -8,27 +8,25 @@ 详见华为官方介绍：[华为 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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择**华为**页签，配置华为推送参数。参数相关信息，详见你在华为开发者后台创建的[应用信息中的 App ID 和 SecretKey 以及程序的包名](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section125831926193110)。 +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **华为** 页签，配置华为推送参数。参数相关信息，详见你在华为开发者后台创建的 [应用信息中的 App ID 和 SecretKey 以及程序的包名](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section125831926193110)。 ![image](/images/android/push/add_huawei_push_certificate.png) | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------- | -| `证书名称` | String | 是 | 填写华为 Client ID。 | -| `推送密钥` | String | 是 | 填写华为 Client Secret。| -| `应用包名` | String | 是 | 填写华为 App package name。 | -| `项目 ID` | String | 否 | 填写项目 ID。 | -| `Category` | String | 否 | 选择 category 类型。 | -| `Action` | String | 否 | 选择点击通知后的动作。组件定义的 intent-filter action name。 | -| `ActivityClass`| String | 否 | 角标显示，应用入口类路径。示例：com.easemob.MainActivity。 | +| 证书名称 | String | 是 | 华为 Client ID。 | +| 推送密钥 | String | 是 | 华为 Client Secret。| +| 应用包名 | String | 是 | 华为 App package name。 | +| 项目 ID | String | 否 | 项目 ID。 | +| Category | String | 否 | 自动分类权益申请 Category。该参数仅对离线推送有效。 | +| Action | String | 否 | 点击通知后的动作。组件定义的 intent-filter action name。该参数仅对离线推送有效。 | +| ActivityClass | String | 否 | 角标显示，应用入口类路径。示例：com.easemob.MainActivity。该参数仅对离线推送有效。 | ## **步骤三 集成华为推送 SDK** diff --git a/docs/document/android/push/push_meizu.md b/docs/document/android/push/push_meizu.md index ef96379ea..de992b614 100644 --- a/docs/document/android/push/push_meizu.md +++ b/docs/document/android/push/push_meizu.md @@ -8,23 +8,21 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择 **魅族** 页签，配置魅族推送参数。参数相关信息，详见你在 [flyme 推送平台](https://login.flyme.cn/sso?appuri=https%3A%2F%2Fapiopen.flyme.cn%2Flogin&useruri=https%3A%2F%2Fopen.flyme.cn%3Ft%3D1722914343470&sid=node0mpa52w0llp341dncyz6wr7yi56208487&service=open&autodirct=true)创建的应用的 `APP ID` 和 `APP SECRET` 以及程序的 `包名`。 +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **魅族** 页签，配置魅族推送参数。参数相关信息，详见你在 [flyme 推送平台](https://login.flyme.cn/sso?appuri=https%3A%2F%2Fapiopen.flyme.cn%2Flogin&useruri=https%3A%2F%2Fopen.flyme.cn%3Ft%3D1722914343470&sid=node0mpa52w0llp341dncyz6wr7yi56208487&service=open&autodirct=true)创建的应用的 `APP ID` 和 `APP SECRET` 以及程序的 `包名`。 -![image](/images/android/push/add_meizu_push_certificate.png) +![img](/images/console/push_certificate_meizu.png) | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------- | -| `证书名称` | String | 是 | 填写魅族 App ID。 | -| `推送密钥` | String | 是 | 填写魅族 App Secret。| -| `应用包名` | String | 是 | 填写魅族 App package name。 | -| `Activity`| String | 否 | 选择点击通知后的动作。 | -| `推送送达回执` | String | 否 |
- **开启**；
- **关闭** | +| 证书名称 | String | 是 | 魅族 App ID。 | +| 推送密钥 | String | 是 | 魅族 App Secret。| +| 应用包名 | String | 是 | 魅族 App package name。 | +| Activity| String | 否 | 点击通知后的动作。该参数仅对离线推送有效。 | +| 推送送达回执 | String | 否 | 是否开启推送送达回执。
- 开发者需要在 Flyme 推送平台新建回执后，才能开启推送送达回执，获取到魅族推送通道送达到设备的推送数据。
- 该参数仅对离线推送有效。 | ## **步骤三 集成魅族推送 SDK** diff --git a/docs/document/android/push/push_notification_mode_dnd.md b/docs/document/android/push/push_notification_mode_dnd.md index d5678fd2a..d00d81dc8 100644 --- a/docs/document/android/push/push_notification_mode_dnd.md +++ b/docs/document/android/push/push_notification_mode_dnd.md @@ -2,10 +2,6 @@ 环信即时通讯 IM 3.9.2 及以上版本对离线消息推送进行了优化。你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -![image](/images/android/push/push_android_enable_push.png) - ## 推送通知方式 推送通知方式 `pushRemindType` 包含三种类型，如下表所示。其中，会话级别的 `pushRemindType` 设置优先于 app 级别的设置，未设置推送通知方式的会话默认采用 app 的设置。例如，假设 app 的推送方式设置为 `MENTION_ONLY`，而指定会话的推送方式设置为 `ALL`。你会收到来自该会话的所有推送通知，而对于其他会话来说，你只会收到提及你的消息的推送通知。 @@ -120,8 +116,8 @@ EMClient.getInstance().addMultiDeviceListener(new EMMultiDeviceListener() { ## 免打扰模式 完成 SDK 初始化和成功登录 app 后，你可以对 app 以及各类型的会话开启离线推送功能以及通过设置免打扰模式关闭推送。 - -你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 +- 你可以通过 `SILENT_MODE_INTERVAL` 参数开启全天免打扰和关闭免打扰模式：若开始时间和结束时间相同，免打扰模式则全天生效；若设置为 `0:0`-`0:0`，则关闭免打扰模式。 +- 你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 免打扰时间参数的说明如下表所示： diff --git a/docs/document/android/push/push_oppo.md b/docs/document/android/push/push_oppo.md index 31077a967..f8175db8b 100644 --- a/docs/document/android/push/push_oppo.md +++ b/docs/document/android/push/push_oppo.md @@ -8,13 +8,11 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择 **OPPO** 页签，配置 OPPO 推送参数。参数相关信息，详见你在 [OPPO 开发者后台](https://open.oppomobile.com/service/oms?service_id=1000004&app_type=app&app_id=30004346)创建的应用的 `appkey` 和 `mastersecret` 以及程序的 `包名`等信息。 +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **OPPO** 页签，配置 OPPO 推送参数。参数相关信息，详见你在 [OPPO 开发者后台](https://open.oppomobile.com/service/oms?service_id=1000004&app_type=app&app_id=30004346)创建的应用的 `appkey` 和 `mastersecret` 以及程序的 `包名`等信息。 ![image](/images/android/push/add_oppo_push_certificate.png) diff --git a/docs/document/android/push/push_overview.md b/docs/document/android/push/push_overview.md index ea2b7191a..dca2e5c1c 100644 --- a/docs/document/android/push/push_overview.md +++ b/docs/document/android/push/push_overview.md @@ -4,7 +4,7 @@ 即时通讯 IM 支持集成第三方离线消息推送服务，为 Android 开发者提供低延时、高送达、高并发、不侵犯用户个人数据的离线消息推送服务。目前支持的手机厂商推送服务包括：Google FCM、华为、荣耀、小米、OPPO、VIVO 和魅族。 -要体验离线推送功能，请点击[这里](https://www.easemob.com/download/demo)下载即时通讯 IM 的 demo。 +要体验离线推送功能，请在 [环信官网](https://www.easemob.com/download/demo) 下载即时通讯 IM 的 demo。 ## 离线推送过程 @@ -18,22 +18,7 @@ 2. 应用在后台运行或手机锁屏等情况，若客户端未断开与服务器的连接，则即时通讯 IM 不会收到离线推送通知。 -## 离线推送高级功能 - -如果需要离线推送的高级功能，需在[环信即时通讯控制台](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)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - -- 所有设备离线时，才发送推送消息； -- 任一设备离线时，都发送推送消息。 - -**注意**：多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。 - -![image](/images/android/push/push_multidevice_policy.png) - -## 技术原理 +## 推送原理 ![image](/images/android/push/push_android_understand.png) @@ -49,16 +34,36 @@ 8. 环信服务器将将消息发送给第三方推送服务器。 9. 第三方推送服务器将消息发送给用户 B。 -:::tip -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 有效期内仍会接收到离线推送通知。 -::: +## 推送证书和推送 Token + +**推送证书**：推送证书是环信服务器用于判断目标设备使用哪种推送通道的唯一条件。发送推送通知前需要在 [环信控制台](https://console.easemob.com/user/login)配置 App 的推送证书，需填写证书名称（或者 App Key），确保与 Android 终端设备上传的证书名称一致。该步骤必须在登录环信 IM SDK 成功后进行。 + +**推送 token（device token）**：推送 token 是第三方推送服务提供的推送 token。以 FCM 推送为例，初次启动你的应用时，FCM SDK 为客户端应用实例生成的注册令牌 (registration token)。该 token 用于标识每台设备上的每个应用，FCM 通过该 token 明确消息是发送给哪个设备的，然后将消息转发给设备，设备再通知应用程序。你可以调用 `FirebaseMessaging.getInstance().getToken()` 方法获得 token。另外，如果退出即时通讯 IM 登录时不解绑 device token（调用 `logout` 方法时对 `unbindToken` 参数传 `false` 时不解绑 device token，传 `true` 表示解绑 token），用户在推送证书有效期和 token 有效期内仍会接收到离线推送通知。 + +关于如何获取推送 Token 并上传至环信服务器，详见各推送服务的集成文档，例如 对于 FCM 推送，请参阅 [FCM 推送集成文档](/push/push_fcm.html#步骤四-fcm-推送集成)。 + +## 推送模板 + +推送模板是离线推送的高级功能。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面激活。**激活后，如需关闭推送模板功能，必须联系商务，因为该操作会删除推送模板相关的所有配置。** + +推送模板的配置和使用，详见 [相关文档介绍](push_template.html)。 + +## 多设备离线推送策略 + +多设备登录时，可在 [环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： + +- 所有设备离线时，才发送推送消息； +- 任一设备离线时，都发送推送消息。 + +**多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。** + +![image](/images/android/push/push_multidevice_policy.png) ## 前提条件 -1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/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/push/push_solution.md b/docs/document/android/push/push_solution.md index c7b2bd9ab..38d0d2b4b 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) @@ -28,7 +28,7 @@ ![image](/images/android/push/huawei_push_notification_test.png) -5. 查看是否超过了厂商通道限制。 +1. 查看是否超过了厂商通道限制。 详见[推送消息分类](push_message_classification.html)。 diff --git a/docs/document/android/push/push_vivo.md b/docs/document/android/push/push_vivo.md index 625baa5c2..861a5d41d 100644 --- a/docs/document/android/push/push_vivo.md +++ b/docs/document/android/push/push_vivo.md @@ -10,25 +10,23 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择 **VIVO** 页签，配置 VIVO 推送参数。参数相关信息，详见你在 [VIVO 开发者后台](https://vpush.vivo.com.cn/#/appdetail)创建的应用的 `APP ID`，`APP KEY` 和 `APP SECRET` 以及程序的 `包名`。 +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **VIVO** 页签，配置 VIVO 推送参数。参数相关信息，详见你在 [VIVO 开发者后台](https://vpush.vivo.com.cn/#/appdetail) 创建的应用的 `APP ID`，`APP KEY` 和 `APP SECRET` 以及程序的 `包名`。 -![image](/images/android/push/add_vivo_push_certificate.png) +![img](/images/console/push_certificate_vivo.png) | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------- | -| `证书名称` | String | 是 | 填写 VIVO App ID。 | -| `证书标识` | String | 是 | 填写 VIVO App Key。| -| `推送密钥` | String | 是 | 填写 VIVO App Secret。| -| `Category` | String | 否 | 选择 category 类型。 | -| `应用包名` | String | 是 | 填写 VIVO App package name。 | -| `Activity`| String | 否 | 选择点击通知后的动作。 | -| `推送类型` | String | 否 |
- **运营消息**
- **系统消息** | +| 证书名称 | String | 是 | VIVO App ID。 | +| 证书标识 | String | 是 | VIVO App Key。| +| 推送密钥 | String | 是 | VIVO App Secret。| +| Category | String | 否 | Category 类型。关于该参数，详见 [VIVO 推送文档](https://dev.vivo.com.cn/documentCenter/doc/359#w2-67805227)。该参数仅对离线推送有效。 | +| 应用包名 | String | 是 | VIVO App package name。该参数仅对离线推送有效。 | +| Activity| String | 否 | 点击通知后的动作。 该参数仅对离线推送有效。 | +| 推送类型 | String | 否 |可选择 **运营消息** 或 **系统消息**。该参数仅对离线推送有效。 | ## **步骤三 集成 VIVO 推送 SDK** diff --git a/docs/document/android/push/push_xiaomi.md b/docs/document/android/push/push_xiaomi.md index 6d418b317..0819c94ef 100644 --- a/docs/document/android/push/push_xiaomi.md +++ b/docs/document/android/push/push_xiaomi.md @@ -8,23 +8,21 @@ ## **步骤二 上传推送证书** -在[环信即时通讯云控制台](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. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择**小米**页签，配置小米推送参数。参数相关信息，详见你在 [小米开放平台](https://dev.mi.com/platform) 创建的应用信息中的 App ID 和 Secret Key 以及程序的包名。 - -![image](/images/android/push/add_xiaomi_push_certificate.png) +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **小米** 页签，配置小米推送参数。参数相关信息，详见你在 [小米开放平台](https://dev.mi.com/platform) 创建的应用信息中的 App ID 和 Secret Key 以及程序的包名。 + +![img](/images/console/push_certificate_xiaomi.png) | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :---------------- | -| `证书名称` | String | 是 | 填写小米 App ID。 | -| `推送密钥` | String | 是 | 填写小米 App Secret。| -| `应用包名` | String | 是 | 填写小米 App package name。 | -| `Channel ID` | String | 是 | 填写 Channel ID。 | -| `Action` | String | 否 | 选择点击通知后的动作。 | +| 证书名称 | String | 是 | 小米 App ID。 | +| 推送密钥 | String | 是 | 小米 App Secret。| +| 应用包名 | String | 是 | 小米 App package name。 | +| Channel ID | String | 是 | Channel ID。该参数仅对离线推送有效。 | +| Action | String | 否 | 点击通知后的动作。该参数仅对离线推送有效。 | ## **步骤三 集成小米推送 SDK** diff --git a/docs/document/android/quickstart.md b/docs/document/android/quickstart.md index 35bc4de75..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)。 ## 准备开发环境 @@ -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..ad0dcc5e8 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 初始化 @@ -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 eb0e1d81f..65fa16eb3 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/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 465c76c09..5f9c6fac8 100644 --- a/docs/document/applet/push/uniapp_push.md +++ b/docs/document/applet/push/uniapp_push.md @@ -6,9 +6,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. 各推送使用的条件： - 小米推送：在小米设备上可用； - 华为推送：在华为设备上可用； @@ -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/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..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/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..c99a00e70 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..e0a6f97be 100644 --- a/docs/document/flutter/login.md +++ b/docs/document/flutter/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/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。 @@ -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_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/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 9695df652..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/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)。 ## 实现方法 @@ -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 fda9ca61d..dfae22d95 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 注册 @@ -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 deleted file mode 100644 index b2b9c3675..000000000 --- a/docs/document/flutter/push/push_display.md +++ /dev/null @@ -1,217 +0,0 @@ -# 设置推送通知的显示内容 - -通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： - -1. 设置推送通知的显示属性：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`Simple`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 -2. 使用默认推送模板：若有默认模板 `default`，发消息时无需指定。 -3. 使用消息扩展字段：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 -4. 接收方设置了推送模板。 -5. 使用自定义推送模板：发送消息时通过消息扩展字段指定推送模板名称。 - -## 设置和获取推送通知的显示属性 - -### 设置推送通知的显示属性 - -你可以分别调用 `updatePushNickname` 和 `updatePushDisplayStyle` 方法设置推送通知中显示的昵称（`nickname`）和通知显示样式（`DisplayStyle`），确定通知栏中的推送标题和推送内容。 - -```dart -try { - EMClient.getInstance.pushManager.updatePushNickname('nickname'); -} on EMError catch (e) {} -``` - -```dart -try { - EMClient.getInstance.pushManager.updatePushDisplayStyle(DisplayStyle.Simple); -} on EMError catch (e) {} -``` - -若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。该参数有如下两种设置： - -| 参数值 | 描述 | -| :--------------- | :---------------------- | -| （默认）`Simple` | 不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | -| `Summary` | `Summary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `Summary` 时生效，在 `Simple` 时不生效。 | - -下表以单聊文本消息为例介绍这显示属性的设置。 - -对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 - -| 参数设置 | 推送显示 | 图片 | -| :--------- | :----- |:------------- | -|
- `DisplayStyle`：（默认）`Simple`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| -|
- `DisplayStyle`：`Summary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | -|
- `DisplayStyle`：`Summary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| - -### 获取推送通知的显示属性 - -你可以调用 `fetchPushConfigsFromServer` 方法获取推送通知中的显示属性，如以下代码示例所示： - -```dart -try { - EMPushConfigs configs = await EMClient.getInstance.pushManager.fetchPushConfigsFromServer(); - // 获取推送显示昵称。 - String? pushNickname = configs.displayName; - // 获取推送通知的显示样式。 - DisplayStyle pushDisplayStyle = configs.displayStyle; -} on EMError catch (e) {} -``` - -## 使用推送模板 - -推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 - -你可以通过以下两种方式设置： - -- [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 - -使用推送模板有以下优势： - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式： - - - 使用自定义推送模板的优先级高于默认推送模板。 - - - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 - -:::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 -2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 -::: - -### 发消息时使用推送模板 - -创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： - -:::tip -若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 -::: - -1. 使用固定内容的推送模板，通过 `ext` 扩展字段指定推送模板名称。 - -这种情况下，创建消息时无需传入 `title_args` 和 `content_args` 参数。 - -```dart - final msg = EMMessage.createTxtSendMessage( - targetId: 'userId', - content: '消息内容', - ); - - msg.attributes = { - // 设置推送模板名称'test7'。若不指定，设置默认推送模板的信息。 - 'em_push_template': {'name': 'test7'}, - }; - - await EMClient.getInstance.chatManager.sendMessage(msg); -``` - -2. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数： - -- `{$dynamicFrom}`：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。 -- `{$fromNickname}`：推送昵称。 -- `{$msg}`：消息内容。 - -群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下： - -```json - { - "ext":{ - "em_push_ext":{ - "group_user_nickname":"Jane" - } - } - } -``` - -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 - -这种方式的示例代码与“使用固定内容的推送模板”的相同。 - -3. 使用自定义推送模板，而且推送标题和推送内容为自定义参数： - -例如，推送模板的设置如下图所示： - -![img](/images/android/push/push_template_custom.png) - -使用下面的示例代码后，通知栏中弹出的推送通知为： - -![img](/images/android/push/push_template_custom_example.png) - -```dart - final msg = EMMessage.createTxtSendMessage( - targetId: 'userId', - content: '消息内容', - ); - - msg.attributes = { - 'em_push_template': { - // 设置推送模板名称。若不指定，设置默认推送模板的信息。 - 'name': 'push', - 'title_args': ['您', '消息'], - 'content_args': ['请', '查看'], - }, - }; - - await EMClient.getInstance.chatManager.sendMessage(msg); -``` - -### 消息接收方使用推送模板 - -消息接收方可以调用 `setPushTemplate` 方法传入推送模板名称，选择要使用的模板。 - -:::tip -若发送方在发送消息时使用了推送模板，则推送通知栏中的显示内容以发送方的推送模板为准。 -::: - -```dart -try { - await EMClient.getInstance.pushManager.setPushTemplate('Template Name'); -} on EMError catch (e) {} -``` - -## 使用消息扩展字段 - -创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 - -```dart -EMMessage msg = EMMessage.createTxtSendMessage( - targetId: 'receiveId', - content: 'content', -); -msg.attributes = { - // 将推送扩展设置到消息中。该字段为内置的推送扩展字段。 - 'em_push_ext': { - // 自定义推送消息标题。该字段为内置内置字段，字段名不可修改。 - 'em_push_title': 'custom push title', - // 自定义推送消息内容。该字段为内置内置字段，字段名不可修改。 - 'em_push_content': 'custom push content' - } -}; - -try { - await EMClient.getInstance.chatManager.sendMessage(msg); -} on EMError catch (e) {} -``` - -自定义显示字段的数据结构如下： - -```dart -{ - "em_apns_ext": { - "em_push_title": "custom push title", - "em_push_content": "custom push content" - } -} -``` - -| 参数 | 描述 | -| :---------------- | :----------- | -| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | -| `em_push_title` | 自定义字段 key，用于设置自定义的标题，该值为固定值，不可修改。 | -| `em_push_content` | 自定义字段 key，用于设置自定义的内容，该值为固定值，不可修改。 | - - diff --git a/docs/document/flutter/push/push_display_attribute.md b/docs/document/flutter/push/push_display_attribute.md new file mode 100644 index 000000000..9222b8b0f --- /dev/null +++ b/docs/document/flutter/push/push_display_attribute.md @@ -0,0 +1,48 @@ +# 设置和获取推送通知的显示属性 + +## 设置推送通知的显示属性 + +你可以分别调用 `updatePushNickname` 和 `updatePushDisplayStyle` 方法设置推送通知中显示的昵称（`nickname`）和通知显示样式（`DisplayStyle`），确定通知栏中的推送标题和推送内容。 + +```dart +try { + EMClient.getInstance.pushManager.updatePushNickname('nickname'); +} on EMError catch (e) {} +``` + +```dart +try { + EMClient.getInstance.pushManager.updatePushDisplayStyle(DisplayStyle.Simple); +} on EMError catch (e) {} +``` + +若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。该参数有如下两种设置： + +| 参数值 | 描述 | +| :--------------- | :---------------------- | +| （默认）`Simple` | 不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | +| `Summary` | `Summary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `Summary` 时生效，在 `Simple` 时不生效。 | + +下表以单聊文本消息为例介绍这显示属性的设置。 + +对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 + +| 参数设置 | 推送显示 | 图片 | +| :--------- | :----- |:------------- | +|
- `DisplayStyle`：（默认）`Simple`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| +|
- `DisplayStyle`：`Summary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | +|
- `DisplayStyle`：`Summary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| + +## 获取推送通知的显示属性 + +你可以调用 `fetchPushConfigsFromServer` 方法获取推送通知中的显示属性，如以下代码示例所示： + +```dart +try { + EMPushConfigs configs = await EMClient.getInstance.pushManager.fetchPushConfigsFromServer(); + // 获取推送显示昵称。 + String? pushNickname = configs.displayName; + // 获取推送通知的显示样式。 + DisplayStyle pushDisplayStyle = configs.displayStyle; +} on EMError catch (e) {} +``` \ No newline at end of file diff --git a/docs/document/flutter/push/push_display_field.md b/docs/document/flutter/push/push_display_field.md new file mode 100644 index 000000000..2ce3d79cc --- /dev/null +++ b/docs/document/flutter/push/push_display_field.md @@ -0,0 +1,40 @@ +# 使用消息扩展字段 + +创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 + +```dart +EMMessage msg = EMMessage.createTxtSendMessage( + targetId: 'receiveId', + content: 'content', +); +msg.attributes = { + // 将推送扩展设置到消息中。该字段为内置的推送扩展字段。 + 'em_push_ext': { + // 自定义推送消息标题。该字段为内置内置字段，字段名不可修改。 + 'em_push_title': 'custom push title', + // 自定义推送消息内容。该字段为内置内置字段，字段名不可修改。 + 'em_push_content': 'custom push content' + } +}; + +try { + await EMClient.getInstance.chatManager.sendMessage(msg); +} on EMError catch (e) {} +``` + +自定义显示字段的数据结构如下： + +```dart +{ + "em_apns_ext": { + "em_push_title": "custom push title", + "em_push_content": "custom push content" + } +} +``` + +| 参数 | 描述 | +| :---------------- | :----------- | +| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | +| `em_push_title` | 自定义字段 key，用于设置自定义的标题，该值为固定值，不可修改。 | +| `em_push_content` | 自定义字段 key，用于设置自定义的内容，该值为固定值，不可修改。 | \ No newline at end of file diff --git a/docs/document/flutter/push/push_display_overview.md b/docs/document/flutter/push/push_display_overview.md new file mode 100644 index 000000000..911326d44 --- /dev/null +++ b/docs/document/flutter/push/push_display_overview.md @@ -0,0 +1,13 @@ +# 设置推送通知的显示内容 + +通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： + +1. **设置推送通知的显示属性**：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`Simple`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 +2. **使用默认推送模板**：若有默认模板 `default`，发消息时无需指定。 +3. **使用消息扩展字段**：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 +4. **接收方设置了推送模板**。 +5. **使用自定义推送模板**：发送消息时通过消息扩展字段指定推送模板名称。 + +:::tip +推送模板为离线推送的高级功能，使用前需要在环信控制台开启。 +::: \ No newline at end of file diff --git a/docs/document/flutter/push/push_easemob_console.md b/docs/document/flutter/push/push_easemob_console.md index d4c239ab5..af1e1b824 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..996102f93 100644 --- a/docs/document/flutter/push/push_notification_mode_dnd.md +++ b/docs/document/flutter/push/push_notification_mode_dnd.md @@ -2,10 +2,6 @@ 为优化用户在处理大量推送通知时的体验，即时通讯 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -![image](/images/android/push/push_android_enable_push.png) - ## 推送通知方式 推送通知方式 `ChatPushRemindType` 包含三种类型，如下表所示。其中，会话级别的 `ChatPushRemindType` 设置优先于 app 级别的设置，未设置推送通知方式的会话默认采用 app 的设置。例如，假设 app 的推送方式设置为 `MENTION_ONLY`，而指定会话的推送方式设置为 `ALL`。你会收到来自该会话的所有推送通知，而对于其他会话来说，你只会收到提及你的消息的推送通知。 @@ -58,8 +54,8 @@ await EMClient.getInstance.pushManager.syncConversationsSilentMode(); ## 免打扰模式 在你完成 SDK 初始化和成功登录 app 后，可以对 app 以及各类型的会话开启离线推送功能以及通过设置免打扰模式关闭推送。 - -你可以在 app 级别指定免打扰时间段和免打扰时长，即时通讯 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 +- 你可以通过 `silentModeInterval` 参数开启全天免打扰和关闭免打扰模式：若开始时间和结束时间相同，免打扰模式则全天生效；若设置为 `0:0`-`0:0`，则关闭免打扰模式。 +- 你可以在 app 级别指定免打扰时间段和免打扰时长，即时通讯 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 免打扰时间参数的说明如下表所示： diff --git a/docs/document/flutter/push/push_overview.md b/docs/document/flutter/push/push_overview.md index 336e85e82..fa165ba51 100644 --- a/docs/document/flutter/push/push_overview.md +++ b/docs/document/flutter/push/push_overview.md @@ -12,22 +12,7 @@ 2. 应用在后台运行或手机锁屏等情况，若客户端未断开与服务器的连接，则即时通讯 IM 不会收到离线推送通知。 -## 离线推送高级功能 - -如果需要离线推送的高级功能，需在[环信即时通讯控制台](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)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - -- 所有设备离线时，才发送推送消息； -- 任一设备离线时，都发送推送消息。 - -**注意**：多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。 - -![image](/images/android/push/push_multidevice_policy.png) - -## 技术原理 +## 推送原理 ### Android 平台离线推送 @@ -46,7 +31,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#绑定推送信息)。 ::: @@ -65,11 +50,28 @@ 7. 环信服务器将消息发送给 APNs 推送服务器。 8. APNs 推送服务器将消息发送给用户 B。 +## 推送模板 + +推送模板是离线推送的高级功能。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面激活。**激活后，如需关闭推送模板功能，必须联系商务，因为该操作会删除推送模板相关的所有配置。** + +推送模板的配置和使用，详见 [相关文档介绍](push_template.html)。 + +## 多设备离线推送策略 + +多设备登录时，可在 [环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： + +- 所有设备离线时，才发送推送消息； +- 任一设备离线时，都发送推送消息。 + +**多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。** + +![image](/images/android/push/push_multidevice_policy.png) + ## 前提条件 -1. 已开启即时通讯 IM ，详见[开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 -2. 了解即时通讯 IM 套餐包中的 API 调用频率限制，详见[使用限制](/product/limitation.html)。 -3. 若使用[推送高级功能](#离线推送高级功能)，需在[环信即时通讯控制台](https://console.easemob.com/user/login)上激活。 +1. 已开启即时通讯 IM ，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +2. 了解即时通讯 IM 套餐包中的 API 调用频率限制，详见 [使用限制](/product/limitation.html)。 +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 3094c1bf6..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)。 ## 项目设置 @@ -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/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 43d4542e9..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/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..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/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..71580a6ee 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..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/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`。 @@ -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 fbfec5a58..0f37a3c2f 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#增值服务费用)。 ## 实现方法 @@ -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/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..289e883af 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 注册 @@ -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 deleted file mode 100644 index 5964d1a3f..000000000 --- a/docs/document/harmonyos/push/push_display.md +++ /dev/null @@ -1,187 +0,0 @@ -# 设置推送通知的显示内容 - -通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： - -- 调用 `updatePushNickname` 接口设置推送显示属性。 -- 使用推送模板。 - -## 设置推送显示属性 - -你可以调用 `updatePushNickname` 设置推送通知中显示的昵称，如以下代码示例所示： - -```typescript -ChatClient.getInstance().pushManager()?.updatePushNickname(pushNickname).then(() => { - // success logic -}).catch((e: ChatError) => { - // failure logic -}); -``` - -你也可以调用 `updatePushDisplayStyle` 设置推送通知的显示样式，如下代码示例所示： - -```typescript -// 设置为简单样式。 -const displayStyle = PushDisplayStyle.SimpleBanner; -ChatClient.getInstance().pushManager()?.updatePushDisplayStyle(displayStyle).then(() => { - // success logic -}).catch((e: ChatError) => { - // failure logic -}) -``` - -| 参数设置 | 推送显示 | 图片 | -| :--------- | :----- |:------------- | -|
- `PushDisplayStyle`：（默认）`SimpleBanner`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| -|
- `PushDisplayStyle`：`MessageSummary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | -|
- `PushDisplayStyle`：`MessageSummary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| - -## 使用推送模板 - -推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 - -你可以通过以下两种方式设置： - -- [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 - -使用推送模板有以下优势： - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式。 - -**推送通知栏内容设置的使用优先级** - -通知栏中显示的推送标题和内容可通过以下方式设置，优先级为由低到高： - -1. 发送消息时使用默认的推送标题和内容：设置推送通知的展示方式 `PushDisplayStyle`。推送标题为“您有一条新消息”，推送内容为“请点击查看”。 -2. 发送消息时使用默认模板：若有默认模板 `default`，发消息时无需指定。 -3. 接收方设置了推送模板。 -4. 发送消息时通过消息扩展字段指定模板名称。 - -:::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 -::: - -#### **发送消息时使用推送模板** - -创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： - -:::tip -若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 -::: - -1. 使用固定内容的推送模板，通过 `ext` 扩展字段指定推送模板名称。 - -这种情况下，创建消息时无需传入 `title_args` 和 `content_args` 参数。 - -```typescript -// 先定义一个推送模版类 -export class PushTemplate { - // 模版名称 - name?: string; - // 标题自定设置部分 - title_args?: string[]; - // 内容自定设置部分 - content_args?: string[]; -} - -// 下面以文本消息为例，其他类型的消息设置方法相同。 -const message = ChatMessage.createTextSendMessage(conversationId, "消息内容"); -if (message) { - // 设置推送模板名称。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 - // 若为默认模板 `default`，无需传入模板名称。 - // 若为自定义模板，需传入模板名称。 - let templateName = "自定义推送模板名称"; - // 1.6.0版本之前版本需要先将 PushTemplate 转为 JSON，例如：let pushTemplateStr = JSON.stringify(pushTemplate); - message?.setJsonAttribute("em_push_template", { - name: templateName - } as PushTemplate); - // 发送消息。 - ChatClient.getInstance().chatManager()?.sendMessage(message); -} -``` - -2. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数： -- `{$dynamicFrom}`：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。 -- `{$fromNickname}`：推送昵称。 -- `{$msg}`：消息内容。 - -群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下： - -```json -{ - "ext":{ - "em_push_ext":{ - "group_user_nickname":"Jane" - } - } -} -``` - -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 - -这种方式的示例代码与“使用固定内容的推送模板”的相同。 - -3. 使用自定义推送模板，而且推送标题和推送内容为自定义参数： - -例如，推送模板的设置如下图所示： - -![img](/images/android/push/push_template_custom.png) - -使用下面的示例代码后，通知栏中弹出的推送通知为： - -您收到了一条消息
-请及时查看 - -```typescript -// 先定义一个推送模版类 -export class PushTemplate { - // 模版名称 - name?: string; - // 标题自定设置部分 - title_args?: string[]; - // 内容自定设置部分 - content_args?: string[]; -} - -// 下面以文本消息为例，其他类型的消息设置方法相同。 -const message = ChatMessage.createTextSendMessage(conversationId, "消息内容"); -if (message) { - // 设置推送模板名称。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 - // 设置填写模板标题的 value 数组。 - let titleArgs = ["您","消息,"]; - // 设置填写模板内容的 value 数组。 - let contentArgs = ["请","查看"]; - let templateName = "push"; // 此处 `push` 为已在创建的推送模版名称。 - // 设置推送模板名称。若不指定，设置默认推送模板的信息。 - // 1.6.0版本之前版本需要先将 PushTemplate 转为 JSON，例如：let pushTemplateStr = JSON.stringify(pushTemplate); - message?.setJsonAttribute("em_push_template", { - name: templateName, - title_args: titleArgs, - content_args: contentArgs - } as PushTemplate); - // 发送消息。 - ChatClient.getInstance().chatManager()?.sendMessage(message); -} -``` - -#### **消息接收方使用推送模板** - -消息接收方可以调用 `setPushTemplate` 方法传入推送模板名称，选择要使用的模板。 - -:::tip -若发送方在发送消息时使用了推送模板，则推送通知栏中的显示内容以发送方的推送模板为准。 -::: - -```typescript -ChatClient.getInstance().pushManager()?.setPushTemplate("自定义模板名称").then(() => { - // success logic -}).catch((e: ChatError) => { - // failure logic -}) -``` diff --git a/docs/document/harmonyos/push/push_display_attribute.md b/docs/document/harmonyos/push/push_display_attribute.md new file mode 100644 index 000000000..92b8db11e --- /dev/null +++ b/docs/document/harmonyos/push/push_display_attribute.md @@ -0,0 +1,37 @@ +# 设置推送显示属性 + +你可以调用 API 设置通知栏中显示的推送昵称、推送标题和推送内容。 + +这种方式的优先级低于 [使用推送模板](push_template.html)。 + +## 设置推送昵称 + +你可以调用 `updatePushNickname` 设置推送通知中显示的昵称，如以下代码示例所示： + +```typescript +ChatClient.getInstance().pushManager()?.updatePushNickname(pushNickname).then(() => { + // success logic +}).catch((e: ChatError) => { + // failure logic +}); +``` + +## 设置推送标题和推送内容 + +你也可以调用 `updatePushDisplayStyle` 设置推送通知栏的内容显示样式，如下代码示例所示： + +```typescript +// 设置为简单样式。 +const displayStyle = PushDisplayStyle.SimpleBanner; +ChatClient.getInstance().pushManager()?.updatePushDisplayStyle(displayStyle).then(() => { + // success logic +}).catch((e: ChatError) => { + // failure logic +}) +``` + +| 参数设置 | 推送显示 | 图片 | +| :--------- | :----- |:------------- | +|
- `PushDisplayStyle`：（默认）`SimpleBanner`
- `nickname`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png)| +|
- `PushDisplayStyle`：`MessageSummary`
- `nickname`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** |![img](/images/android/push/push_displayattribute_2.png) | +|
- `PushDisplayStyle`：`MessageSummary`
- `nickname`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png)| 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..917d2702d 100644 --- a/docs/document/harmonyos/push/push_notification_mode_dnd.md +++ b/docs/document/harmonyos/push/push_notification_mode_dnd.md @@ -2,10 +2,6 @@ 环信即时通讯 IM 支持你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -![image](/images/android/push/push_android_enable_push.png) - ## 推送通知方式 推送通知方式 `PushRemindType` 包含三种类型，如下表所示。其中，会话级别的 `PushRemindType` 设置优先于 app 级别的设置，未设置推送通知方式的会话默认采用 app 的设置。例如，假设 app 的推送方式设置为 `MENTION_ONLY`，而指定会话的推送方式设置为 `ALL`。你会收到来自该会话的所有推送通知，而对于其他会话来说，你只会收到提及你的消息的推送通知。 @@ -104,7 +100,8 @@ ChatClient.getInstance().addMultiDevicesListener(multiDevicesListener); 完成 SDK 初始化和成功登录 app 后，你可以对 app 以及各类型的会话开启离线推送功能以及通过设置免打扰模式关闭推送。 -你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 +- 你可以通过 `SILENT_MODE_INTERVAL` 参数开启全天免打扰和关闭免打扰模式：若开始时间和结束时间相同，免打扰模式则全天生效；若设置为 `0:00`-`0:00`，则关闭免打扰模式。 +- 你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 免打扰时间参数的说明如下表所示： diff --git a/docs/document/harmonyos/push/push_overview.md b/docs/document/harmonyos/push/push_overview.md index d80687cec..a727dd124 100644 --- a/docs/document/harmonyos/push/push_overview.md +++ b/docs/document/harmonyos/push/push_overview.md @@ -4,13 +4,13 @@ 即时通讯 IM 支持集成第三方消息推送服务，为 HarmonyOS 开发者提供低延时、高送达、高并发、不侵犯用户个人数据的离线消息推送服务。 -要体验离线推送功能，请点击[这里](https://www.easemob.com/download/demo)下载即时推送 IM 的 demo。 +要体验离线推送功能，请在 [环信官网](https://www.easemob.com/download/demo) 下载即时通讯 IM 的 demo。 ## 离线推送过程 客户端断开连接或应用进程被关闭等原因导致用户离线时，即时通讯 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 不会发送离线推送通知：** @@ -18,22 +18,7 @@ 2. 应用在后台运行或手机锁屏等情况，若客户端未断开与服务器的连接，则即时通讯 IM 不会收到离线推送通知。 -## 离线推送高级功能 - -如果需要离线推送的高级功能，需在[环信即时通讯控制台](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)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - -- 所有设备离线时，才发送推送消息； -- 任一设备离线时，都发送推送消息。 - -**注意**：多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。 - -![image](/images/android/push/push_multidevice_policy.png) - -## 技术原理 +## 推送原理 ![image](/images/harmonyos/push/harmonyos_flowchart.png) @@ -47,12 +32,29 @@ 6. 环信服务器将将消息发送给华为 Auth 服务端。 7. 华为 Auth 服务端将消息发送给用户 B。 +## 推送模板 + +推送模板是离线推送的高级功能。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面激活。**激活后，如需关闭推送模板功能，必须联系商务，因为该操作会删除推送模板相关的所有配置。** + +推送模板的配置和使用，详见 [相关文档介绍](push_template.html)。 + +## 多设备离线推送策略 + +多设备登录时，可在 [环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： + +- 所有设备离线时，才发送推送消息； +- 任一设备离线时，都发送推送消息。 + +**多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。** + +![image](/images/android/push/push_multidevice_policy.png) + ## 前提条件 -- 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)。 +- 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/console/app_create.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 074997a24..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)。 ## 准备开发环境 @@ -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..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/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..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/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..7b74ec921 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..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/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](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 733f76094..e3385aed0 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#增值服务费用)。 ## 实现方法 @@ -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_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/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 a16a939a5..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/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)。 ## 实现方法 @@ -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..36df1fca1 100644 --- a/docs/document/ios/push/push_apns.md +++ b/docs/document/ios/push/push_apns.md @@ -48,7 +48,7 @@ ![image](/images/ios/push/push_ios_10_register_confirm_appid.jpeg) -### **步骤三 创建 app 的 APS 证书** +### **步骤三 创建 app 的 APNs 证书** 1. 返回到 App IDs 选择你需要推送的 app。 @@ -110,28 +110,25 @@ ## **上传推送证书** -在[环信即时通讯云控制台](https://console.easemob.com/user/login)上传 APNs 推送证书。 +在[环信控制台](https://console.easemob.com/user/login)上传 APNs 推送证书。 -1. 在[环信即时通讯云控制台](https://console.easemob.com/user/login)首页的**应用列表**中，点击目标应用的**操作**栏中的**管理**。 - -2. 在左侧导航栏中，选择**即时通讯** > **功能配置** > **消息推送** > **证书管理**，点击**添加推送证书**。 - -3. 在**添加推送证书**对话框中选择**苹果**页签，配置 APNs 推送参数。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)，选择你的应用 > **功能配置** > **增值功能** > **即时推送**。 + +2. 在 **证书管理** 页面，点击 **添加推送证书**。在 **添加推送证书** 对话框中选择 **苹果**页签，配置 APNs 推送参数。 -![image](/images/ios/push/push_ios_25_upload_cert.png) +![img](/images/console/push_certificate_apns.png) | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :----------------------- | -| **证书类型** | | 是 | 消息推送证书类型，目前支持 **p8** 和 **p12**。 | -| **证书名称** | String | 是 | 消息推送证书名称。[创建推送证书](#在苹果开发者平台创建推送证书)的[步骤四](#步骤四-生成推送证书)中创建的消息推送证书名称。 | -| **推送密钥** | String | 是 | 消息推送证书密钥。填写在[创建推送证书](#在苹果开发者平台创建推送证书)的[步骤四](#步骤四-生成推送证书)中导出消息推送证书文件时设置的证书密钥。该参数仅在使用 p12 证书时需要配置。 | -| **上传文件** | File | 是 | 点击 **上传证书** 上传[创建推送证书](#在苹果开发者平台创建推送证书)的[步骤四](#步骤四-生成推送证书)中获取的消息推送证书文件。 | -| **key id** | String | 是 | 输入推送证书的 Key ID。该参数仅在使用 p8 证书时需要配置。 | -| **team id** | String | 是 | 输入推送证书的 Team ID。该参数仅在使用 p8 证书时需要配置。 | -| **集成环境** | | 是 | 集成环境：
- **Development**：开发环境；
- **Production**：生产环境。 | -| **Bundle ID** | String | 是 | 绑定 ID。[创建推送证书](#在苹果开发者平台创建推送证书)的[步骤二](#步骤二-创建-app-id)中创建 App ID 时设置的 Bundle ID。
- 上传 VoIP 服务证书时，Bundle ID 末尾需要加 .voip 后缀 -`nvyvtp.dabaoiian`，例如，**Bundle ID** 为 **com.example.demo**，上传对应 VoIP 证书时需要填写 **com.example.demo.voip**。| -| **铃声** | String | 否 | 接收方收到推送通知时的铃声提醒。 | +| 证书类型 | | 是 | 消息推送证书类型，目前支持 **p8** 和 **p12**。 | +| 证书名称 | String | 是 | 消息推送证书名称。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书) 的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中创建的消息推送证书名称。 | +| 推送密钥 | String | 否 | 消息推送证书密钥。填写在 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中导出消息推送证书文件时设置的证书密钥。该参数仅在使用 p12 证书时需要配置。 | +| 上传文件 | File | 是 | 点击 **上传证书** 上传推送证书文件。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中获取的消息推送证书文件。 | +| key id | String | 是 | 输入推送证书的 Key ID。该参数仅对 p8 证书有效。 | +| team id | String | 是 | 输入推送证书的 Team ID。该参数仅对 p8 证书有效。 | +| 集成环境 | | 是 | 集成环境，包括开发环境和生产环境。 | +| Bundle ID | String | 是 | 绑定 ID。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤二](/document/ios/push/push_apns.html#步骤二-创建-app-id) 中创建 App ID 时设置的 Bundle ID。
- 上传 VoIP 服务证书时，Bundle ID 末尾需要加 .voip 后缀 `nvyvtp.dabaoiian`，例如，**Bundle ID** 为 **com.example.demo**，上传对应 VoIP 证书时需要填写 **com.example.demo.voip**。| +| 铃声 | String | 否 | 接收方收到推送通知时的铃声提醒，该参数仅对离线推送有效：
- 设置的铃声最多为 30 秒。若超过该时间，系统会启用默认铃声 default。
- 铃声文件只支持 aiff、wav 和 caf 格式，例如铃声命名 test.caf。
- 铃声文件必须放在 app 的 /Library/Sounds 目录中。
- 如果铃声文件未找到，或不填，响铃为系统默认铃声。 | ## **在客户端集成 APNs** @@ -194,16 +191,16 @@ DeviceToken 注册后，iOS 系统会通过以下方式将 DeviceToken 回调给 1. 在设备上登录应用，并确认 device token 绑定成功。 - 可以查看日志或调用[获取用户详情的 RESTful 接口](/document/server-side/account_system.html#获取单个用户的详情)确认 device token 是否绑定成功。 + 可以查看日志或调用 [获取用户详情的 RESTful 接口](/document/server-side/account_system.html#获取单个用户的详情)确认 device token 是否绑定成功。 2. 杀掉应用进程。 -3. 在[环信即时通讯控制台](https://console.easemob.com/user/login)发送测试消息。 +3. 在[环信控制台](https://console.easemob.com/user/login)发送测试消息。 - 在左侧导航栏中选择 **即时通讯** > **运营服务** > **用户管理**。在**用户管理**页面中，在对应用户 ID 的**操作**栏中点击**更多**，然后选择**发送rest消息**。在弹出的对话框中选择消息类型，输入消息内容，然后点击**发送**。 + 在左侧导航栏中选择 **运营管理** > **运营操作** > **用户管理**。在 **用户管理** 页面中，在对应用户 ID 的 **操作** 栏中点击 **更多**，然后选择 **发送rest消息**。在弹出的对话框中选择消息类型，输入消息内容，然后点击**发送**。 :::tip - 在**证书管理**页面中证书列表中，在每个证书的**操作**一栏中，点击 **更多** > **测试**，这里是直接调用第三方接口推送，而**用户管理**页面中的消息发送测试是先调用即时通讯 IM 的发消息的接口，满足条件后（即用户离线、推送证书有效且绑定了 device token）再调第三方的接口进行推送。 + 在 **证书管理** 页面中证书列表中，在每个证书的**操作**一栏中，点击 **更多** > **测试**，这里是直接调用第三方接口推送，而 **用户管理** 页面中的消息发送测试是先调用即时通讯 IM 的发消息的接口，满足条件后（即用户离线、推送证书有效且绑定了 device token）再调第三方的接口进行推送。 ::: 1. 查看设备是否收到推送通知。 @@ -212,9 +209,9 @@ DeviceToken 注册后，iOS 系统会通过以下方式将 DeviceToken 回调给 1. 检查在即时通讯 IM 中是否正确集成或启用了 APNs 推送。 - 在左侧导航栏中选择**运营服务** > **用户管理**。在**用户管理**页面中，在对应用户 ID 的**操作**栏中选择**查看IM用户绑定推送证书**。在弹出框中查看是否正确显示了证书名称和 device token。 + 在左侧导航栏中选择 **运营管理** > **运营操作** > **用户管理**。在 **用户管理** 页面中，在对应用户 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 deleted file mode 100644 index 8036bbf96..000000000 --- a/docs/document/ios/push/push_display.md +++ /dev/null @@ -1,250 +0,0 @@ -# 设置推送通知的显示内容 - -通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： - -1. **设置推送通知的显示属性**：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`EMPushDisplayStyleSimpleBanner`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 -2. **使用默认推送模板**：若有默认模板 `default`，发消息时无需指定。 -3. **使用消息扩展字段**：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 -4. **接收方设置了推送模板**。 -5. **使用自定义推送模板**：发送消息时通过消息扩展字段指定推送模板名称。 - -## 设置和获取推送通知的显示属性 - -### 设置推送通知的显示属性 - -你可以调用 `updatePushDisplayName` 设置推送通知中显示的昵称，如以下代码示例所示： - -```objectivec -// 异步方法 -[EMClient.sharedClient.pushManager updatePushDisplayName:@"displayName" completion:^(NSString * aDisplayName, EMError * aError) { - if (aError) { - NSLog(@"update push display name error: %@", aError.errorDescription); - } -}]; -``` - -你也可以调用 `updatePushDisplayStyle` 设置推送通知的显示样式，如下代码示例所示： - -```objectivec -// 异步方法 -[EMClient.sharedClient.pushManager updatePushDisplayStyle:EMPushDisplayStyleSimpleBanner completion:^(EMError * aError) -{ - if (aError) { - NSLog(@"update display style error --- %@", aError.errorDescription); - } -}]; -``` - -若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。`DisplayStyle` 是枚举类型，有如下两种设置： - -| 参数值 | 描述 | -| :--------------- | :---------------------- | -| （默认）`EMPushDisplayStyleSimpleBanner` | 不论 `displayName` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | -| `EMPushDisplayStyleMessageSummary` | `EMPushDisplayStyleMessageSummary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `EMPushDisplayStyleMessageSummary` 时生效，在 `EMPushDisplayStyleSimpleBanner` 时不生效。 | - -下表以**单聊文本消息**为例介绍显示属性的设置。 - -对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 - -| 参数设置 | 推送显示 | 图片 | -| :--------- | :----- |:------------- | -|
- `DisplayStyle`：（默认）`EMPushDisplayStyleSimpleBanner`
- `displayName`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png) | -|
- `DisplayStyle`：`EMPushDisplayStyleMessageSummary`
- `displayName`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** | ![img](/images/android/push/push_displayattribute_2.png)| -|
- `DisplayStyle`：`EMPushDisplayStyleMessageSummary`
- `displayName`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png) | - -### 获取推送通知的显示属性 - -你可以调用 `getPushNotificationOptionsFromServerWithCompletion` 方法获取推送通知中的显示属性，如以下代码示例所示： - -```objectivec -// 异步方法 -[EMClient.sharedClient.pushManager getPushNotificationOptionsFromServerWithCompletion:^(EMPushOptions * aOptions, EMError * aError) -{ - if (aError) { - NSLog(@"get push options error --- %@", aError.errorDescription); - } -}]; -``` - -`EMPushOptions` 推送配置对象。 - -| 属性名 | 描述 | -| :------------------- | :----------------------------------------------------------- | -| `displayName` | 对方收到推送时发送方展示的名称。 | -| `displayStyle` | 推送显示类型。 | - -## 使用推送模板 - -推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 - -你可以通过以下两种方式设置： - -- [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 - -使用推送模板有以下优势： - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式： - - - 使用自定义推送模板的优先级高于默认推送模板。 - - - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 - -:::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 -::: - -### 发送消息时使用推送模板 - -创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： - -:::tip -若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 -::: - -1. 使用固定内容的推送模板，通过 `ext` 扩展字段指定推送模板名称。 - -这种情况下，创建消息时无需传入 `title_args` 和 `content_args` 参数。 - -```objectivec -//下面以文本消息为例，其他类型的消息设置方法相同。 -EMTextMessageBody *body = [[EMTextMessageBody alloc]initWithText:@"test"]; -EMChatMessage *message = [[EMChatMessage alloc]initWithConversationID:@"conversationId" from:@"currentUsername" to:@"conversationId" body:body ext:nil]; -//设置推送模板。设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 -NSDictionary *pushObject = @{ - //设置推送模板名称。 - //若为默认模板 `default`，无需传入模板名称。若为自定义模板，需传入模板名称。 - @"name":@"templateName", -}; -message.ext = @{ - @"em_push_template":pushObject, -}; -message.chatType = EMChatTypeChat; -[[EMClient sharedClient].chatManager sendMessage:message progress:nil completion:nil]; -``` - -2. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数： -- `{$dynamicFrom}`：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。 -- `{$fromNickname}`：推送昵称。 -- `{$msg}`：消息内容。 - -群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下： - -```json - { - "ext":{ - "em_push_ext":{ - "group_user_nickname":"Jane" - } - } - } -``` - -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 - -这种方式的示例代码与“使用固定内容的推送模板”的相同。 - -3. 使用自定义推送模板，而且推送标题和推送内容为自定义参数： - -例如，推送模板的设置如下图所示： - -![img](/images/android/push/push_template_custom.png) - -使用下面的示例代码后，通知栏中弹出的推送通知为： - -![img](/images/android/push/push_template_custom_example.png) - -```objectivec -//下面以文本消息为例，其他类型的消息设置方法相同。 -EMTextMessageBody *body = [[EMTextMessageBody alloc]initWithText:@"test"]; -EMChatMessage *message = [[EMChatMessage alloc]initWithConversationID:@"conversationId" from:@"currentUsername" to:@"conversationId" body:body ext:nil]; -//设置推送模板。设置前需在环信即时通讯云管理后台上创建推送模板。 -NSDictionary *pushObject = @{ - //设置推送模板名称。若不指定，设置默认推送模板的信息。 - //设置前需在环信即时通讯云管理后台或调用 REST 接口创建推送模板。 - @"name":@"templateName", - @"title_args":@[@"您",@"消息"],//设置填写模板标题的 value 数组。 - @"content_args":@[@"请",@"查看"]//设置填写模板内容的 value 数组。 -}; -message.ext = @{ - @"em_push_template":pushObject, -}; -message.chatType = EMChatTypeChat; -[[EMClient sharedClient].chatManager sendMessage:message progress:nil completion:nil]; -``` - -### 消息接收方使用推送模板 - -消息接收方可以调用 `setPushTemplate` 方法传入推送模板名称，选择要使用的模板。 - -:::tip -若发送方在发送消息时使用了推送模板，则推送通知栏中的显示内容以发送方的推送模板为准。 -::: - -```objectivec -[EMClient.sharedClient.pushManager setPushTemplate:@"templateName" completion:^(EMError * _Nullable aError) { - -}]; -``` - -## 使用消息扩展字段设置推送通知显示内容 - -创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 - -```objectivec -EMTextMessageBody *body = [[EMTextMessageBody alloc] initWithText:@"test"]; -EMChatMessage *message = [[EMChatMessage alloc] initWithConversationID:conversationId from:currentUsername to:conversationId body:body ext:nil]; -message.ext = @{@"em_apns_ext":@{ - @"em_push_title": @"customTitle", - @"em_alert_subTitle": @"customSubTitle", - @"em_push_content": @"customContent" -}}; - -message.chatType = EMChatTypeChat; -[EMClient.sharedClient.chatManager sendMessage:message progress:nil completion:nil]; -``` - -| 参数 | 描述 | -| :-------------------- | :----------------------------------------------------------- | -| `body` | 消息体。 | -| `ConversationID` | 消息所属的会话 ID。 | -| `from` | 消息发送方，一般为当前登录 ID。 | -| `to` | 消息接收方 ID，一般与 `ConversationID` 一致。 | -| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | -| `em_push_title` | 推送通知的自定义标题。 | -| `em_alert_subTitle` | 推送通知的自定义副标题。 | -| `em_push_content` | 推送通知展示的自定义内容。 | - -**解析的内容** - -```json -{ - "aps":{ - "alert":{ - "body":"custom push content" - }, - "badge":1, - "sound":"default" - }, - "f":"6001", - "t":"6006", - "m":"373360335316321408", -} -``` - -| 参数 | 描述 | -| :------ | :-------------- | -| `body` | 显示内容。 | -| `badge` | 角标数。 | -| `sound` | 提示铃声。 | -| `f` | 消息发送方 ID。 | -| `t` | 消息接收方 ID。 | -| `m` | 消息 ID。 | - - diff --git a/docs/document/ios/push/push_display_attribute.md b/docs/document/ios/push/push_display_attribute.md new file mode 100644 index 000000000..2b23c9b4a --- /dev/null +++ b/docs/document/ios/push/push_display_attribute.md @@ -0,0 +1,65 @@ +# 设置和获取推送通知的显示属性 + +## 设置推送通知的显示属性 + +你可以调用 `updatePushDisplayName` 设置推送通知中显示的昵称，如以下代码示例所示： + +```objectivec +// 异步方法 +[EMClient.sharedClient.pushManager updatePushDisplayName:@"displayName" completion:^(NSString * aDisplayName, EMError * aError) { + if (aError) { + NSLog(@"update push display name error: %@", aError.errorDescription); + } +}]; +``` + +你也可以调用 `updatePushDisplayStyle` 设置推送通知的显示样式，如下代码示例所示： + +```objectivec +// 异步方法 +[EMClient.sharedClient.pushManager updatePushDisplayStyle:EMPushDisplayStyleSimpleBanner completion:^(EMError * aError) +{ + if (aError) { + NSLog(@"update display style error --- %@", aError.errorDescription); + } +}]; +``` + +若要在通知栏中显示消息内容，需要设置通知显示样式 `DisplayStyle`。`DisplayStyle` 是枚举类型，有如下两种设置： + +| 参数值 | 描述 | +| :--------------- | :---------------------- | +| （默认）`EMPushDisplayStyleSimpleBanner` | 不论 `displayName` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为**您有一条新消息**，推送内容为**请点击查看**。 | +| `EMPushDisplayStyleMessageSummary` | `EMPushDisplayStyleMessageSummary`：显示消息内容。设置的昵称只在 `DisplayStyle` 为 `EMPushDisplayStyleMessageSummary` 时生效，在 `EMPushDisplayStyleSimpleBanner` 时不生效。 | + +下表以**单聊文本消息**为例介绍显示属性的设置。 + +对于**群聊**，下表中的**消息发送方的推送昵称**和**消息发送方的 IM 用户 ID**显示为**群组 ID**。 + +| 参数设置 | 推送显示 | 图片 | +| :--------- | :----- |:------------- | +|
- `DisplayStyle`：（默认）`EMPushDisplayStyleSimpleBanner`
- `displayName`：设置或不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**请点击查看** | ![img](/images/android/push/push_displayattribute_1.png) | +|
- `DisplayStyle`：`EMPushDisplayStyleMessageSummary`
- `displayName`：设置具体值 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的推送昵称：消息内容** | ![img](/images/android/push/push_displayattribute_2.png)| +|
- `DisplayStyle`：`EMPushDisplayStyleMessageSummary`
- `displayName`：不设置 |
- 推送标题：**您有一条新消息**
- 推送内容：**消息发送方的 IM 用户 ID: 消息内容** | ![img](/images/android/push/push_displayattribute_3.png) | + +## 获取推送通知的显示属性 + +你可以调用 `getPushNotificationOptionsFromServerWithCompletion` 方法获取推送通知中的显示属性，如以下代码示例所示： + +```objectivec +// 异步方法 +[EMClient.sharedClient.pushManager getPushNotificationOptionsFromServerWithCompletion:^(EMPushOptions * aOptions, EMError * aError) +{ + if (aError) { + NSLog(@"get push options error --- %@", aError.errorDescription); + } +}]; +``` + +`EMPushOptions` 推送配置对象。 + +| 属性名 | 描述 | +| :------------------- | :----------------------------------------------------------- | +| `displayName` | 对方收到推送时发送方展示的名称。 | +| `displayStyle` | 推送显示类型。 | + diff --git a/docs/document/ios/push/push_display_field.md b/docs/document/ios/push/push_display_field.md new file mode 100644 index 000000000..546b70a67 --- /dev/null +++ b/docs/document/ios/push/push_display_field.md @@ -0,0 +1,53 @@ +# 使用消息扩展字段设置推送通知显示内容 + +创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 + +```objectivec +EMTextMessageBody *body = [[EMTextMessageBody alloc] initWithText:@"test"]; +EMChatMessage *message = [[EMChatMessage alloc] initWithConversationID:conversationId from:currentUsername to:conversationId body:body ext:nil]; +message.ext = @{@"em_apns_ext":@{ + @"em_push_title": @"customTitle", + @"em_alert_subTitle": @"customSubTitle", + @"em_push_content": @"customContent" +}}; + +message.chatType = EMChatTypeChat; +[EMClient.sharedClient.chatManager sendMessage:message progress:nil completion:nil]; +``` + +| 参数 | 描述 | +| :-------------------- | :----------------------------------------------------------- | +| `body` | 消息体。 | +| `ConversationID` | 消息所属的会话 ID。 | +| `from` | 消息发送方，一般为当前登录 ID。 | +| `to` | 消息接收方 ID，一般与 `ConversationID` 一致。 | +| `em_apns_ext` | 消息扩展，使用扩展的方式向推送中添加自定义字段，该值为固定值，不可修改。 | +| `em_push_title` | 推送通知的自定义标题。 | +| `em_alert_subTitle` | 推送通知的自定义副标题。 | +| `em_push_content` | 推送通知展示的自定义内容。 | + +**解析的内容** + +```json +{ + "aps":{ + "alert":{ + "body":"custom push content" + }, + "badge":1, + "sound":"default" + }, + "f":"6001", + "t":"6006", + "m":"373360335316321408", +} +``` + +| 参数 | 描述 | +| :------ | :-------------- | +| `body` | 显示内容。 | +| `badge` | 角标数。 | +| `sound` | 提示铃声。 | +| `f` | 消息发送方 ID。 | +| `t` | 消息接收方 ID。 | +| `m` | 消息 ID。 | diff --git a/docs/document/ios/push/push_display_overview.md b/docs/document/ios/push/push_display_overview.md new file mode 100644 index 000000000..19f293e24 --- /dev/null +++ b/docs/document/ios/push/push_display_overview.md @@ -0,0 +1,14 @@ +# 设置推送通知的显示内容 + +通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： + +1. **设置推送通知的显示属性**：使用默认的推送标题和内容，即推送通知的展示方式 `DisplayStyle` 采用默认的值（`EMPushDisplayStyleSimpleBanner`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 +2. **使用默认推送模板**：若有默认模板 `default`，发消息时无需指定。 +3. **使用消息扩展字段**：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 +4. **接收方设置了推送模板**。 +5. **使用自定义推送模板**：发送消息时通过消息扩展字段指定推送模板名称。 + +:::tip +推送模板为离线推送的高级功能，使用前需要在环信控制台开启。 +::: + diff --git a/docs/document/ios/push/push_notification_mode_dnd.md b/docs/document/ios/push/push_notification_mode_dnd.md index fa198510f..5bb6ace81 100644 --- a/docs/document/ios/push/push_notification_mode_dnd.md +++ b/docs/document/ios/push/push_notification_mode_dnd.md @@ -2,10 +2,6 @@ 环信即时通讯 IM 3.9.2 及以上版本对离线消息推送进行了优化。你可以在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -推送通知方式和免打扰模式为推送的高级功能，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -![image](/images/ios/push/push_ios_27_enable_push.png) - ## 推送通知方式 为优化用户在处理大量推送通知时的体验，环信 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 @@ -111,7 +107,8 @@ extension ViewController: EMMultiDevicesDelegate { 完成 SDK 初始化和成功登录 app 后，你可以对 app 以及各类型的会话开启离线推送功能以及通过设置免打扰模式关闭推送。 -你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 +- 你可以通过 `EMSilentModeParamTypeInterval` 参数开启全天免打扰和关闭免打扰模式：若开始时间和结束时间相同，免打扰模式则全天生效；若设置为 `0:0`-`0:0`，则关闭免打扰模式。 +- 你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 免打扰时间参数的说明如下表所示： diff --git a/docs/document/ios/push/push_overview.md b/docs/document/ios/push/push_overview.md index 53e45405b..ad01ca260 100644 --- a/docs/document/ios/push/push_overview.md +++ b/docs/document/ios/push/push_overview.md @@ -2,7 +2,7 @@ 即时通讯 IM 支持集成 APNs 消息推送服务，为 iOS 开发者提供低延时、高送达、高并发、不侵犯用户个人数据的离线消息推送服务。 -要体验离线推送功能，请点击[这里](https://www.easemob.com/download/demo)下载即时通讯 IM 的 demo。 +要体验离线推送功能，请在 [环信官网](https://www.easemob.com/download/demo) 下载即时通讯 IM 的 demo。 ## 离线推送过程 @@ -16,22 +16,7 @@ 2. 应用在后台运行或手机锁屏等情况，若客户端未断开与服务器的连接，则即时通讯 IM 不会收到离线推送通知。 -## 离线推送高级功能 - -如果需要离线推送的高级功能，需在[环信即时通讯控制台](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)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - -- 所有设备离线时，才发送推送消息； -- 任一设备离线时，都发送推送消息。 - -**注意**：多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。 - -![image](/images/android/push/push_multidevice_policy.png) - -## **技术原理** +## 推送原理 ![image](/images/ios/push/push_ios_1_understand.png) @@ -46,9 +31,30 @@ 7. 环信服务器将消息发送给 APNs 推送服务器。 8. APNs 推送服务器将消息发送给用户 B。 -:::tip -推送 token（device token）是 APNs 推送提供的推送 token，即初次启动你的应用时，APNs SDK 为客户端应用实例生成的推送 token。该 token 用于标识每台设备上的每个应用，APNs 通过该 token 明确消息是发送给哪个设备的，然后将消息转发给设备，设备再通知应用程序。你可以调用 `registerForRemoteNotifications` 方法获得 token。另外，如果退出即时通讯 IM 登录时不解绑 device token（调用 `logout` 方法时对 `aIsUnbindDeviceToken` 参数传 `NO` 表示不解绑 device token，传 `YES` 表示解绑 token），用户在推送证书有效期和 token 有效期内仍会接收到离线推送通知。 -::: +## 推送证书和推送 Token + +**推送证书**：集成 APNs 离线推送时，需要上传 APNs 推送证书。关于创建和上传 APNs 推送证书，详见 [APNs 推送集成文档](push_apns.html)。 + +**推送 Token**：推送 token（device token）是 APNs 推送提供的推送 token，即初次启动你的应用时，APNs SDK 为客户端应用实例生成的推送 token。该 token 用于标识每台设备上的每个应用，APNs 通过该 token 明确消息是发送给哪个设备的，然后将消息转发给设备，设备再通知应用程序。你可以调用 `registerForRemoteNotifications` 方法获得 token。另外，如果退出即时通讯 IM 登录时不解绑 device token（调用 `logout` 方法时对 `aIsUnbindDeviceToken` 参数传 `NO` 表示不解绑 device token，传 `YES` 表示解绑 token），用户在推送证书有效期和 token 有效期内仍会接收到离线推送通知。 + +关于如何获取推送 Token 并上传至环信服务器，详见 [APNs 推送服务的集成文档](push_apns.html#步骤三-获取-device-token-并传递给-sdk)。 + +## 推送模板 + +推送模板是离线推送的高级功能。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面激活。**激活后，如需关闭推送模板功能，必须联系商务，因为该操作会删除推送模板相关的所有配置。** + +推送模板的配置和使用，详见 [相关文档介绍](push_template.html)。 + +## 多设备离线推送策略 + +多设备登录时，可在 [环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： + +- 所有设备离线时，才发送推送消息； +- 任一设备离线时，都发送推送消息。 + +**多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。** + +![image](/images/android/push/push_multidevice_policy.png) ## 前提条件 diff --git a/docs/document/ios/push/push_solution.md b/docs/document/ios/push/push_solution.md index 661f25bae..f66c2f989 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/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..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/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..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/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..71ad9fcfd 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..3d4297733 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。 @@ -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 89dbfc2e8..1fe9e042a 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#增值服务费用)。 ## 实现方法 @@ -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_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/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 63a1dd096..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/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#开通服务)。 ## 实现方法 @@ -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 2e7e77f06..ba7d7a956 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 注册 @@ -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 deleted file mode 100644 index 0876798fe..000000000 --- a/docs/document/react-native/push/push_display.md +++ /dev/null @@ -1,217 +0,0 @@ -# 设置推送通知的显示内容 - -通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： - -1. 设置推送通知的显示属性； -2. 使用默认推送模板； -3. 使用消息扩展字段； -4. 使用自定义推送模板。 - -## 设置推送通知的显示属性 - -你可以分别调用 `updatePushNickname` 和 `updatePushDisplayStyle` 方法设置推送通知中显示的昵称（`nickname`）和通知显示样式（`displayStyle`），确定通知栏中的推送标题和推送内容。 - -```typescript -ChatClient.getInstance() - .pushManager.updatePushNickname(nickname) - .then(() => { - console.log("Succeeded in updating the nickname."); - }) - .catch((reason) => { - console.log("Failed to update the nickname.", reason); - }); -``` - -```typescript -ChatClient.getInstance() - .pushManager.updatePushDisplayStyle(displayStyle) - .then(() => { - console.log("Succeeded in updating the display style."); - }) - .catch((reason) => { - console.log("Failed to update the display style.", reason); - }); -``` - -你可以调用 `fetchPushOptionFromServer` 方法获取推送通知中的显示属性，如以下代码示例所示： - -```typescript -ChatClient.getInstance() - .pushManager.fetchPushOptionFromServer() - .then(() => { - console.log("Succeeded in getting the push configurations."); - }) - .catch((reason) => { - console.log("Failed to get the push configuration.", reason); - }); -``` - -若要在通知栏中显示消息内容，需要设置通知显示样式 `displayStyle`。该参数有如下两种设置： - -- （默认）`Simple`：不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为“您有一条新消息”，推送内容为“请点击查看”。 -- `Summary`：显示消息内容。设置的昵称只在 `displayStyle` 为 `Summary` 时生效，在 `Simple` 时不生效。 - -下表以单聊文本消息为例介绍这显示属性的设置。 - -:::tip -对于群聊，下表中的“消息发送方的推送昵称”和“消息发送方的 IM 用户 ID”显示为“群组 ID”。 -::: - -| 参数设置 | 推送显示 | 图片 | -| :--------- | :----- |:------------- | -|
  • `displayStyle`：（默认）`Simple`
  • `nickname`：设置或不设置
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“请点击查看”
| ![img](/images/android/push/push_displayattribute_1.png) | -|
  • `displayStyle`：`Summary`
  • `nickname`：设置具体值
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“消息发送方的推送昵称：消息内容”
| ![img](/images/android/push/push_displayattribute_2.png) | -|
  • `displayStyle`：`Summary`
  • `nickname`：不设置
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“消息发送方的 IM 用户 ID: 消息内容”
| ![img](/images/android/push/push_displayattribute_3.png) | - -## 使用推送模板 - -推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 `default` 和自定义推送模板。对于群组消息，你可以使用定向模板向某些用户推送与其他用户不同的离线通知。 - -你可以通过以下两种方式设置： - -- [调用 REST API 配置](/document/server-side/push.html#使用推送模板)。 -- 在[环信即时通讯云控制台](https://console.easemob.com/user/login)设置推送模板，详见[控制台文档](/product/enable_and_configure_IM.html#配置推送模板)。 - -使用推送模板有以下优势： - -1. 自定义修改环信服务端默认推送内容。 - -2. 接收方可以决定使用哪个模板。 - -3. 按优先级选择模板使用方式： - - - 使用自定义推送模板的优先级高于默认推送模板。 - - - 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。 - -:::tip -1. 设置推送模板为推送的高级功能，使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -2. 推送模板相关的数据结构，详见[推送扩展字段](/document/server-side/push_extension.html)。 -::: - -### 发消息时使用推送模板 - -创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况： - -:::tip -若使用默认模板 **default**，消息推送时自动使用默认模板，创建消息时无需传入模板名称。 -::: - -1. 使用固定内容的推送模板，通过 `ext` 扩展字段指定推送模板名称。 - -这种情况下，创建消息时无需传入 `titleArgs` 和 `contentArgs` 参数。 - -```typescript -const message = ChatMessage.createTextMessage("", ""); -// 设置推送模板 -message.attributes = { - em_push_template: { - name: "", - }, -}; -ChatClient.getInstance().chatManager.sendMessage(message, { - onSuccess: (message: ChatMessage): void => { - console.log("send message success.", message); - }, - onError: (localMsgId: string, error: ChatError): void => { - console.log("send message fail:", localMsgId, error); - }, -} as ChatMessageStatusCallback); -``` - -2. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数： - -- `{$dynamicFrom}`：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。 -- `{$fromNickname}`：推送昵称。 -- `{$msg}`：消息内容。 - -群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下： - -```json -{ - "ext": { - "em_push_ext": { - "group_user_nickname": "Jane" - } - } -} -``` - -内置参数的介绍，详见[环信即时通讯控制台文档](/product/enable_and_configure_IM.html#使用默认推送模板)。 - -这种方式的示例代码与“使用固定内容的推送模板”的相同。 - -3. 使用自定义推送模板，而且推送标题和推送内容为自定义参数： - -例如，推送模板的设置如下图所示： - -![img](/images/android/push/push_template_custom.png) - -使用下面的示例代码后，通知栏中弹出的推送通知为： - -![img](/images/android/push/push_template_custom_example.png) - -```typescript -const message = ChatMessage.createTextMessage("", ""); -// 设置推送模板 -message.attributes = { - em_push_template: { - name: "", - title_args: ["", ""], - content_args: ["", ""], - }, -}; -ChatClient.getInstance().chatManager.sendMessage(message, { - onSuccess: (message: ChatMessage): void => { - console.log("send message success.", message); - }, - onError: (localMsgId: string, error: ChatError): void => { - console.log("send message fail:", localMsgId, error); - }, -} as ChatMessageStatusCallback); -``` - -### 消息接收方使用推送模板 - -消息接收方可以调用 `setPushTemplate` 方法传入推送模板名称，选择要使用的模板。 - -:::tip -若发送方在发送消息时使用了推送模板，则推送通知栏中的显示内容以发送方的推送模板为准。 -::: - -```typescript -ChatClient.getInstance() - .pushManager.selectPushTemplate("") - .then(() => { - console.log("success"); - }) - .catch((e) => { - console.warn("fail", e); - }); -``` - -## 使用消息扩展字段设置推送通知显示内容 - -创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 - -```typescript -msg.attributes = { - // 消息扩展字段。该字段为内置内置字段，字段名不可修改。 - em_apns_ext: { - em_push_title: "custom push title", // 自定义推送消息标题。该字段为内置内置字段，字段名不可修改。 - em_push_content: "custom push content", // 自定义推送消息内容。该字段为内置内置字段，字段名不可修改。 - }, -}; -``` - -自定义显示字段的数据结构如下： - -```java -{ - "em_apns_ext": { - "em_push_title": "custom push title", - "em_push_content": "custom push content" - } -} -``` diff --git a/docs/document/react-native/push/push_display_attribute.md b/docs/document/react-native/push/push_display_attribute.md new file mode 100644 index 000000000..c47c28497 --- /dev/null +++ b/docs/document/react-native/push/push_display_attribute.md @@ -0,0 +1,66 @@ +# 设置和获取推送通知的显示属性 + +离线推送通知的显示属性包括通知栏中展示的推送昵称、推送通知标题和推送内容。 + +## 设置推送通知的显示属性 + +调用 `updatePushNickname` 方法设置推送通知栏中显示的昵称（`nickname`）。 + +```typescript +ChatClient.getInstance() + .pushManager.updatePushNickname(nickname) + .then(() => { + console.log("Succeeded in updating the nickname."); + }) + .catch((reason) => { + console.log("Failed to update the nickname.", reason); + }); +``` + +调用 `updatePushDisplayStyle` 方法设置推送通知中推送标题和推送内容的显示样式（`displayStyle`），确定通知栏中的推送标题和推送内容。 + +若要在通知栏中显示消息内容，需要设置通知显示样式 `displayStyle`。该参数有如下两种设置： + +- （默认）`Simple`：不论 `nickname` 是否设置，对于推送任何类型的消息，通知栏采用默认显示设置，即推送标题为“您有一条新消息”，推送内容为“请点击查看”。 +- `Summary`：显示消息内容。设置的昵称只在 `displayStyle` 为 `Summary` 时生效，在 `Simple` 时不生效。 + +```typescript +ChatClient.getInstance() + .pushManager.updatePushDisplayStyle(displayStyle) + .then(() => { + console.log("Succeeded in updating the display style."); + }) + .catch((reason) => { + console.log("Failed to update the display style.", reason); + }); +``` + +下表以单聊文本消息为例介绍这显示属性的设置。 + +:::tip +对于群聊，下表中的“消息发送方的推送昵称”和“消息发送方的 IM 用户 ID”显示为“群组 ID”。 +::: + +| 参数设置 | 推送显示 | 图片 | +| :--------- | :----- |:------------- | +|
  • `displayStyle`：（默认）`Simple`
  • `nickname`：设置或不设置
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“请点击查看”
| ![img](/images/android/push/push_displayattribute_1.png) | +|
  • `displayStyle`：`Summary`
  • `nickname`：设置具体值
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“消息发送方的推送昵称：消息内容”
| ![img](/images/android/push/push_displayattribute_2.png) | +|
  • `displayStyle`：`Summary`
  • `nickname`：不设置
|
  • 推送标题：“您有一条新消息”
  • 推送内容：“消息发送方的 IM 用户 ID: 消息内容”
| ![img](/images/android/push/push_displayattribute_3.png) | + +## 获取推送通知的显示属性 + +你可以调用 `fetchPushOptionFromServer` 方法获取推送通知中的显示属性，如以下代码示例所示： + +```typescript +ChatClient.getInstance() + .pushManager.fetchPushOptionFromServer() + .then(() => { + console.log("Succeeded in getting the push configurations."); + }) + .catch((reason) => { + console.log("Failed to get the push configuration.", reason); + }); +``` + + + diff --git a/docs/document/react-native/push/push_display_field.md b/docs/document/react-native/push/push_display_field.md new file mode 100644 index 000000000..486489505 --- /dev/null +++ b/docs/document/react-native/push/push_display_field.md @@ -0,0 +1,24 @@ +# 使用消息扩展字段设置推送通知显示内容 + +创建推送消息时，你可以设置消息扩展字段自定义要显示的推送标题 `em_push_title` 和推送内容 `em_push_content`。 + +```typescript +msg.attributes = { + // 消息扩展字段。该字段为内置内置字段，字段名不可修改。 + em_apns_ext: { + em_push_title: "custom push title", // 自定义推送消息标题。该字段为内置内置字段，字段名不可修改。 + em_push_content: "custom push content", // 自定义推送消息内容。该字段为内置内置字段，字段名不可修改。 + }, +}; +``` + +自定义显示字段的数据结构如下： + +```java +{ + "em_apns_ext": { + "em_push_title": "custom push title", + "em_push_content": "custom push content" + } +} +``` diff --git a/docs/document/react-native/push/push_display_overview.md b/docs/document/react-native/push/push_display_overview.md new file mode 100644 index 000000000..f67cdddb4 --- /dev/null +++ b/docs/document/react-native/push/push_display_overview.md @@ -0,0 +1,13 @@ +# 设置推送通知的显示内容 + +通知收到后，通知栏中显示的推送标题和内容可通过以下方式设置，配置的优先级为由低到高： + +1. **设置推送通知的显示属性**：使用默认的推送标题和内容，即推送通知的展示方式 `displayStyle` 采用默认的值（`Simple`）。推送标题为**您有一条新消息**，推送内容为**请点击查看**。 +2. **使用默认推送模板**：若有默认模板 `default`，发消息时无需指定。 +3. **使用消息扩展字段**：使用扩展字段自定义要显示的推送标题和推送内容，即 `em_push_title` 和 `em_push_content`。 +4. **接收方设置了推送模板**。 +5. **使用自定义推送模板**：发送消息时通过消息扩展字段指定推送模板名称。 + +:::tip +推送模板为离线推送的高级功能，使用前需要 [在环信控制台开启](push_template.html#开通服务)。 +::: \ No newline at end of file diff --git a/docs/document/react-native/push/push_easemob_console.md b/docs/document/react-native/push/push_easemob_console.md index bf479e362..86209305c 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..20e1fb6f0 100644 --- a/docs/document/react-native/push/push_notification_mode_dnd.md +++ b/docs/document/react-native/push/push_notification_mode_dnd.md @@ -2,10 +2,6 @@ 为优化用户在处理大量推送通知时的体验，环信即时通讯 IM 在 app 和会话层面提供了推送通知方式和免打扰模式的细粒度选项。 -**推送通知方式和免打扰模式为推送的高级功能**，若要设置，你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务，因为该操作会删除所有相关配置。 - -![image](/images/android/push/push_android_enable_push.png) - ## 推送通知方式 推送通知方式 `remindType` 包含三种类型，如下表所示。其中，会话级别的 `remindType` 设置优先于 app 级别的设置，未设置推送通知方式的会话默认采用 app 的设置。例如，假设 app 的推送方式设置为 `MENTION_ONLY`，而指定会话的推送方式设置为 `ALL`。你会收到来自该会话的所有推送通知，而对于其他会话来说，你只会收到提及你的消息的推送通知。 @@ -58,13 +54,15 @@ ## 免打扰模式 -你可以在 app 级别指定免打扰时间段和免打扰时长，即时通讯 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 +完成 SDK 初始化和成功登录 app 后，你可以对 app 以及各类型的会话开启离线推送功能以及通过设置免打扰模式关闭推送。 +- 你可以通过 `startTime` 和 `endTime` 参数开启全天免打扰和关闭免打扰模式：若开始时间和结束时间相同，免打扰模式则全天生效；若设置为 `0:0`-`0:0`，则关闭免打扰模式。 +- 你可以在 app 级别指定免打扰时间段和免打扰时长，环信 IM 在这两个时间段内不发送离线推送通知。若既设置了免打扰时间段，又设置了免打扰时长，免打扰模式的生效时间为这两个时间段的累加。 免打扰时间参数的说明如下表所示： | 免打扰时间参数 | 类型 |描述 | 应用范围 | | :------------------- | :--------------------------- | :--------------------------- | :------------------- | -| `startTime` - `endTime` | Int |每天定时触发离线推送免打扰的时间段，采用 24 小时制，精确到分钟，格式为 H:M-H:M，例如 8:30-10:0，开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下：
- 开始时间和结束时间设置后，免打扰模式每天定时触发。例如，若该时间段设置为 `8:0`-`10:0`，免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`，结束时间为 `12:0`，则免打扰模式在当天的 11:00-12:00 生效，以后每天均在 8:00-12:00 生效。
- 若开始时间和结束时间相同，免打扰模式则全天生效。不过，若设置为 `0:0`-`0:0`，则关闭免打扰模式。
- 若结束时间早于开始时间，则免打扰模式在每天的开始时间到次日的结束时间内生效。例如，开始时间为 `10:0`，结束时间为 `8:0`，则免打扰模式的在当天的 10:00 到次日的 8:00 生效。
- 目前仅支持在每天的一个指定时间段内开启免打扰模式，不支持多个免打扰时间段，新的设置会覆盖之前的设置。
- 若该参数和免打扰时长 `expireTimestamp` 均设置，免打扰模式当日在这两个时间段均生效，例如，上午 8:00 将免打扰的时间段设置为 8:0-10:0，免打扰时长设置为 240 分钟（4 个小时），则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅针对 app 生效，对单聊或群聊不生效。 | +| `startTime` - `endTime` | Int |每天定时触发离线推送免打扰的时间段，采用 24 小时制，精确到分钟，格式为 H:M-H:M，例如 8:30-10:0，开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下：
- 开始时间和结束时间设置后，免打扰模式每天定时触发。例如，若该时间段设置为 `8:0`-`10:0`，免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`，结束时间为 `12:0`，则免打扰模式在当天的 11:00-12:00 生效，以后每天均在 8:00-12:00 生效。
- 若开始时间和结束时间相同，免打扰模式则全天生效。不过，若设置为 `0:0`-`0:0`，则关闭免打扰模式。
- 若结束时间早于开始时间，则免打扰模式在每天的开始时间到次日的结束时间内生效。例如，开始时间为 `10:0`，结束时间为 `8:0`，则免打扰模式的在当天的 10:00 到次日的 8:00 生效。
- 目前仅支持在每天的一个指定时间段内开启免打扰模式，不支持多个免打扰时间段，新的设置会覆盖之前的设置。
- 若该参数和免打扰时长 `expireTimestamp` 均设置，免打扰模式当日在这两个时间段均生效，例如，上午 8:00 将免打扰的时间段设置为 8:0-10:0，免打扰时长设置为 240 分钟（4 个小时），则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅针对 app 生效，对单聊或群聊不生效。 | | `expireTimestamp` | Int |免打扰时长，单位为毫秒。免打扰时长最长不超过 7 天。
与免打扰时间段（`startTime` - `endTime`）的设置每天生效不同，该参数为一次有效。设置后立即生效，例如，上午 8:00 将 app 层级的免打扰时长设置为 4 个小时，则 app 在当天 8:00-12:00 处于免打扰模式。
- 若该参数和免打扰时间段均设置，免打扰模式当日在这两个时间段均生效，例如，上午 8:00 将 app 级的免打扰时间段设置为 8:00-10:00，免打扰时长设置为 4 个小时，则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | App 或单聊/群聊会话。| 若在免打扰时段或时长生效期间需要对指定用户推送消息，需设置[强制推送](push_extension.html#强制推送)。 diff --git a/docs/document/react-native/push/push_overview.md b/docs/document/react-native/push/push_overview.md index 93bf5ac63..52b83dfc3 100644 --- a/docs/document/react-native/push/push_overview.md +++ b/docs/document/react-native/push/push_overview.md @@ -16,22 +16,7 @@ 2. 应用在后台运行或手机锁屏等情况，若客户端未断开与服务器的连接，则即时通讯 IM 不会收到离线推送通知。 -## 离线推送高级功能 - -如果需要离线推送的高级功能，需在[环信即时通讯控制台](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)的**证书管理**页面配置推送策略，该策略配置对所有推送通道生效： - -- 所有设备离线时，才发送推送消息； -- 任一设备离线时，都发送推送消息。 - -**注意**：多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。 - -![image](/images/android/push/push_multidevice_policy.png) - -## 技术原理 +## 推送原理 ### Android 平台离线推送 @@ -50,7 +35,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)。 ::: @@ -73,11 +58,28 @@ 关于获取和发送推送 token（device token），详见[获取或更新推送 token](push_get_device_token.html)和[发送推送 token 到服务器端](push_send_token_to_server.html)。 ::: +## 推送模板 + +推送模板是离线推送的高级功能。使用前，你需要在 [环信控制台](https://console.easemob.com/user/login)的 **功能配置 > 基础功能 > 消息** 页面激活。**激活后，如需关闭推送模板功能，必须联系商务，因为该操作会删除推送模板相关的所有配置。** + +推送模板的配置和使用，详见 [相关文档介绍](push_template.html)。 + +## 多设备离线推送策略 + +多设备登录时，可在 [环信控制台](https://console.easemob.com/user/login)的 **证书管理** 页面配置推送策略，该策略配置对所有推送通道生效： + +- 所有设备离线时，才发送推送消息； +- 任一设备离线时，都发送推送消息。 + +**多端登录时若有设备被踢下线，即使接入了 IM 离线推送，也收不到离线推送消息。** + +![image](/images/android/push/push_multidevice_policy.png) + ## 前提条件 1. 已开启环信即时通讯服务，详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.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..f580bbdfa 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) 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..ff56a39cb 100644 --- a/docs/document/react-native/releasenote.md +++ b/docs/document/react-native/releasenote.md @@ -2,6 +2,10 @@ +## 版本 1.11.5 2025-10-09 + +适配 Android 15 的 16 KB 页面大小。 + ## 版本 1.11.4 2025-9-15 - 修复文件之间循环引用问题。 @@ -446,7 +450,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/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 e5f6e9e01..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/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..ed4b103ce 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#查看应用信息)。 | #### 响应参数 @@ -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 | 响应实体。 | @@ -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..7053f3446 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#配置消息回调规则)。 @@ -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/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..022b3e688 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 个字符。 | @@ -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 568869bc7..47a95fab1 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。 | @@ -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 18bd89f6d..7994c22ee 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 个字符。 | @@ -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 a53315d2e..f78ea2ac1 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。 | #### 响应参数 @@ -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 18d882db2..c14e78ee4 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。 | #### 响应参数 @@ -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 ff4089823..1bac37c93 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。 | #### 响应参数 @@ -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 a7f7af748..53b98cbd8 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。 | #### 响应参数 @@ -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 b35496e09..af506d24f 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。 | @@ -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 d4c893b93..1d37864bd 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。 | #### 查询参数 @@ -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 cd433298b..86eff14b8 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 个字符。 | @@ -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 68caf215b..0e14abc26 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 @@ -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 c8b3e791d..2a8b1c70b 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/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 ad0d4cf0b..fa7ed2700 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。 | @@ -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 0d663a5f1..18085a2a4 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。 | @@ -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 d613b6394..397d1ef9c 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。 | @@ -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 af220b4b5..b860d46c4 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。 | #### 响应参数 @@ -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 7c37e2977..fa3d3062b 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。 | @@ -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 3f2f7c302..5d97597fa 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。 | @@ -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 e215eb20f..70822976a 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。 | @@ -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 3d017b7eb..fc909cd2c 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。 | @@ -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 5c4ee3b95..e51ec9516 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。 | #### 查询参数 @@ -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 36767c9f4..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 万，如需调整请联系商务。 @@ -8,10 +8,10 @@ 要调用环信即时通讯 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)开通子区功能。 +- 已在[环信控制台](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。 | @@ -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 **内容审核** > **文本审核** > **关键词名单**）中展示。你可以在环信控制台编辑、删除名单或进行添加/删除关键词等操作。 - 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词，即每个应用最多可配置 100,000 个词条。 @@ -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..7345be3f1 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..2c056e04f 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..9627858d7 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..43898aba6 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..9eb78a132 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..66b98d5fb 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 @@ -71,7 +71,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/chatfiles/lifetime | `action` | String | 请求方法。 | | `data` | JSON | 是否成功设置消息附件的存储：
- `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 6c0d3dd80..4520f1c00 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#查看应用信息)。 | ### 响应参数 @@ -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 35a12ad07..d06a38a5d 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#查看应用信息)。 | #### 响应参数 @@ -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 068ee71fc..22b6b4307 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#查看应用信息)。 | ### 响应参数 @@ -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 7a7be326b..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/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#查看应用信息)。 | ### 响应参数 @@ -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 57bff972d..1a0ef35a1 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#查看应用信息)。| ### 响应参数 @@ -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 7ad6cc5ff..fd4b430d1 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#查看应用信息)。 | ### 响应参数 @@ -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 df1f15c19..6e75797d3 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 @@ -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 f85f969f1..a26188544 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 **功能配置总览** > **基础功能** 页面设置消息撤回时长，该时长不超过 7 天。 +- 默认情况下，发送方可撤回发出 2 分钟内的消息。你可以在 [环信控制台](https://console.easemob.com/user/login)的**功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长，该时长不超过 7 天。 - 支持强制撤回消息，即撤回已过期的消息。 - 撤回消息会触发发送后回调，请参见 [回调事件文档](callback_message_recall.html)。 - 撤回消息前，需要通过调用 [获取历史消息记录 API](message_historical.html) 或 [消息回调](callback_overview.html) 获取要撤回的消息 ID。 @@ -22,7 +22,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/console/basic_message.html#消息撤回)。 @@ -32,9 +32,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#查看应用信息)。 | #### 响应参数 @@ -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 faceaee1d..44388f117 100644 --- a/docs/document/server-side/message_single.md +++ b/docs/document/server-side/message_single.md @@ -51,13 +51,13 @@ ### 特别说明 - 接口调用过程中，请求体和扩展字段的总长度不能超过 5 KB。 -- 该接口默认不会检查发送方和接收方的好友关系。若你在环信控制台开启了 [好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)，该接口会检查发送方和接收方的好友关系。 +- 该接口默认不会检查发送方和接收方的好友关系。若你在环信控制台开启了 [好友关系检查](/product/console/basic_user.html#好友关系检查)，该接口会检查发送方和接收方的好友关系。 - 该接口不会检查接收方是否在黑名单上，同时不会检查发送方是否被禁言。 - 该接口不校验传入的发送方和接收方的用户 ID。如果你传入的用户 ID 不存在，服务器并不会提示，仍照常发送消息。 - 你可以设置消息发送成功后，是否将消息同步到发送方的所有在线设备（`sync_device` 参数）。 - 你可以设置哪些用户拉漫游消息时拉不到该消息（`roam_ignore_users` 参数）。 - 你可以只将消息发送给在线用户，离线用户则无法收到消息（`routetype`）。 -- 通过 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)，若创建消息时在这些字段中传入了很多业务信息，可能会影响审核效果。因此，创建消息时需要注意内容审核的字段不涉及业务信息，建议业务信息放在扩展字段中。 @@ -130,7 +130,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)。 ## 公共参数 @@ -139,9 +139,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#查看应用信息)。 | ### 响应参数 @@ -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 fc4143586..8384dcfb3 100644 --- a/docs/document/server-side/message_translation_detect.md +++ b/docs/document/server-side/message_translation_detect.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 RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 联系环信商务开通消息翻译功能。 @@ -34,9 +34,9 @@ POST https://{host}/{org_name}/{app_name}/translate/detect | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `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/message_translation_language_list.md b/docs/document/server-side/message_translation_language_list.md index c5d2978d8..7028050b9 100644 --- a/docs/document/server-side/message_translation_language_list.md +++ b/docs/document/server-side/message_translation_language_list.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 RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 联系环信商务开通消息翻译功能。 @@ -34,9 +34,9 @@ GET https://{host}/{org_name}/{app_name}/translate/support/language | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `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/message_translation_text.md b/docs/document/server-side/message_translation_text.md index 2046bad0f..dd1eaa820 100644 --- a/docs/document/server-side/message_translation_text.md +++ b/docs/document/server-side/message_translation_text.md @@ -17,7 +17,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)。 - 联系环信商务开通消息翻译功能。 @@ -39,9 +39,9 @@ POST https://{host}/{org_name}/{app_name}/translate | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `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/overview.md b/docs/document/server-side/overview.md index e9a9850da..73883037f 100644 --- a/docs/document/server-side/overview.md +++ b/docs/document/server-side/overview.md @@ -26,7 +26,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)。 ## 请求结构 diff --git a/docs/document/server-side/presence.md b/docs/document/server-side/presence.md index 55fec80f1..366c24599 100644 --- a/docs/document/server-side/presence.md +++ b/docs/document/server-side/presence.md @@ -14,7 +14,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)。 - 已在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户离在线状态实时同步)。 @@ -28,9 +28,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#查看应用信息)。| | `username` | String | 是 |用户在即时通讯服务器上的唯一 ID。 | ## 认证方式 diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index 10ed8ffad..aecf434c3 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -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#查看应用信息)。 | ### 响应参数 @@ -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 2c53df1fe..20b7cb05f 100644 --- a/docs/document/server-side/push_result_statistics.md +++ b/docs/document/server-side/push_result_statistics.md @@ -6,13 +6,13 @@ 你可以通过以下方式查询离线推送的结果： -- 在[环信即时通讯控制台](https://console.easemob.com/user/login)上查看 IM 消息投递查询： +- 在[环信控制台](https://console.easemob.com/user/login)上查看 IM 消息投递查询： - 在 **应用列表** 中点击目标应用的 **操作** 栏中的 **管理** 按钮，进入 **应用详情** 页面。 - 选择 **即时通讯 > 实时查询 > IM消息投递查询**，查看推送结果记录，如下图所示： ![img](/images/server-side/message_delivery_query.png) -- 推送结果回调：[创建发送后回调规则](/product/enable_and_configure_IM.html#配置回调规则)，对于**回调类型**参数选择**离线推送事件**，然后选择**推送成功**、**推送失败**或**推送异常**，即可接收到推送结果消息回调内容。关于离线推送事件，详见[发送后回调事件](/document/server-side/callback_login_logout.html)。 +- 推送结果回调：[创建发送后回调规则](/product/console/basic_webhook.html#配置消息回调规则)，对于**回调类型**参数选择**离线推送事件**，然后选择**推送成功**、**推送失败**或**推送异常**，即可接收到推送结果消息回调内容。关于离线推送事件，详见[发送后回调事件](/document/server-side/callback_login_logout.html)。 ![img](/images/server-side/post_callback_push.png) @@ -32,9 +32,9 @@ GET https://{host}/{org_name}/{app_name}/push/data/offline-push/begin/{startTime | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :------------------------- | -| `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#查看应用信息)。 | | `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 23bfc5473..8350fb757 100644 --- a/docs/document/server-side/reaction.md +++ b/docs/document/server-side/reaction.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 RESTful API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 已在 [环信控制台](https://console.easemob.com/user/login) 开通 Reaction 功能。 @@ -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#查看应用信息)。 | ## 认证方式 @@ -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 ca1af9eaa..841bdfc9f 100644 --- a/docs/document/server-side/user_favorite.md +++ b/docs/document/server-side/user_favorite.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#查看应用信息)。 | #### 响应参数 @@ -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 | 实际获取的数据详情。 | @@ -32,7 +32,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)。 diff --git a/docs/document/server-side/user_global_mute.md b/docs/document/server-side/user_global_mute.md index 4eb2008f9..1ec27c26f 100644 --- a/docs/document/server-side/user_global_mute.md +++ b/docs/document/server-side/user_global_mute.md @@ -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#查看应用信息)。 | #### 响应参数 @@ -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 | 实际获取的数据详情。 | @@ -40,7 +40,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)。 - 已在环信控制台开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#全局禁言)。 @@ -156,7 +156,7 @@ curl -X POST 'https://XXXX/XXXX/XXXX/mutes' \ | 400 | required_property_not_found | Entity user requires a property named username | 用户不存在。 | 先注册用户或者检查用户名是否正确。 | | 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法，可能过期或 token 错误。 | 使用新的 token 访问。 | | 403 | forbidden_op | user_mute is not used for this app | 未开通全局禁言功能。 | 需要在环信控制台开通该功能。详见 [环信控制台文档](/product/console/basic_user.html#全局禁言)。 | -| 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)。 | 关于其他错误，你可以参考 [错误码](#错误码) 了解可能的原因。 @@ -252,7 +252,7 @@ curl -X GET 'https://XXXX/XXXX/XXXX/mutes/zs1' \ | :---------- | :------------------| :-------------------| :-----------| :------------| | 400 | required_property_not_found | Entity user requires a property named username | 用户不存在。 | 先注册用户或者检查用户名是否正确。 | | 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` 是否正确或[创建应用](/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)。| 关于其他错误，你可以参考 [错误码](#错误码) 了解可能的原因。 @@ -376,7 +376,7 @@ curl -X GET 'https://XXXX/XXXX/XXXX/mutes?pageNum=1&pageSize=10' \ | HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 | | :---------- | :------------------| :--------------------| :------------------| :----------------| | 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` 是否正确或[创建应用](/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/document/server-side/user_relationship_blocklist_add.md b/docs/document/server-side/user_relationship_blocklist_add.md index dc8745a87..4397c1d79 100644 --- a/docs/document/server-side/user_relationship_blocklist_add.md +++ b/docs/document/server-side/user_relationship_blocklist_add.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/console/basic_user.html#用户黑名单)。 @@ -38,9 +38,9 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------ | -| `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#查看应用信息)。 | | `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 7ddf37992..8800c84b9 100644 --- a/docs/document/server-side/user_relationship_blocklist_check.md +++ b/docs/document/server-side/user_relationship_blocklist_check.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 已在环信控制台免费开通黑名单功能。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 @@ -33,9 +33,9 @@ POST https://{host}/{org_name}/{app_name}/blocks/check | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------ | -| `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/user_relationship_blocklist_obtain.md b/docs/document/server-side/user_relationship_blocklist_obtain.md index 18263f066..f3e49a68b 100644 --- a/docs/document/server-side/user_relationship_blocklist_obtain.md +++ b/docs/document/server-side/user_relationship_blocklist_obtain.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 - 已在环信控制台免费开通黑名单功能。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)。 @@ -33,9 +33,9 @@ GET https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users?pag | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------ | -| `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#查看应用信息)。 | | `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 1a1212175..43239af26 100644 --- a/docs/document/server-side/user_relationship_blocklist_remove.md +++ b/docs/document/server-side/user_relationship_blocklist_remove.md @@ -14,7 +14,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/console/basic_user.html#用户黑名单)。 @@ -36,9 +36,9 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/blocks/users/ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `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#查看应用信息)。 | | `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 74aeb68d7..f6af5e0bf 100644 --- a/docs/document/server-side/user_relationship_friend_add.md +++ b/docs/document/server-side/user_relationship_friend_add.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -34,9 +34,9 @@ POST https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/users/ | 参数 | 类型 | 是否必需 | 描述 | | :--------- | :----- | :------- | :--------------- | -| `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#查看应用信息)。 | | `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 f4cf1a375..865de9b9d 100644 --- a/docs/document/server-side/user_relationship_friend_check.md +++ b/docs/document/server-side/user_relationship_friend_check.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)。 ## 认证方式 @@ -31,9 +31,9 @@ POST https://{host}/{org_name}/{app_name}/contacts/check | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------ | -| `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#查看应用信息)。 | | `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 56d99db6d..d1de286a6 100644 --- a/docs/document/server-side/user_relationship_friend_import.md +++ b/docs/document/server-side/user_relationship_friend_import.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -32,9 +32,9 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/contacts/import | 参数 | 类型 | 是否必需 | 描述 | | :---------------- | :----- | :------- |:-------------| -| `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 | 是 | 为哪个用户导入好友列表。 | ### 请求参数 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 63ce21097..4eb280f2c 100644 --- a/docs/document/server-side/user_relationship_friend_list_obtain.md +++ b/docs/document/server-side/user_relationship_friend_list_obtain.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -34,9 +34,9 @@ GET https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/users | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------------ | -| `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#查看应用信息)。 | | `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 7299e3d76..03e0e3b77 100644 --- a/docs/document/server-side/user_relationship_friend_list_paged.md +++ b/docs/document/server-side/user_relationship_friend_list_paged.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -32,9 +32,9 @@ GET https://{host}/{org_name}/{app_name}/user/{username}/contacts?limit={N}&curs | 参数 | 类型 | 是否必需 | 描述 | | :---------------- | :----- | :------- |:-------------| -| `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 | 是 | 要获取哪个用户的好友列表。 | ### 查询参数 diff --git a/docs/document/server-side/user_relationship_friend_remove.md b/docs/document/server-side/user_relationship_friend_remove.md index 196fc5399..55fea8a83 100644 --- a/docs/document/server-side/user_relationship_friend_remove.md +++ b/docs/document/server-side/user_relationship_friend_remove.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -32,9 +32,9 @@ DELETE https://{host}/{org_name}/{app_name}/users/{owner_username}/contacts/user | 参数 | 类型 | 是否必需 | 描述 | | :---------------- | :----- | :------- | :-------------------- | -| `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#查看应用信息)。 | | `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 dba781f45..ad3237b2e 100644 --- a/docs/document/server-side/user_relationship_friend_remove_all.md +++ b/docs/document/server-side/user_relationship_friend_remove_all.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)。 - 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 ## 认证方式 @@ -34,9 +34,9 @@ DELETE https://{host}/{org_name}/{app_name}/contacts/users/{username} | 参数 | 类型 | 是否必需 | 描述 | | :--------------- | :----- | :------- | :------------------ | -| `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 的所有好友。 | 其他参数及描述详见 [公共参数](#公共参数)。 @@ -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 abd388351..e6e08ee75 100644 --- a/docs/document/server-side/user_relationship_remark_set.md +++ b/docs/document/server-side/user_relationship_remark_set.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)。 ## 认证方式 @@ -33,9 +33,9 @@ PUT https://{host}/{org_name}/{app_name}/user/{owner_username}/contacts/users/{f | 参数 | 类型 | 是否必需 | 描述 | | :---------------- | :----- | :------- |:-------------| -| `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#查看应用信息)。 | | `owner_username` | String | 是 | 要设置哪个用户的好友备注。 | | `friend_username` | String | 是 | 要设置备注的用户 ID。 | diff --git a/docs/document/server-side/userprofile.md b/docs/document/server-side/userprofile.md index 26bec139c..112efbffc 100644 --- a/docs/document/server-side/userprofile.md +++ b/docs/document/server-side/userprofile.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)。 ## 公共参数 @@ -25,9 +25,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#查看应用信息)。 | | `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 1a7d0b768..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/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/unity/initialization.md b/docs/document/unity/initialization.md index 5f25b58f8..3776e2761 100644 --- a/docs/document/unity/initialization.md +++ b/docs/document/unity/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/unity/login.md b/docs/document/unity/login.md index 342124cc7..b6cc5a1f5 100644 --- a/docs/document/unity/login.md +++ b/docs/document/unity/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。 @@ -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 951c78d55..b2425c7c5 100644 --- a/docs/document/unity/message_receipt.md +++ b/docs/document/unity/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#增值服务费用)。 ## 实现方法 @@ -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_send.md b/docs/document/unity/message_send.md index 68f8a6a18..f627918e6 100644 --- a/docs/document/unity/message_send.md +++ b/docs/document/unity/message_send.md @@ -2,7 +2,7 @@ 环信即时通讯 IM Unity SDK 通过 `IChatManager` 和 `Message` 类实现文本、图片、音频、视频和文件等类型的消息的发送。 -- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。 +- 对于单聊，环信即时通讯 IM 默认支持陌生人之间发送消息，即无需添加好友即可聊天。若仅允许好友之间发送单聊消息，你需要 [开启好友关系检查](/product/console/basic_user.html#好友关系检查)。 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。 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 8aba22009..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/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)。 ## 实现方法 @@ -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 82f36688b..5d6f3c098 100644 --- a/docs/document/unity/overview.md +++ b/docs/document/unity/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 注册 @@ -61,7 +61,7 @@ SDKClient.Instance.InitWithOptions(options); ### SDK 注册 -若支持 SDK 注册，需登录[环信即时通讯云控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 +若支持 SDK 注册，需登录[环信控制台](https://console.easemob.com/user/login)，选择 **即时通讯** > **服务概览**，将 **设置**下的 **用户注册模式** 设置为 **开放注册**。 ```csharp SDKClient.Instance.CreateAccount(username, password, diff --git a/docs/document/unity/quickstart.md b/docs/document/unity/quickstart.md index ad213582b..c5bb19a8f 100644 --- a/docs/document/unity/quickstart.md +++ b/docs/document/unity/quickstart.md @@ -116,7 +116,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/unity/releasenote.md b/docs/document/unity/releasenote.md index 2cf55a0f5..eb2b972f3 100644 --- a/docs/document/unity/releasenote.md +++ b/docs/document/unity/releasenote.md @@ -347,7 +347,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 Unity 快速入门](quickstart.html) - [消息管理 Unity](message_send.html) - [群组 Unity](group_manage.html) 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 3add5a038..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/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/web/conversation_list.md b/docs/document/web/conversation_list.md index 1a87f8d15..7f72b0a37 100644 --- a/docs/document/web/conversation_list.md +++ b/docs/document/web/conversation_list.md @@ -30,8 +30,9 @@ :::tip 1. **若使用该功能，需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表)，并将 SDK 升级至 4.1.7 或以上版本。而且，只有开通该功能，你才能使用置顶会话和会话标记功能。** 2. 登录用户的 ID 大小写混用会导致拉取会话列表时提示会话列表为空，因此建议用户 ID 使用小写字母。 -3. 服务端会话列表的更新存在延时，建议你仅在登录时调用该方法。 -4. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 +3. 从 4.17.0 版本起，你可以选择是否拉取空会话。 +4. 服务端会话列表的更新存在延时，建议你仅在登录时调用该方法。 +5. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送，获取会话列表时，该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能，需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。 ::: 示例代码如下： @@ -39,7 +40,11 @@ ```javascript // pageSize: 每页期望获取的会话数量。取值范围为 [1,50]，默认为 `20`。 // cursor：开始获取数据的游标位置。若传空字符串（''），SDK 从最新活跃的会话开始获取。 -connection.getServerConversations({pageSize:50, cursor: ''}).then((res)=>{ +connection.getServerConversations({ + pageSize: 50, + cursor: '', + includeEmptyConversations: true // 是否获取空会话 +}).then((res)=>{ console.log(res) }) ``` diff --git a/docs/document/web/demo_react.md b/docs/document/web/demo_react.md index 1fa2d2980..8dd8ef90c 100644 --- a/docs/document/web/demo_react.md +++ b/docs/document/web/demo_react.md @@ -26,9 +26,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-react/tree/dev_4.0)。 5. 下载完毕，在项目根目录打开终端，安装依赖。 diff --git a/docs/document/web/initialization.md b/docs/document/web/initialization.md index 8ab31e75f..7d034c3a0 100644 --- a/docs/document/web/initialization.md +++ b/docs/document/web/initialization.md @@ -4,7 +4,7 @@ ## 前提条件 -有效的环信即时通讯 IM 开发者账号和 App key，详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。 +有效的环信即时通讯 IM 开发者账号和 App key，详见[环信控制台的相关文档](/product/console/app_create.html)。 ## 初始化参数说明 diff --git a/docs/document/web/login.md b/docs/document/web/login.md index b9efd9335..8a398bd67 100644 --- a/docs/document/web/login.md +++ b/docs/document/web/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#创建-im-用户)。 +测试环境下，你在 [环信控制台](https://console.easemob.com/user/login) 创建用户后，环信服务器会自动为这些用户分配用户 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。SDK 会在 Token 过期时或者其有效期达到 80%（4.15.0 之前为 50%）时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token，例如，每次登录时更新 token。 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 264e97e3e..35a8eded8 100644 --- a/docs/document/web/message_receipt.md +++ b/docs/document/web/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#增值服务费用)。 - 消息送达回执和已读回执的效果示例，如下图所示： @@ -46,7 +46,7 @@ - 已经集成和初始化环信 IM SDK，并实现了注册账号和登录功能。详情请参见 [快速开始](quickstart.html)。 - 了解 [使用限制](/product/limitation.html) 中的 API 调用频率限制。 -- 要使用群消息已读回执功能，需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 +- 要使用群消息已读回执功能，需在 [环信控制台开通](/product/console/basic_message.html#群聊消息已读回执)，具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)。 ## 实现方法 @@ -76,7 +76,7 @@ conn.addEventHandler("customEvent", { ### 单聊消息已读回执 -单聊既支持消息已读回执，也支持[会话已读回执](conversation_receipt.html)。我们建议你结合使用这两种回执，见实现步骤的描述。 +单聊既支持消息已读回执，也支持 [会话已读回执](conversation_receipt.html)。我们建议你结合使用这两种回执，见实现步骤的描述。 单聊消息的已读回执有效期与消息在服务端的存储时间一致，即在服务器存储消息期间均可发送已读回执。消息在服务端的存储时间与你订阅的套餐包有关，详见 [IM 套餐包功能详情](/product/product_package_feature.html)。 @@ -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 fdbaba865..1c507410e 100644 --- a/docs/document/web/message_send.md +++ b/docs/document/web/message_send.md @@ -4,7 +4,7 @@ 环信即时通讯 IM Web 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#聊天室消息发送控制) 的 相关文档。 @@ -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 48c4dfa9e..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/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)。 ## 实现方法 @@ -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/quickstart.md b/docs/document/web/quickstart.md index 08b6fab72..9f03a014d 100644 --- a/docs/document/web/quickstart.md +++ b/docs/document/web/quickstart.md @@ -12,8 +12,8 @@ ## 前提条件 -- 有效的环信即时通讯 IM 开发者账号； -- [创建环信即时通讯 IM 项目并获取 App Key](/product/enable_and_configure_IM.html)； +- 有效的 [环信即时通讯 IM 开发者账号](/product/console/account_register.html#注册账号)； +- 在环信控制台[创建应用](/product/console/app_create.html) 并 [获取 App Key](/product/console/app_manage.html#查看应用信息)； - [npm](https://www.npmjs.com/get-npm)； - SDK 支持 IE 9+、Firefox 10+、Chrome 54+ 和 Safari 6+。 @@ -59,7 +59,7 @@ Easemob_quickstart
### 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..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/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..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/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..3776e2761 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..80741613b 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。 @@ -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 63550469f..cc2db401a 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#增值服务费用)。 ## 实现方法 @@ -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_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/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 4f59acd7a..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/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)。 ## 实现方法 @@ -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 32570e1db..e8f9d465e 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 注册 @@ -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/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..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/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..3df99684f 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#查看应用信息)。 | #### 查询参数 @@ -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 cd2f1c9e6..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) @@ -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/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 3ef055882..524116ddd 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..2c29262f7 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..c9324f04b 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/console/basic_message.md b/docs/product/console/basic_message.md index 19b255f2c..432b3fe88 100644 --- a/docs/product/console/basic_message.md +++ b/docs/product/console/basic_message.md @@ -65,9 +65,7 @@ ## 设置离线推送模板 -离线推送的高级功能包括 [推送通知方式](/document/android/push/push_notification_mode_dnd.html#推送通知方式)、[免打扰模式](/document/android/push/push_notification_mode_dnd.html#免打扰模式) 和 [推送模板](/document/android/push/push_display.html#使用推送模板)。 - -使用前离线推送高级功能，需点击 **免费开通** 开通该功能。功能开通后，你可以点击 **设置** 配置推送模板，详见 [推送模板配置文档](push_template.html)。 +离线推送模板为离线推送的高级功能，需点击 **免费开通** 开通该功能。功能开通后，你可以点击 **设置** 配置推送模板，详见 [推送模板配置文档](push_template.html)。 ![img](/images/console/basic_message_push_offline.png) diff --git a/docs/product/console/moderation_history.md b/docs/product/console/moderation_history.md deleted file mode 100644 index 770098873..000000000 --- a/docs/product/console/moderation_history.md +++ /dev/null @@ -1,44 +0,0 @@ -# 查看内容审核历史记录 - -[开通内容审核服务](purchase_value_added.html#内容审核) 后，若使用了文本、图片或音视频内容审核，你可以查看审核记录定位和解决问题，例如，发现某条消息经过审核后的下发结果不符合业务预期。 - -本文以文本审核服务为例，介绍若发现某条消息经过审核后的下发结果不符合业务预期，如何通过查看 **历史记录** 页面定位和解决问题。 - -## 1. 进入历史记录页面 - -1. 登录 [环信控制台](https://console.easemob.com/user/login)。 -2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 -3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核 > 历史记录**。 - -![img](/images/console/moderation_history.png) - -历史记录中的字段详细介绍如下： - -| 字段 | 描述 | -| :----------- | :----------------------------------------------------------- | -| 发送方ID | 内容发送方的环信用户 ID。规则测试页发起的审核，发送方的用户 ID 默认为 **test**。 | -| 接收方ID | 内容接收方的环信用户 ID。 | -| 会话类型 | 消息内容的会话类型：单聊、群聊、聊天室。 | -| 消息内容 | 审核的内容。对于文本消息，显示具体文本内容；对于图片和音视频消息，显示文件链接，点击链接即可查看具体内容。 | -| 消息发送时间 | 内容的发送时间。如果是一条消息，则表示消息的发送时间；如果是规则测试页内容，则表示点击立即审核的时间。 | -| 规则名称 | 按该条规则配置的策略进行审核处理。 | -| 消息处置结果 | 消息内容的下发处理结果：通过、拦截、撤回、替换***。 | -| 审核结果 | 消息内容的审核结果。如果成功返回结果，存在通过/拒绝/疑似3种情况；如果指定时间内未返回结果，则记为调用失败。 | -| 风险类型 | 当 **审核结果** 为 **拒绝** 时，表示发现违规内容，同时会返回风险类型（违规原因）。 | -| 风险详情 | 风险的详细情况。 | - -## 2. 查看审核结果 - -通过查看历史记录列表中的 **审核结果**，判断审核结果是否符合业务预期。 - -- 若不符合，会存在以下两种情况： - - 实际显示：通过，但预期：拒绝，则可新增自定义词来调整； - - 实际显示：拒绝，但预期：通过，则需联系商务，由专门运营人员支持调整； -- 若符合，则查看消息处置结果。 - -## 3. 查看消息处置结果 - -通过查看历史记录列表中的 **消息处置结果**，判断审核结果是否符合业务预期。 - -- 若不符合，修改对应的规则配置，详见 [规则配置](moderation_rule_config.html)。 -- 若符合，说明审核服务的逻辑符合预期，但实际 IM 消息表现效果不一致，请联系环信技术支持。 \ No newline at end of file diff --git a/docs/product/console/moderation_rule_config.md b/docs/product/console/moderation_rule_config.md deleted file mode 100644 index 4e61811e8..000000000 --- a/docs/product/console/moderation_rule_config.md +++ /dev/null @@ -1,58 +0,0 @@ -# 配置审核规则 - -[开通内容审核服务](purchase_value_added.html#内容审核) 后，你可以在环信控制台配置内容审核规则，测试规则、查看历史记录以及配置关键词名单。 - -本文以配置文本审核规则为例进行介绍。图片和音视频的审核规则与文本类似。 - -你可以按以下步骤打开 **文本审核** 页面： - -1. 登录 [环信控制台](https://console.easemob.com/user/login)。 -2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 -3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核**。 - -## 添加文本审核规则 - -开通文本审核服务后，**规则配置** 页面默认会添加单聊文本、群聊文本和聊天室文本审核规则。每类会话只支持一条文本审核规则，而且你可以为指定的会话创建审核规则。 - -点击 **添加规则**，在弹出的 **创建规则** 对话框中配置文本规则相关参数。 - -![img](/images/console/moderation_text_rule.png) - -| 参数 | 描述 | -| :------------------- | :----------------------------------------------------------- | -| 规则名称 | 文本审核规则的名称，为规则的唯一标识，不能超过 32 个字符。 | -| 会话类型 | 会话类型指审核规则生效的范围，包括：单聊会话、单个、多个或所有群聊会话和聊天室会话；例如，选择单聊，则表示是应用下单聊的所有文本消息会按照规则审核和处置。
每类会话只支持一种文本审核规则，例如，若你使用默认的单聊、群聊和聊天室文本审核规则，则无法再创建针对所有单聊、群聊或聊天室的规则，即 **会话类型** 不能选择 **单聊**、**群聊** 或 **聊天室**。这种情况下，你只能为单个群组或聊天室创建规则，即 **会话类型** 只能选择 **GroupID** 或 **Chat Room ID**，然后输入指定的群组 ID 或聊天室 ID。 | -| 启用规则 | 是否启用审核规则。打开后规则生效，关闭则规则不生效。 | -| 消息处理 | 详情参见下表。 | -| 选择模型 |
- **AI模型+关键词**：AI 模型为通用违规内容审核模型，包含策略：涉政、违禁、暴恐、色情、辱骂、广告、灌水和无意义。若配置了关键词名单，则会匹配关键词名单中的词条。
- **仅关键词名单，无需模型**。 | -| 用户处理策略 |
- 默认为 **不处理**。
- 选择 **删除**、**强制下线** 和 **封禁**。这种情况下，你需设置时间间隔和触发次数。 | - -对于 **消息处理** 参数，内容审核服务支持 4 种审核结果（通过、拒绝、疑似，调用失败）下的消息处置策略以及消息拦截后客户端的报错方式： - -| 参数选项 | 描述 | -| :------------------- | :----------------------------------------------------------- | -| 审核结果为拒绝 | 表示发现违规内容，建议拦截。支持 3 种处置策略：
- **拦截**：即不会下发消息。
- **通过**：即下发消息。如果处于测试阶段，模型还没有调整至完全符合业务预期时，可选择该设置，即审核结果不会对消息产生影响；如果审核效果测试符合预期后，建议选择 **拦截** 或 `替换为***`，即可对违规消息进行合理处置。
- `替换为 ***`：表示会把敏感词替换为 `***` 后再下发消息。说明：如果是智能语义识别出违规，不会返回违规敏感词，因此这种情况无法实现替换 *** 时，会按拦截处理。 | -| 审核结果为疑似 | 表示可能存在违规内容，通常这部分内容如果有人工审核，建议人工再次审核。支持 2 种处置策略：
- **拦截**：不会下发消息。
- **通过**：下发消息。 | -| 审核服务调用失败 | 表示审核服务没有在一定时间内返回审核结果，即认为调用失败；例如文本审核接口超时时间为 200 毫秒，若该时间内未返回审核结果，则视为异常。通常认定为异常会有3种原因，一是没有调用权限，二是返回时间超时，三是服务出现异常。支持2种处置策略：
- **拦截**：不会下发消息。
- **通过**：下发消息。 | -| 审核结果为通过 | 表示未发现违规内容，默认下发消息，无需设置。 | -| 消息拦截后客户端是否报错 |
- **是**（报错）：发送方会感知，上报 508 错误码（如下图示例）。应用可根据错误码展示提示信息。
- **否**（不报错）：发送方无感知（即不会出现感叹号提示）；如果应用内违规内容较多，建议选择 **否**，以避免违规用户感知到被拦截后频繁尝试变体违规内容。 | - -![img](/images/moderation/moderation_rule_config_04.png) - -## 添加文本审核子规则 - -文本审核过程中，若对单聊、群聊或聊天室会话中的某个标签下的用户采取特定的规则，则可以添加文本审核子规则。 - -单条规则最多可有 5 个子规则。同一规则下，只能为每个用户标签创建一条子规则。 - -本节以添加单聊文本审核规则的子规则为例进行介绍。 - -在文本审核规则列表中，选择单聊文本审核规则的 **操作** 栏中的 **更多 > 子规则**，点击 **添加**，在 **添加子规则** 对话框中配置相关参数。一条子规则最多可选 5 个用户标签。 - -![img](/images/console/moderation_text_rule_sub.png) - -## 编辑和删除文本审核规则 - -你可以添加和删除文本审核规则以及子规则。 - -在文本审核规则列表中，选择指定规则的 **操作** 栏中的 **更多 > 编辑/删除** 对该条规则进行编辑和删除。 diff --git a/docs/product/console/moderation_rule_test.md b/docs/product/console/moderation_rule_test.md deleted file mode 100644 index 94c0b9b07..000000000 --- a/docs/product/console/moderation_rule_test.md +++ /dev/null @@ -1,28 +0,0 @@ -# 测试审核规则 - -若 [开通了内容审核服务](purchase_value_added.html#内容审核)，你在配置审核规则后，可进行规则测试。 - -本文以测试文本审核规则为例进行介绍。 - -1. 登录 [环信控制台](https://console.easemob.com/user/login)。 - -2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 - -3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核**。 - -4. 选择 **内容审核 > 文本审核 > 规则测试**，打开 **规则测试** 页面。 - -![img](/images/console/moderation_text_rule_test.png) - -5. 在 **内容审核** 栏中，输入规则名称和审核内容，点击 **立即审核**。 - -6. 在 **消息处理结果** 栏中，查看审核结果和消息处理结果。 - -审核结果：表示智能模型审核返回的结果。如果该结果不符合预期，可联系商务开通在第三方平台新增自定义词条的功能。 - -- 调用成功时，会返回 通过/拒绝/疑似； -- 调用异常，会出现 无权限/调用失败（即超时未返回结果）两类情况。 - -消息处理结果：表示消息的下发结果，根据规则里配置得出；存在通过/拦截/替换*** 三种情况。如果该结果不符合预期，可通过修改规则配置调整，详见 [规则配置](moderation_rule_config.html)。 - -![img](/images/console/moderation_text_rule_test_result.png) \ No newline at end of file diff --git a/docs/product/console/value_added_config_moderation.md b/docs/product/console/value_added_config_moderation.md new file mode 100644 index 000000000..97025d320 --- /dev/null +++ b/docs/product/console/value_added_config_moderation.md @@ -0,0 +1,7 @@ +# 内容审核 + +环信控制台中内容审核相关的配置在内容审核功能文档中进行说明，请参见 [内容审核](/product/moderation/moderation_enable.html) 系列文档。 + +![img](/images/value_added_config_moderation.png) + + diff --git a/docs/product/console/value_added_config_push.md b/docs/product/console/value_added_config_push.md new file mode 100644 index 000000000..fab81ceb8 --- /dev/null +++ b/docs/product/console/value_added_config_push.md @@ -0,0 +1,5 @@ +# 即时推送 + +环信控制台中即时推送相关的配置在即时推送功能文档中进行说明，请参见 [即时推送](push_createproduct_app.html) 系列文档。 + +![img](/images/value_added_config_push.png) diff --git a/docs/product/console/value_added_config_rtc.md b/docs/product/console/value_added_config_rtc.md new file mode 100644 index 000000000..5cddbff1d --- /dev/null +++ b/docs/product/console/value_added_config_rtc.md @@ -0,0 +1,5 @@ +# 实时音视频 + +环信控制台中实时音视频相关的配置在实时音视频文档中进行说明，请参见 [实时音视频](/callkit/android/product_activation.html) 系列文档。 + +![img](/images/value_added_config_rtc.png) diff --git a/docs/product/conversation_function.md b/docs/product/conversation_function.md index 8d1828eed..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/enable_and_configure_IM.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 2eb34fdcc..2418dfea4 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 @@ -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 中传入的与该参数一致。 | -| 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#创建应用)。 | +| 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 b66a7760a..5101c2715 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/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/moderation/keyword_review.md b/docs/product/moderation/keyword_review.md deleted file mode 100644 index ec6144742..000000000 --- a/docs/product/moderation/keyword_review.md +++ /dev/null @@ -1,134 +0,0 @@ -# 关键词审核 - -关键词审核是一种基础的文本审核方式，通过对文本消息内容中的关键词进行识别与过滤，可快速发现和过滤不合规的文本。关键词精准匹配可解决简单的内容过滤需求，例如不允许出现国家领导人姓名。如果应用中的违规内容较复杂，存在较多变体等情况，建议结合 AI 模型审核实现更全面、更准确的内容审核。 - -下表为关键词审核与 AI 审核的区别。 - -| 审核类型 | 应用场景 | 审核机制 | 审核范围 | 收费机制 | -| :-------------- | :----- | :------- | :------- | :------------------ | -| 关键词审核 | 简单的文本内容过滤需求。 | 1. 你需创建黑白名单，填写关键词，设置对含有关键词的消息的命中处理措施。
2. 在文本审核规则中选择使用关键词审核。 | 支持从客户端 SDK 发送的文本消息。 | 按月收费。 | -| AI 模型审核 | 各种场景的全消息类型的全方位内容审核。 | 基于业界先进的语义模型和海量的多语种样本库，有效识别各类场景中的风险文本内容。你需在文件审核规则中选择 AI 模型和关键词名单配合使用。 | 支持从客户端 SDK 发送的文本、图片、音频和视频消息。详见[内容审核产品介绍](moderation_overview.html)。 | 按量计费，详见[内容计费说明](moderation_billing_domestic.html)。 | - - -## 使用关键词审核 - -**开通关键词审核需确保账户余额大于 1000 元。** 你可以按以下步骤使用该服务： - -1. [开通文本审核](moderation_enable.html)。 -2. [开通关键词审核](#第二步-开通关键词审核)。 -3. 配置关键词名单。 -4. 在文本审核规则中应用关键词名单。 - -### 第一步 [开通文本审核](moderation_enable.html) - -1. 在环信控制台首页，选择目标应用，然后选择**即时通讯** > **功能配置** > **功能配置总览**。 - -2. 在**功能配置总览**页面上，点击**内容审核**页签。点击**文本审核**对应的**操作**栏中的**开通**。 - -### 第二步 开通关键词审核 - -:::tip -关键词审核功能为增值服务，需单独购买。服务开通后立即扣费，自动续费。 -::: - -1. 在环信控制台首页，选择目标应用，然后选择**即时通讯** > **功能配置** > **功能配置总览**。 - -2. 在**功能配置总览**页面，点击**内容审核**页签。点击**关键词审核**对应的**操作**栏中的**开通**。 - -3.开通后，点击**关键词审核**对应的**操作**栏中的**配置**，进入**关键词名单**页面。 - -![img](/images/moderation/keyword_enable.png) - -![img](/images/moderation/keyword_keywordreview.png) - -### 第三步 配置关键词名单 - -1. 选择**即时通讯** > **内容审核** > **关键词审核**配置关键词名单。 - -:::tip -1. 关键词名单包含白名单和黑名单，即**命中处置**参数为**通过**时为白名单，设置为 `替换为***` 和**拦截**时为黑名单。 -2. 每个应用最多可配置 100 个名单, 每个名单最多可添加 10,000 个关键词，即每个应用最多可配置 100,000 个词条。添加的关键词在 15 分钟后生效。 -::: - -1. 单击**创建黑/白名单**，填写名单信息。 - -![img](/images/moderation/keyword_create.png) - -创建黑/白名单，需配置以下参数： - -| 字段 | 描述 | -| :------------------- | :----------------------------------------------------------- | -| 名单名称 | 关键词名单的名称，不能超过 32 个字符。 | -| 命中处置 | 对命中关键词的消息的处理：
- **通过**：下发消息。
- `替换为***`：将消息内容中命中的关键词替换为 `***` 后再下发消息。
- **拦截**：不下发消息。 | -| 生效范围 | 关键词审核规则的应用范围，包括：
- **全部**：所有会话，包含单聊、群聊和聊天室会话。
- **单聊**
- **群聊**
- **聊天室**
- 群组/聊天室标签。详见 [标签管理](moderation_user_tag.html)。| -| 匹配方式 |
- **包含匹配**：模糊匹配，即消息内容中包含关键词内容即为命中。例如，关键词为“加我微信”，若消息内容中包含“加我微信88888**88” 即命中关键词。
- **相等匹配**：精确匹配。| -| 关键词 | 该规则中的关键词。每个关键词的长度不能超过 128 个字符，一次最多可添加 200 个词条，每行一个词条。 | - -3. 点击**确定**保存配置。 - -名单创建成功后会显示在名单列表中，默认为开启状态。若不需要使用该名单，可以在**状态**栏中将其关闭。 - -![img](/images/moderation/keyword_creationsuccess.png) - -4. 添加关键词。 - -创建关键词名单后，你可以在名单列表上选择**更多** > **进入名单**。 - -![img](/images/moderation/keyword_creationsuccess.png) - -选择通过手动添加或文件导入方式添加关键词。 - -![img](/images/moderation/keyword_addword.png) - -- 手动添加 - -单击**添加关键词**，手动输入关键词。每次最多添加 200 个词条。 - -![img](/images/moderation/keyword_manualadd.png) - -- 文件导入 - -单击**文件导入**，然后选择文件上传。 - -:::tip -支持 .txt 格式的纯文本文件，每个文件不能超过 2 MB。
-文件上传后应确保单个名单的词条总数不超过 10,000，否则超出部分将添加失败。 -::: - -![img](/images/moderation/keyword_fileimport.png) - -5. 可根据业务实际需要，搜索名单或关键词。 - -- 名单搜索：在名单列表页面搜索名单名称，精确匹配，需输入完整的名单名称。 -- 关键词搜索：进入指定的关键词名单列表，输入关键字即可搜索出包含该关键字的所有关键词，支持模糊匹配。 - -6. 删除关键词。 - -在关键词名单列表上，点击指定的名单名称，进入该名单的关键词列表。在指定关键词的**操作**栏中点击**删除**将其删除，或选择多个关键词名称前的复选框，然后点击**批量删除**。 - -![img](/images/moderation/keyword_search_delete.png) - -### 第四步 在文本审核规则中应用关键词名单 - -文本审核开通后，默认会生成 3 条规则。本节以默认的单聊文本规则为例，介绍如何在文本审核规则中应用关键词名单。 - -![img](/images/moderation/keyword_rulelist.png) - -1. 点击默认的单聊文本规则的**操作**栏中**更多** > **编辑**，进入**编辑规则**对话框。 - -![img](/images/moderation/keyword_singlechatrule.png) - -2. 配置使用关键词名单。 - -- **模型选择**：如果仅使用关键词审核，则选择**仅关键词名单，无需模型**；如果需同时使用关键词审核和 AI 模型审核，则选择**AI模型+关键词名单**。 - -- **启用规则**：文本审核规则默认为关闭状态，点击开关即可启用。开启后，规则列表中的**服务状态**一栏显示为**启用**。 -- **消息处理**：**消息处理** 所列的审核结果与 **模型选择** 的配置相关。 - - 如果仅使用关键词审核，则选择 **仅关键词名单，无需模型**。这种情况下，你可以配置 **消息处理** 中的 **审核服务调用失败时** 和 **消息拦截后是否报错** 选项。 - - 如果需同时使用关键词审核和 AI 模型审核，则选择 **AI模型+关键词名单**。这种情况下，**消息处理** 会列明所有选项，其中 **审核结果为拒绝时** 和 **审核结果为疑似时** 仅对 AI 模型有效。 - -- 其他参数配置详见[规则配置说明](moderation_rule_config.html)。 - -### 使用示例 - -发送文本消息时，若消息内容中包含关键词名单中的关键词而且文本审核规则中的**消息处理**配置为**拦截**，则消息发送失败，SDK 返回错误码 508；如规则配置为`替换为***`，则关键词会被替换为`***`，再将替换后的内容发送至接收方。 \ No newline at end of file diff --git a/docs/product/console/moderation_data_overview.md b/docs/product/moderation/moderation_data_overview.md similarity index 100% rename from docs/product/console/moderation_data_overview.md rename to docs/product/moderation/moderation_data_overview.md diff --git a/docs/product/moderation/moderation_enable.md b/docs/product/moderation/moderation_enable.md index c1d4cca22..05505ad52 100644 --- a/docs/product/moderation/moderation_enable.md +++ b/docs/product/moderation/moderation_enable.md @@ -7,31 +7,23 @@ - 有效的 [环信即时通讯 IM 开发者账号](https://console.easemob.com/index)； - 账户余额大于 288 元。首次开通，免费使用 7 天。 -**1、登录 [环信管理后台](https://console.easemob.com/index)** +## 开通流程 -**2、进入功能配置总览页** +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 + + ![img](/images/console/app_mgmt_list.png) + +3. 在左侧导航栏，选择 **服务开通** > **增值服务**。 +4. 选择右侧的 **内容审核** 页签，根据需要分别开通文本审核、图片审核、音频审核和视频审核服务。 +5. 若需要关键词审核服务，可点击 **开通** 开通该服务。**注意开通该服务前，需先开通文本审核。** -在环信控制台首页，在 **应用列表** 区域下，点击 **操作** 一栏中的 **管理**。 +开通内容审核服务需确保账户余额大于 288 元。首次开通，免费使用 7 天。开通关键词审核需确保账户余额大于 1000 元。对于免费版套餐包，若账户余额充足，也可付费开通内容审核和关键词审核服务。 -![img](/images/product/app-setting.png) +开通后，你可以对内容审核服务进行配置，详见 [相关配置文档](moderation_rule_config.html)。 -选择 **即时通讯 > 功能配置 > 功能配置总览**。 - -![img](/images/moderation/moderation_enable_02.png) - -在 **功能配置总览** 页面上，点击 **内容审核** 页签，如下图所示： - -如果使用自定义消息审核，**需首先开通文本审核和图片审核，再联系商务开通自定义消息审核。** - -![img](/images/moderation/moderation_enable_03.png) - -**3、点击 开通** - -说明：如果遇到开通异常，请联系商务处理。 - -**4、配置审核规则** - -开通成功后，点击 **设置**，即可进入规则配置页。 - -![img](/images/moderation/moderation_enable_04.png) +:::tip +如果使用自定义消息审核，需首先开通文本审核和图片审核，再联系商务开通自定义消息审核。 +::: +![img](/images/console/content_moderation.png) \ No newline at end of file diff --git a/docs/product/moderation/moderation_enable_03.png b/docs/product/moderation/moderation_enable_03.png deleted file mode 100644 index e81c23650..000000000 Binary files a/docs/product/moderation/moderation_enable_03.png and /dev/null differ diff --git a/docs/product/moderation/moderation_history.md b/docs/product/moderation/moderation_history.md index 7ede326a8..770098873 100644 --- a/docs/product/moderation/moderation_history.md +++ b/docs/product/moderation/moderation_history.md @@ -1,49 +1,44 @@ -# 历史记录 +# 查看内容审核历史记录 -## 前提条件 +[开通内容审核服务](purchase_value_added.html#内容审核) 后，若使用了文本、图片或音视频内容审核，你可以查看审核记录定位和解决问题，例如，发现某条消息经过审核后的下发结果不符合业务预期。 -[开通内容审核服务](moderation_enable.html)。 +本文以文本审核服务为例，介绍若发现某条消息经过审核后的下发结果不符合业务预期，如何通过查看 **历史记录** 页面定位和解决问题。 -## 应用场景 +## 1. 进入历史记录页面 -**发现某条消息经过审核后的下发结果不符合业务预期，怎么办？** +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核 > 历史记录**。 -本文以文本审核服务为例，介绍如何通过查看**历史记录**页面定位问题和解决问题。 - -**1、进入 历史记录页** - -![img](/images/moderation/moderation_history_01.png) +![img](/images/console/moderation_history.png) 历史记录中的字段详细介绍如下： | 字段 | 描述 | | :----------- | :----------------------------------------------------------- | -| 发送方ID | 表示内容发送方的环信用户 ID。规则测试页发起的审核，发送方的用户ID默认为 **test**。 | -| 接收方ID | 表示内容接收方的环信用户 ID | -| 会话类型 | 表示消息内容的会话类型，包括：单聊、群聊、聊天室。 | -| 消息内容 | 表示审核的内容。对于文本消息，显示具体文本内容；对于图片和音视频消息，显示文件链接，点击链接即可查看具体内容。 | -| 消息发送时间 | 表示内容的发送时间。如果是一条消息，则表示消息的发送时间；如果是规则测试页内容，则表示点击立即审核的时间。 | -| 规则名称 | 表示按该条规则配置的策略进行审核处理。 | -| 消息处置结果 | 表示消息内容的下发处理结果，存在通过/拦截/替换*** 3 种情况。 | -| 审核结果 | 表示消息内容的审核结果；如果成功返回结果，存在通过/拒绝/疑似3种情况；如果指定时间内未返回结果，则记为异常。 | -| 风险类型 | 当审核结果为“拒绝”时，表示发现违规内容，同时会返回违规原因（即风险类型）。 | +| 发送方ID | 内容发送方的环信用户 ID。规则测试页发起的审核，发送方的用户 ID 默认为 **test**。 | +| 接收方ID | 内容接收方的环信用户 ID。 | +| 会话类型 | 消息内容的会话类型：单聊、群聊、聊天室。 | +| 消息内容 | 审核的内容。对于文本消息，显示具体文本内容；对于图片和音视频消息，显示文件链接，点击链接即可查看具体内容。 | +| 消息发送时间 | 内容的发送时间。如果是一条消息，则表示消息的发送时间；如果是规则测试页内容，则表示点击立即审核的时间。 | +| 规则名称 | 按该条规则配置的策略进行审核处理。 | +| 消息处置结果 | 消息内容的下发处理结果：通过、拦截、撤回、替换***。 | +| 审核结果 | 消息内容的审核结果。如果成功返回结果，存在通过/拒绝/疑似3种情况；如果指定时间内未返回结果，则记为调用失败。 | +| 风险类型 | 当 **审核结果** 为 **拒绝** 时，表示发现违规内容，同时会返回风险类型（违规原因）。 | +| 风险详情 | 风险的详细情况。 | -**2、查看审核结果** +## 2. 查看审核结果 -![img](/images/moderation/moderation_history_02.png) - -判断审核结果是否符合业务预期？ +通过查看历史记录列表中的 **审核结果**，判断审核结果是否符合业务预期。 - 若不符合，会存在以下两种情况： - 实际显示：通过，但预期：拒绝，则可新增自定义词来调整； - 实际显示：拒绝，但预期：通过，则需联系商务，由专门运营人员支持调整； -- 若符合，则继续看第3步 - -**3、查看消息处置结果** +- 若符合，则查看消息处置结果。 -![img](/images/moderation/moderation_history_03.png) +## 3. 查看消息处置结果 -判断消息处置结果是否符合业务预期？ +通过查看历史记录列表中的 **消息处置结果**，判断审核结果是否符合业务预期。 -- 若不符合，修改对应的规则配置，详见[规则配置](moderation_rule_config.html)； -- 若符合，说明审核服务的逻辑符合预期，但实际 IM 消息表现效果不一致，则请在IM的支持群中发出问题进行排查解决。 \ No newline at end of file +- 若不符合，修改对应的规则配置，详见 [规则配置](moderation_rule_config.html)。 +- 若符合，说明审核服务的逻辑符合预期，但实际 IM 消息表现效果不一致，请联系环信技术支持。 \ No newline at end of file diff --git a/docs/product/console/moderation_history_export.md b/docs/product/moderation/moderation_history_export.md similarity index 100% rename from docs/product/console/moderation_history_export.md rename to docs/product/moderation/moderation_history_export.md diff --git a/docs/product/console/moderation_keyword.md b/docs/product/moderation/moderation_keyword.md similarity index 98% rename from docs/product/console/moderation_keyword.md rename to docs/product/moderation/moderation_keyword.md index a9501d1a1..0d365805e 100644 --- a/docs/product/console/moderation_keyword.md +++ b/docs/product/moderation/moderation_keyword.md @@ -13,6 +13,8 @@ 使用前，你需要开通文本审核和关键词审核服务。详见 [服务开通文档](purchase_value_added.html#内容审核)。 +**开通关键词审核需确保账户余额大于 1000 元。** + ## 配置关键词名单 1. 登录 [环信控制台](https://console.easemob.com/user/login)。 diff --git a/docs/product/moderation/moderation_manual_review.md b/docs/product/moderation/moderation_manual_review.md index 3509620b9..1188faabc 100644 --- a/docs/product/moderation/moderation_manual_review.md +++ b/docs/product/moderation/moderation_manual_review.md @@ -1,25 +1,37 @@ -# 人工审核 +# 群组/聊天室人工审核 -环信即时通讯 IM 支持对群组和聊天室消息进行人工实时审核。 +环信即时通讯 IM 支持对群组和聊天室进行人工实时审核。 -## 前提条件 +## 开通群组/聊天室人工审核服务 -- 有效的 [环信即时通讯 IM 开发者账号](https://console.easemob.com/index)； -- 在 Console 中开通内容审核服务：选择 **即时通讯** > 应用 **管理** > **功能配置总览**，进入 **试用功能** > **人工审核** 页面，点击 **申请开通**。如下图所示： +在环信控制台中开通人工审核服务。详见 [环信控制台文档](/product/console/basic_other.html#实时消息人工审核)。 -![img](/images/moderation/moderation_manual_review_01.png) +## 群组审核管理 -## 消息人工审核 +[开通人工审核](basic_other.html#实时消息人工审核) 后，你可以对群组的消息、属性和成员进行实时审核管理操作。 -下面以群组消息人工审核为例说明 console 操作步骤。 +在群组列表中，点击指定的群组 ID 在 **群管理** 页面进行如下管理操作： +- 修改群组名称、描述和群公告。 +- 开启/关闭群组全员禁言。 +- 添加群成员。 +- 添加群组管理员。 +- 将群成员加入黑名单。 +- 将群成员加入禁言列表。 +- 作为 app 管理员发送和撤回消息以及发送离线通知。 -1. 在 Console 中点击具体应用的 **管理** 按钮，然后依次点击左侧导航栏的 **即时通讯** > **运营服务** > **群组管理**，进入群组管理页面； -2. 搜索指定的群组 ID，在群组列表中，点击需进行实时审核的 **群组 ID**，可以对群组消息进行实时管理操作； +![img](/images/console/operation_group_moderation.png) -![img](/images/moderation/moderation_manual_review_02.png) +## 聊天室审核管理 -1. 如下图，可以修改群组名称、公告，进行群组管理如设置全员禁言，作为系统管理员撤回群组消息，发送管理员通知信息，以及设置当前群组内本管理员的通知消息是否发送离线通知等： +[开通人工审核](basic_other.html#实时消息人工审核) 后，你可以对聊天室的消息、属性和成员进行实时管理操作。 -![img](/images/moderation/moderation_manual_review_03.png) +在聊天室列表中，点击指定的聊天室 ID，可以在 **聊天室管理** 页面进行如下管理操作： +- 修改聊天室名称、描述和公告； +- 设置聊天室全员禁言； +- 添加聊天室成员； +- 添加聊天室管理员； +- 黑名单管理； +- 禁言列表管理； +- 作为 app 管理员发送和撤回消息。 -聊天室消息人工审核同上流程。 \ No newline at end of file +![img](/images/console/operation_chatroom_moderation.png) diff --git a/docs/product/console/moderation_message_report.md b/docs/product/moderation/moderation_message_report.md similarity index 100% rename from docs/product/console/moderation_message_report.md rename to docs/product/moderation/moderation_message_report.md diff --git a/docs/product/moderation/moderation_record_callback.md b/docs/product/moderation/moderation_record_callback.md index 10c2e3595..554dc3e42 100644 --- a/docs/product/moderation/moderation_record_callback.md +++ b/docs/product/moderation/moderation_record_callback.md @@ -4,18 +4,19 @@ 审核记录支持回调，具体操作步骤如下： -1. 登录环信后台，进入**即时通讯 > 功能配置 > 消息回调**。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 + + ![img](/images/console/app_mgmt_list.png) -![img](/images/moderation/moderation_callback_01.png) +3. 在左侧导航栏，选择 **功能配置** > **基础功能**。 +4. 在 **消息回调** 页面，点击 **添加回调规则**。 + + ![img](/images/console/moderation_callback_add.png) -2. 点击添加回调地址，选择**发送后回调**。 - -![img](/images/moderation/moderation_callback_02.png) - -3. 勾选 **内容审核**，其他字段的设置详见[配置回调规则](/product/enable_and_configure_IM.html#配置回调规则)。 - -![img](/images/moderation/moderation_callback_03.png) +5. 点击 **发送后回调**，在 **回调类型** 选择框中勾选 **内容审核**，选择 **审核通过**、**审核疑似** 和 **审核拦截**。 +![img](/images/console/moderation_callback.png) ## 审核回调内容 diff --git a/docs/product/moderation/moderation_rule_config.md b/docs/product/moderation/moderation_rule_config.md index 615f6de54..6457a4fed 100644 --- a/docs/product/moderation/moderation_rule_config.md +++ b/docs/product/moderation/moderation_rule_config.md @@ -1,77 +1,58 @@ -# 规则配置 +# 配置审核规则 -## 前提条件 +[开通内容审核服务](purchase_value_added.html#内容审核) 后，你可以在环信控制台配置内容审核规则。 -[开通内容审核服务](moderation_enable.html)。 +本文以配置文本审核规则为例进行介绍。图片和音视频的审核规则与文本类似。 -## 设置审核规则 +你可以按以下步骤打开 **文本审核** 页面： -本文以文本审核服务为例，介绍如何设置规则。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核**。 -**1、进入文本审核-规则配置页** +## 添加文本审核规则 -开通内容审核-文本审核功能后，规则配置页面中会有默认规则，各类会话场景下均提供了默认规则。 +开通文本审核服务后，**规则配置** 页面默认会添加单聊文本、群聊文本和聊天室文本审核规则。每类会话只支持一条文本审核规则，而且你可以为指定的会话创建审核规则。 -![img](/images/moderation/moderation_rule_config_01.png) +点击 **添加规则**，在弹出的 **创建规则** 对话框中配置文本规则相关参数。 -**2、点击操作-更多-编辑，进入编辑规则窗口** +![img](/images/console/moderation_text_rule.png) -如果需要审核单聊里的文本消息，则可编辑单聊文本规则，群聊、聊天室均同理。 - -![img](/images/moderation/moderation_rule_config_02.png) - -以单聊文本为例，编辑规则窗口如下： - -![img](/images/moderation/moderation_rule_config_03.png) +| 参数 | 描述 | +| :------------------- | :----------------------------------------------------------- | +| 规则名称 | 文本审核规则的名称，为规则的唯一标识，不能超过 32 个字符。 | +| 会话类型 | 会话类型指审核规则生效的范围，包括：单聊会话、单个、多个或所有群聊会话和聊天室会话；例如，选择单聊，则表示是应用下单聊的所有文本消息会按照规则审核和处置。
每类会话只支持一种文本审核规则，例如，若你使用默认的单聊、群聊和聊天室文本审核规则，则无法再创建针对所有单聊、群聊或聊天室的规则，即 **会话类型** 不能选择 **单聊**、**群聊** 或 **聊天室**。这种情况下，你只能为单个群组或聊天室创建规则，即 **会话类型** 只能选择 **GroupID** 或 **Chat Room ID**，然后输入指定的群组 ID 或聊天室 ID。 | +| 启用规则 | 是否启用审核规则。打开后规则生效，关闭则规则不生效。 | +| 消息处理 | 详情参见下表。 | +| 选择模型 |
- **AI模型+关键词**：AI 模型为通用违规内容审核模型，包含策略：涉政、违禁、暴恐、色情、辱骂、广告、灌水和无意义。若配置了关键词名单，则会匹配关键词名单中的词条。
- **仅关键词名单，无需模型**。 | +| 用户处理策略 |
- 默认为 **不处理**。
- 选择 **删除**、**强制下线** 和 **封禁**。这种情况下，你需设置时间间隔和触发次数。 | -规则中的字段详细介绍如下： +对于 **消息处理** 参数，内容审核服务支持 4 种审核结果（通过、拒绝、疑似，调用失败）下的消息处置策略以及消息拦截后客户端的报错方式： -| 字段 | 描述 | +| 参数选项 | 描述 | | :------------------- | :----------------------------------------------------------- | -| 规则名称 | 审核规则的名称，为审核规则的唯一标识，不能超过 32 个字符。 | -| 会话类型 | 会话类型指审核规则生效的范围，包括：单聊会话、单个、多个或所有群聊会话和聊天室会话；例如，选择单聊，则表示是应用下单聊的所有文本消息会按照规则审核和处置。 | -| 启用规则（规则开关） | 是否启用审核规则。打开后规则生效，关闭则规则不生效。 | -| 消息处理 |
• 审核结果为拒绝时消息处理策略，包括：拦截、替换为 ***、通过；
• 审核结果为疑似时消息处理策略，包括：拦截、通过；
• 审核服务调用失败时消息处理策略，包括：拦截、通过；
• 消息拦截后客户端是否报错，包括：报错、不报错。 | -| 审核模型 | 内容审核支持多场景模型，可按需选择；文本审核仅有1个通用违规内容审核模型，包含策略：涉政&违禁&暴恐&色情&辱骂&广告&灌水&无意义；详见 内容审核模型策略。 | -| 用户处理策略 | 默认不处理。开启后，可以设置时间间隔、触发次数和用户自动处理的策略，触发后将对用户进行自动处理，详见 应用内用户管理章节。 | - -**3、检查【消息处理】的设置，按需调整** - -内容经过审核后，审核结果会出现 4 种情况（通过、拒绝、疑似，调用失败），支持按业务需求设置每种情况下的消息处置策略： - -- **审核结果为拒绝**：表示发现违规内容，建议拦截。 - - 支持 3 种处置策略：拦截、替换为 ***、通过。 - - 拦截：即不会下发消息。 - - 替换为`***`：表示会把敏感词替换为`***` 后再下发消息。说明：如果是智能语义识别出违规，不会返回违规敏感词，因此这种情况无法实现替换***时，会按拦截处理。 - - 通过：即下发消息。如果处于测试阶段，模型还没有调整至完全符合业务预期时，可选择该设置，即审核结果不会对消息产生影响；如果审核效果测试符合预期后，建议选择 **拦截** 或`替换为***`，即可对违规消息进行合理处置。 -- **审核结果为疑似**：表示可能存在违规内容，通常这部分内容如果有人工审核，建议人工再次审核。 - - 支持2种处置策略：拦截（即不会下发消息）和通过（即下发消息）。 -- **审核服务调用失败**：表示审核服务没有在一定时间内返回审核结果，即认为调用失败；例如文本审核接口超时时间为 200 毫秒，若该时间内未返回审核结果，则视为异常。通常认定为异常会有3种原因，一是没有调用权限，二是返回时间超时，三是服务出现异常。 - - 支持2种处置策略：拦截（即不会下发消息）和通过（即下发消息）。 -- **审核结果为通过**：表示未发现违规内容，默认下发消息，无需设置。 - -:::tip - 当消息被处置为**拦截**后，客户端会返回错误码：508，应用可根据错误码展示提示信息。 -::: - -**消息拦截后客户端是否报错**：表示消息被拦截后，发送方是否要感知到消息发送失败： - - **是（报错）**：即发送方会感知到消息发送失败（如下图示例）； - - **否（不报错）**：即发送方不会感知到消息发送失败（即不会出现感叹号提示）；如果应用内违规内容较多，建议选择**否**，以避免违规用户感知到被拦截后频繁尝试变体违规内容。 +| 审核结果为拒绝 | 表示发现违规内容，建议拦截。支持 3 种处置策略：
- **拦截**：即不会下发消息。
- **通过**：即下发消息。如果处于测试阶段，模型还没有调整至完全符合业务预期时，可选择该设置，即审核结果不会对消息产生影响；如果审核效果测试符合预期后，建议选择 **拦截** 或 `替换为***`，即可对违规消息进行合理处置。
- `替换为 ***`：表示会把敏感词替换为 `***` 后再下发消息。说明：如果是智能语义识别出违规，不会返回违规敏感词，因此这种情况无法实现替换 *** 时，会按拦截处理。 | +| 审核结果为疑似 | 表示可能存在违规内容，通常这部分内容如果有人工审核，建议人工再次审核。支持 2 种处置策略：
- **拦截**：不会下发消息。
- **通过**：下发消息。 | +| 审核服务调用失败 | 表示审核服务没有在一定时间内返回审核结果，即认为调用失败；例如文本审核接口超时时间为 200 毫秒，若该时间内未返回审核结果，则视为异常。通常认定为异常会有3种原因，一是没有调用权限，二是返回时间超时，三是服务出现异常。支持2种处置策略：
- **拦截**：不会下发消息。
- **通过**：下发消息。 | +| 审核结果为通过 | 表示未发现违规内容，默认下发消息，无需设置。 | +| 消息拦截后客户端是否报错 |
- **是**（报错）：发送方会感知，上报 508 错误码（如下图示例）。应用可根据错误码展示提示信息。
- **否**（不报错）：发送方无感知（即不会出现感叹号提示）；如果应用内违规内容较多，建议选择 **否**，以避免违规用户感知到被拦截后频繁尝试变体违规内容。 | ![img](/images/moderation/moderation_rule_config_04.png) -**4、点击启用规则** +## 添加文本审核子规则 + +文本审核过程中，若对单聊、群聊或聊天室会话中的某个标签下的用户采取特定的规则，则可以添加文本审核子规则。 -规则状态默认是不启用。点击启用规则后，规则立即生效，表示文本消息会按该规则配置进行内容审核。 +单条规则最多可有 5 个子规则。同一规则下，只能为每个用户标签创建一条子规则。 -![img](/images/moderation/moderation_rule_config_05.png) +本节以添加单聊文本审核规则的子规则为例进行介绍。 -**5、点击确定** +在文本审核规则列表中，选择单聊文本审核规则的 **操作** 栏中的 **更多 > 子规则**，点击 **添加**，在 **添加子规则** 对话框中配置相关参数。一条子规则最多可选 5 个用户标签。 -![img](/images/moderation/moderation_rule_config_06.png) +![img](/images/console/moderation_text_rule_sub.png) -点击**确定**后，即规则修改保存成功。 +## 编辑和删除文本审核规则 -![img](/images/moderation/moderation_rule_config_07.png) +你可以添加和删除文本审核规则以及子规则。 -所有经过审核的内容可在 [历史记录](moderation_history.html) 页面查看。 \ No newline at end of file +在文本审核规则列表中，选择指定规则的 **操作** 栏中的 **更多 > 编辑/删除** 对该条规则进行编辑和删除。 diff --git a/docs/product/moderation/moderation_rule_test.md b/docs/product/moderation/moderation_rule_test.md index 339f918dd..94c0b9b07 100644 --- a/docs/product/moderation/moderation_rule_test.md +++ b/docs/product/moderation/moderation_rule_test.md @@ -1,36 +1,28 @@ -# 规则测试 +# 测试审核规则 -## 前提条件 +若 [开通了内容审核服务](purchase_value_added.html#内容审核)，你在配置审核规则后，可进行规则测试。 -[开通内容审核服务](moderation_enable.html)。 +本文以测试文本审核规则为例进行介绍。 -## 测试审核效果 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 + +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 + +3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 文本审核**。 -本文以文本审核服务为例，介绍如何使用后台**规则测试**页面快捷测试审核效果。 +4. 选择 **内容审核 > 文本审核 > 规则测试**，打开 **规则测试** 页面。 -**1、进入规则测试页** +![img](/images/console/moderation_text_rule_test.png) -选择**内容审核 > 文本审核 > 规则测试**，打开**规则测试**页面。 +5. 在 **内容审核** 栏中，输入规则名称和审核内容，点击 **立即审核**。 + +6. 在 **消息处理结果** 栏中，查看审核结果和消息处理结果。 -![img](/images/moderation/moderation_rule_test_01.png) - -**2、选择规则名称** - -**规则名称**可显示当前已创建的所有规则，选择后即会按对应规则审核，此处以单聊文本为例演示。 - -![img](/images/moderation/moderation_rule_test_02.png) - -**3、输入要审核的文本内容** - -![img](/images/moderation/moderation_rule_test_03.png) - -**4、点击立即审核，查看结果** - -![img](/images/moderation/moderation_rule_test_04.png) - -审核结果：表示智能模型审核返回的结果。如果该结果不符合预期，可通过新增自定义调整，如有疑问可联系商务。 +审核结果：表示智能模型审核返回的结果。如果该结果不符合预期，可联系商务开通在第三方平台新增自定义词条的功能。 - 调用成功时，会返回 通过/拒绝/疑似； -- 调用异常，会出现 无权限/调用失败（即超时未返回结果）2 类情况。 +- 调用异常，会出现 无权限/调用失败（即超时未返回结果）两类情况。 + +消息处理结果：表示消息的下发结果，根据规则里配置得出；存在通过/拦截/替换*** 三种情况。如果该结果不符合预期，可通过修改规则配置调整，详见 [规则配置](moderation_rule_config.html)。 -消息处理结果：表示消息的下发结果，根据规则里配置得出；存在通过/拦截/替换*** 3 种情况。如果该结果不符合预期，可通过修改规则配置调整，详见[规则配置](moderation_rule_config.html)。 \ No newline at end of file +![img](/images/console/moderation_text_rule_test_result.png) \ No newline at end of file diff --git a/docs/product/console/moderation_user_tag.md b/docs/product/moderation/moderation_user_tag.md similarity index 79% rename from docs/product/console/moderation_user_tag.md rename to docs/product/moderation/moderation_user_tag.md index 6569676ea..1c21951c9 100644 --- a/docs/product/console/moderation_user_tag.md +++ b/docs/product/moderation/moderation_user_tag.md @@ -5,18 +5,18 @@ - 用户标签：用于文本、图片以及音视频审核规则中的子规则。 - 群组/聊天室标签：用于关键词名单审核。 -你可以按以下步骤打开 **用户标签管理** 页面： +你可以按以下步骤打开 **标签管理** 页面： 1. 登录 [环信控制台](https://console.easemob.com/user/login)。 2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 -3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 用户标签管理**。 +3. 在左侧导航栏，选择 **功能配置 > 增值服务 > 内容审核 > 标签管理**。 ## 创建标签 -1. 在 **用户标签管理** 页面，点击 **创建标签**，在弹出的对话框中配置标签名称和标签类型。 +1. 在 **标签管理** 页面，点击 **创建标签**，在弹出的对话框中配置标签名称和标签类型。 - 若创建用户标签，**标签类型** 设置为 **用户**。最多可创建 10 个标签，每个标签下最多可标记 1000 个用户；同一用户仅支持绑定在一个标签下。 -- 若创建群组/聊天室标签，**标签类型** 设置为 **群组/聊天室**。最多可创建 20 个标签，每个标签下最多可标记 10,000个群组和聊天室。 +- 若创建群组/聊天室标签，**标签类型** 设置为 **群组/聊天室**。最多可创建 20 个标签，每个标签下最多可标记 10,000 个群组和聊天室。 ![img](/images/console/moderation_tag_add.png) @@ -34,7 +34,7 @@ ## 编辑和删除标签 -在 **用户标签管理** 页面，点击指定标签的 **操作** 栏中的 **编辑** 或 **删除** 对该标签进行编辑或删除。 +在 **标签管理** 页面，点击指定标签的 **操作** 栏中的 **编辑** 或 **删除** 对该标签进行编辑或删除。 若标签在内容审核子规则或关键词名单中使用则无法删除。若要删除，应先解除使用。 diff --git a/docs/product/moderation/moderation_usermgmt.md b/docs/product/moderation/moderation_usermgmt.md index f8c53e4c5..fd350e2c2 100644 --- a/docs/product/moderation/moderation_usermgmt.md +++ b/docs/product/moderation/moderation_usermgmt.md @@ -1,93 +1,18 @@ -# 用户管理 +# 用户审核 -对于开发者来说，提供一个安全、干净的聊天环境至关重要。环信即时通讯 IM 提供了多维度服务可智能审核消息内容，发现用户不当行为后对用户和违规内容进行处理，具体包括： +对于开发者来说，提供一个安全、干净的聊天环境至关重要。环信即时通讯 IM 允许你发现用户不当行为后对其进行处理，包括用户封禁、强制下线和删除。 -- 消息管理：消息内容举报，消息内容审核（文本审核，根据敏感词名单过滤、图片审核、域名审核），根据消息内容审核结果配置不同策略（下发或拦截）； -- 用户管理：app 内用户管理、群组成员管理、聊天室成员管理。 +| 功能 | 描述 | +| :------------------- | :----- | +| 用户封禁 | 禁用一个用户账户。禁用后，该用户会立即下线，且无法登录直到解除封禁。 | +| 强制用户下线 | 强制用户下线，进入离线状态。被强制下线的用户需要重新登录才能正常使用 IM 服务。 | +| 删除用户 | 该用户账号信息将被删除。如果被删除的用户是群组或者聊天室的所有者，该用户所管理的群组和聊天室也会相应被删除。 | -## 前提条件 +你可以按照以下步骤在 [环信控制台](https://console.easemob.com/user/login) 对用户进行管理： -- 有效的 [环信即时通讯 IM 开发者账号](https://console.easemob.com/index)； -- 账户余额大于 288 元； -- 消息举报功能需同时在客户端集成相应 API。 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏，选择 **运营管理** > **运营操作**。 +4. 在 **用户管理** 页面，在用户列表中，点击指定用户的 **操作** 栏中的 **更多** ，可以对用户进行封禁、强制下线、删除操作。 -## 应用内用户管理 - -发现违规行为后，对于违规用户可以进行多种限制操作，包括：用户应用级别的控制、群组成员管理、聊天室成员管理。具体限制如下： - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
分类功能描述
用户管理用户封禁禁用一个用户账户。禁用后，该用户会立即下线，且无法登录直到解除封禁。
强制用户下线强制用户下线，进入离线状态。被强制下线的用户需要重新登录才能正常使用 IM 服务。
删除用户该用户账号信息将被删除。如果被删除的用户是群组或者聊天室的所有者，该用户所管理的群组和聊天室也会相应被删除。
群组管理群组用户禁言群组禁言是指禁止指定群组用户在群组中发送消息。被禁言用户直到禁言状态被解除，才能发送消息。
群组全局禁言全局禁言是指禁止群组全部用户在群组中发送消息。被禁言的群组直到禁言状态被解除，群中成员才能发送消息。
群组黑名单被加入到群组黑名单的用户将被移出群，并且不能再次加入。
删除群成员删除群成员是指把用户从群成员列表中删除，被删除的用户需要重新加入群才能收到群消息。
聊天室管理聊天室用户禁言聊天室禁言是指禁止指定成员在聊天室中发送消息。被禁言用户直到禁言状态被解除，才能发送消息。
聊天室全局禁言全局禁言是指禁止聊天室全部用户在聊天室中发送消息。被禁言的聊天室直到禁言状态被解除，聊天室中成员才能发送消息。
聊天室黑名单被加入到聊天室黑名单列表的用户将被移出聊天室，并且不能再次加入。
删除聊天室成员删除聊天室成员是指把用户从聊天室成员列表中删除，被删除的用户需要重新加入聊天室才能收到聊天室消息。
- -## 用户管理 - -1. 在 Console 中点击具体应用的 **管理** 按钮，然后依次点击左侧导航栏的 **即时通讯** > **运营服务** > **用户管理**，进入用户管理页面； -2. 搜索指定的用户 ID，在用户列表中，点击操作的 ** -更多** 按钮，可以对用户进行封禁、强制下线、删除操作。 - -![img](/images/moderation/moderation_usermgmt_01.png) - -### 群组成员管理 - -1. 在 Console 中点击具体应用的 **管理** 按钮，然后依次点击左侧导航栏的 **即时通讯** > **运营服务** > **群组管理**，进入群组管理页面； -2. 搜索指定的群组 ID，在群组列表中，点击操作的 **更多** 按钮，可以对群成员进行删除、加入黑名单操作； - -![img](/images/moderation/moderation_usermgmt_02.png) - -### 聊天室成员管理 - -1. 在 Console 中点击具体应用的 **管理** 按钮，然后依次点击左侧导航栏的 **即时通讯** > **运营服务** > **聊天室管理**，进入聊天室管理页面； -2. 搜索指定的聊天室 ID，在聊天室列表中，点击操作的 **更多** 按钮，可以对聊天室成员进行删除、加入黑名单操作； - -![img](/images/moderation/moderation_usermgmt_03.png) \ No newline at end of file +![img](/images/console/operation_user_moderation.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..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/enable_and_configure_IM.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 584da5f33..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/enable_and_configure_IM.html#创建-im-用户)。 +除此以外，可以在[环信控制台](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_androidvendor_statistics.md b/docs/push/push_androidvendor_statistics.md index 637a3eb14..3582b0bf3 100644 --- a/docs/push/push_androidvendor_statistics.md +++ b/docs/push/push_androidvendor_statistics.md @@ -83,7 +83,7 @@ 根据所在集群设置回调地址（配置 https，注意：华为只支持https地址配置） 格式为：`https://域名/orgname/appname/push/report/huawei` -您可以在环信后台，**即时通讯** > **服务概览** 中查看当前 Appkey 的 Rest API 域名地址，仅支持填写 `easemob.com` 类型。 +您可以在环信控制台的 **应用概览** 页面中查看当前 Appkey 的 Rest API 域名地址，仅支持填写 `easemob.com` 类型。 ![img](/images/instantpush/push_domain_name.png) 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_certificate_config.md b/docs/push/push_certificate_config.md index 1de2c5009..e240ea7d8 100644 --- a/docs/push/push_certificate_config.md +++ b/docs/push/push_certificate_config.md @@ -1,17 +1,175 @@ -## 证书配置 +# 证书管理 -环信推送与IM使用相同的SDK，SDK下载地址：[下载页](https://www.easemob.com/download/im) +使用即时推送前，你需完成各平台的证书配置。即时通讯 IM 支持苹果 APNs、谷歌 FCM、华为、小米、OPPO、魅族、VIVO 和荣耀。 -Android端推送集成：[Android 推送集成](push_integration_process_android.html) +## 添加推送证书 -iOS端推送集成：[iOS 推送集成](push_integration_process_ios.html) +你可以按照以下步骤添加推送证书： -### 上传证书 +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏，选择 **功能配置** > **增值功能** > **即时推送**。 +4. 在 **证书管理** 页面，点击 **添加推送证书**。 -进入即时推送页面，进入“配置证书”页面，点击“添加推送证书”进行厂商证书的添加。 +### 谷歌 FCM 证书 -![img](/images/instantpush/push_certificate_add.png) +在 **添加推送证书** 页面打开后，默认显示 **谷歌** 页签。你可以在该页面配置谷歌 FCM 推送证书。 + +![img](/images/console/push_certificate_fcm.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :---------------------------- | +| 证书类型 | 文件 | 是 | 选择使用 V1 或旧版证书。
- **V1**：推荐使用。你需要点击 **上传证书** 上传FCM V1 版本证书文件，并且设置 **证书名称**。
-**旧版**：已弃用，不推荐使用。你需要配置 **证书名称** 和 **推送密钥**。 | +| 上传文件 | 文件 | 是 | 点击 **上传证书** 上传获取的 FCM V1 版本证书文件（.json 文件）。此项仅对 V1 证书有效。 | +| 证书名称 | String | 是 | FCM 的发送者 ID。
- v1 证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn) 的 **项目设置** > **云消息传递** 页面的 **Firebase Cloud Messaging API（V1）** 区域中获取发送者 ID，如下图所示。
- 旧版证书：在 [Firebase 控制台](https://console.firebase.google.com/?hl=zh-cn)的 **项目设置 > 云消息传递** 页面的 **Cloud Messaging API（旧版）** 区域中获取发送者 ID，如下图所示。 | +| 推送密钥 | String | 是 | FCM 服务器密钥。你需在 [Firebase 控制台](https://console.firebase.google.com/) 的 **项目设置** > **云消息传递**页面的 **云消息传递 API（旧版）** 区域中获取服务器密钥，如下图所示。此参数仅对旧版证书有效。| +| 通道 ID | String | 否 | FCM 通道 ID。该参数仅对离线推送有效。 | +| 推送优先级设置 | | 否 | 消息传递优先级。请参见 [设置消息优先级](https://firebase.google.cn/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message)。
该参数仅对离线推送有效。| +| 推送消息类型 | | 否 | 通过 FCM 发送给客户端的消息类型：
- **数据**：数据消息，由客户端应用程序处理。
- **通知**：通知消息，由 FCM SDK 自动处理。**数据+通知**：通知消息和数据消息都可以通过 FCM 客户端发送。
请参见 FCM 的 [消息类型介绍](https://firebase.google.com/docs/cloud-messaging/concept-options#notifications_and_data_messages)。
该参数仅对离线推送有效。| +| APNs跨平台推送支持 | String | 否 | 是否开启 APNs 跨平台推送支持。非跨平台应用建议不要启用。该参数仅对离线推送有效。| + +- 获取 V1 版证书名称 + +![image](/images/android/push/fcm_v1.png) + +- 获取旧版证书名称和推送密钥 + +![image](/images/android/push/fcm_old_version.png) + +#### **旧版证书无缝切换至 V1 证书** + +旧版 HTTP 或 XMPP API 已在 2024 年 6 月 20 日停用，请尽快迁移到最新的 FCM API（HTTP v1）版本证书，详见 [FCM 控制台](https://console.firebase.google.com)。请确保 V1 证书可用，因为执行转换证书后，旧证书会被删除，若 V1 证书不可用会导致推送失败。 + +你可以参考以下步骤从旧版证书无缝切换到 V1 新证书： + +1. 在 **证书管理** 页面的旧版证书的 **操作** 栏中点击 **编辑**。 +2. 在**编辑推送证书** 窗口的 **谷歌** 页签，将**证书类型**切换为 **V1**。 +3. 点击 **上传证书** 上传本地保存的 V1 证书文件（.json）。 +4. 点击 **保存** 完成切换。 + +### 苹果 APNs 证书 + +在 **添加推送证书** 页面，点击 **苹果** 页签，配置苹果 APNs 推送证书。 + +![img](/images/console/push_certificate_apns.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :----------------------- | +| 证书类型 | | 是 | 消息推送证书类型，目前支持 **p8** 和 **p12**。 | +| 证书名称 | String | 是 | 消息推送证书名称。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书) 的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中创建的消息推送证书名称。 | +| 推送密钥 | String | 否 | 消息推送证书密钥。填写在 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中导出消息推送证书文件时设置的证书密钥。该参数仅在使用 p12 证书时需要配置。 | +| 上传文件 | File | 是 | 点击 **上传证书** 上传推送证书文件。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤四](/document/ios/push/push_apns.html#步骤四-生成推送证书) 中获取的消息推送证书文件。 | +| key id | String | 是 | 输入推送证书的 Key ID。该参数仅对 p8 证书有效。 | +| team id | String | 是 | 输入推送证书的 Team ID。该参数仅对 p8 证书有效。 | +| 集成环境 | | 是 | 集成环境，包括开发环境和生产环境。 | +| Bundle ID | String | 是 | 绑定 ID。详见 APNs 集成文档中 [创建推送证书](/document/ios/push/push_apns.html#创建推送证书)的 [步骤二](/document/ios/push/push_apns.html#步骤二-创建-app-id) 中创建 App ID 时设置的 Bundle ID。
- 上传 VoIP 服务证书时，Bundle ID 末尾需要加 .voip 后缀 `nvyvtp.dabaoiian`，例如，**Bundle ID** 为 **com.example.demo**，上传对应 VoIP 证书时需要填写 **com.example.demo.voip**。| +| 铃声 | String | 否 | 接收方收到推送通知时的铃声提醒，该参数仅对离线推送有效：
- 设置的铃声最多为 30 秒。若超过该时间，系统会启用默认铃声 default。
- 铃声文件只支持 aiff、wav 和 caf 格式，例如铃声命名 test.caf。
- 铃声文件必须放在 app 的 /Library/Sounds 目录中。
- 如果铃声文件未找到，或不填，响铃为系统默认铃声。 | + +### 华为推送证书 + +在 **添加推送证书** 页面，点击 **华为** 页签，配置华为推送证书。 + +![img](/images/console/push_certificate_huawei.png) + +华为推送参数相关信息，详见你在华为开发者后台创建的 [应用信息中的 App ID 和 SecretKey 以及程序的包名](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section125831926193110)。 + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | 华为 Client ID。 | +| 推送密钥 | String | 是 | 华为 Client Secret。| +| 应用包名 | String | 是 | 华为 App package name。 | +| 项目 ID | String | 否 | 项目 ID。 | +| Category | String | 否 | 自动分类权益申请 Category。该参数仅对离线推送有效。 | +| Action | String | 否 | 点击通知后的动作。组件定义的 intent-filter action name。该参数仅对离线推送有效。 | +| ActivityClass | String | 否 | 角标显示，应用入口类路径。示例：com.easemob.MainActivity。该参数仅对离线推送有效。 | + +### 小米推送证书 + +在 **添加推送证书** 页面，点击 **小米** 页签，配置小米推送证书。 + +![img](/images/console/push_certificate_xiaomi.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | 小米 App ID。 | +| 推送密钥 | String | 是 | 小米 App Secret。| +| 应用包名 | String | 是 | 小米 App package name。 | +| Channel ID | String | 是 | Channel ID。该参数仅对离线推送有效。 | +| Action | String | 否 | 点击通知后的动作。该参数仅对离线推送有效。 | + +### OPPO 推送证书 + +在 **添加推送证书** 页面，点击 **OPPO** 页签，配置 OPPO 推送证书。 + +![img](/images/console/push_certificate_oppo.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | OPPO App Key。 | +| 推送密钥 | String | 是 | OPPO Master Secret。详见 [OPPO 推送平台](https://open.oppomobile.com/) > **配置管理** > **应用配置** 页面。| +| 应用包名 | String | 是 | OPPO App package name。 | +| Channel ID | String | 否 | Channel ID。该参数仅对离线推送有效。 | +| Activity | String | 否 | 选择点击通知后的动作。 该参数仅对离线推送有效。 | +| Category | String | 否 | 消息分类。该参数仅对离线推送有效。 | +| NotifyLevel | String | 否 | 通知栏消息提醒等级取值定义:
- **1**：通知栏
- **2**：通知栏+锁屏
- **16**：通知栏+锁屏+横幅+震动+铃声
该参数仅对离线推送有效。| + +### 魅族推送证书 + +在 **添加推送证书** 页面，点击 **魅族** 页签，配置魅族推送证书。 + +![img](/images/console/push_certificate_meizu.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | 魅族 App ID。 | +| 推送密钥 | String | 是 | 魅族 App Secret。| +| 应用包名 | String | 是 | 魅族 App package name。 | +| Activity| String | 否 | 点击通知后的动作。该参数仅对离线推送有效。 | +| 推送送达回执 | String | 否 | 是否开启推送送达回执。
- 开发者需要在 Flyme 推送平台新建回执后，才能开启推送送达回执，获取到魅族推送通道送达到设备的推送数据。
- 该参数仅对离线推送有效。 | + +### VIVO 推送证书 + +在 **添加推送证书** 页面，点击 **VIVO** 页签，配置 VIVO 推送证书。 + +![img](/images/console/push_certificate_vivo.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | VIVO App ID。 | +| 证书标识 | String | 是 | VIVO App Key。| +| 推送密钥 | String | 是 | VIVO App Secret。| +| Category | String | 否 | Category 类型。关于该参数，详见 [VIVO 推送文档](https://dev.vivo.com.cn/documentCenter/doc/359#w2-67805227)。该参数仅对离线推送有效。 | +| 应用包名 | String | 是 | VIVO App package name。该参数仅对离线推送有效。 | +| Activity| String | 否 | 点击通知后的动作。 该参数仅对离线推送有效。 | +| 推送类型 | String | 否 |可选择 **运营消息** 或 **系统消息**。该参数仅对离线推送有效。 | + +### 荣耀推送证书 + +在 **添加推送证书** 页面，点击 **荣耀** 页签，配置荣耀推送证书。 + +![img](/images/console/push_certificate_rongyao.png) + +| 推送证书参数 | 类型 | 是否必需 | 描述 | +| :-------------- | :----- | :------- | :--------------------------------------- | +| App ID | String | 是 | 应用标识符，应用的唯一标识，在荣耀开发者服务平台开通对应用的荣耀推送服务时生成。 | +| Client ID | String | 是 | 应用的客户 ID，用于获取发送消息令牌的 ID，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | +| Client Secret | String | 是 | 应用的客户密钥，用于获取发送消息令牌的密钥，在荣耀开发者服务平台开通对应应用的荣耀推送服务时生成。 | +| Badge Class | String | 否 | 应用入口 Activity 类全路径，例如 com.example.test.MainActivity。
该参数仅对离线推送有效。 | +| Action | String | 否 | 消息接收方在收到离线推送通知时，单击通知栏时打开的应用指定页面的自定义标记。
- 该参数需要与客户端 `AndroidManifest.xml` 文件中注册启动的 `Activity` 类中 `intent-filter` 页签中设置的 `action` 一致。
- 该参数仅对离线推送有效。 | :::tip -Push与IM使用相同的SDK，证书配置可以通用。 -::: \ No newline at end of file +关于 **App ID**、**Client ID** 和 **Client Secret**，可在荣耀开发者服务平台申请开通推送服务后，在 **推送服务** 页面选择创建的应用，在 [**查看推送服务**](https://developer.honor.com/cn/docs/11002/guides/app-registration#申请开通推送服务) 页面查看。 +::: + +### 鸿蒙推送证书 + +在 **添加推送证书** 页面，点击 **鸿蒙** 页签，配置鸿蒙推送证书。 + +![img](/images/console/push_certificate_harmony.png) + +| 参数 | 类型 | 是否必需 | 描述 | +| :-------- | :----- | :------- | :---------------- | +| 证书名称 | String | 是 | 推送证书名称，即鸿蒙 Client ID。
证书名称是环信服务器用来判断目标设备使用哪种推送通道的唯一条件，因此 **必须确保与 HarmonyOS 终端设备上传的证书名称一致。**
详见 [**创建服务账号密钥** 页面的 **名称** 参数的值](https://developer.huawei.com/consumer/cn/doc/start/api-0000001062522591#section11695162765311)。| +| 上传文件 | - | 是 | 点击 **上传证书**，上传 JSON 推送证书，即服务账号的密钥文件。关于申请服务器密钥，可参见官方文档：[华为 API Console 操作指南-服务帐号密钥](https://developer.huawei.com/consumer/cn/doc/start/api-0000001062522591#section11695162765311)，选择启用推送服务后，再生成服务器密钥。 | +| Category | - | 否 | 通知消息类别。详见 [HarmonyOS NEXT 官网相关文档](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-apply-right-V5#section16708911111611)。
该参数仅对离线推送有效。| +| Action | - | 否 | 消息接收方收到离线推送通知时，单击通知栏时打开的应用指定页面的自定义标记。
该参数仅对离线推送有效。 | \ No newline at end of file diff --git a/docs/push/push_createnotification.md b/docs/push/push_createnotification.md deleted file mode 100644 index 40c302bb3..000000000 --- a/docs/push/push_createnotification.md +++ /dev/null @@ -1,70 +0,0 @@ -## 创建推送 - -点击 **即时推送** 的 **创建推送** 页面，即可创建推送任务。 - -环信支持用户创建通知消息及透传消息。 - -- 通知消息：指定通知标题和内容后，由环信SDK自动处理后、在系统通知栏中以通知栏消息的形式展示，同时响铃或震动提醒用户。 -- 透传消息：即自定义消息，消息体格式客户可以自己定义。透传消息环信只传递数据，不做任何处理，客户端接收到透传消息后需要自己去做后续动作处理，如通知栏展示、弹框等。 - -![img](/images/instantpush/push_notification_create.png) - -### 通知消息 - -依次填写内容编辑、推送目标、推送设置的推送配置内容 - -#### 内容编辑： - -- 目标平台（默认选择）：支持安卓、iOS 平台 -- 通知栏标题 -- 子标题：只有 iOS 支持 -- 通知内容 - -![img](/images/instantpush/push_notification_edit.png) - -#### 推送目标： - -- 全量用户 -- 指定用户：接收人以英文逗号分开，最多 1000 个接收人 -- 指定标签用户：支持最多选择3个标签，支持交集运算 - -![img](/images/instantpush/push_user_certain.png) - -![img](/images/instantpush/push_user_tagged.png) - -#### 推送设置： - -- 通知图标：支持环信通道 -- 展开样式：支持普通样式、大文本样式、大图片样式（iOS 暂不支持） -- 后续动作：Android 支持启动应用、打开链接、打开特定页面；iOS 环信通道支持启动应用、打开链接；APNs 仅支持启动应用 -- 附加字段 -- 推送时段：选择立即推送或者定时推送（例如 1 个小时之后，一个月之内） -- 离线消息保留时长：离线消息保留时长设置只适用厂商通道，环信通道离线消息保留时长默认7天 -- 通道策略：选择合适的推送发送策略 - - 环信通道优先，在线走环信，离线走厂商（默认策略） - - 只通过第三方厂商推送（失败后直接丢弃） - - 在线或者离线都通过环信通道推送 - - 厂商通道优先，失败时走环信通道 -- 角标数字：该角标为环信通道角标设置 - - 厂商通道仅支持华为 EMUI4.1 以上 - - APNS 仅支持不变和设置数字 - - 选择不变时，表示不改变角标数字（小米设备由于系统控制，无论选择环信通道还是厂商通道下发，默认角标 +1 的效果） -- 提醒方式：设置提醒方式，包含提示音和震动 - -![img](/images/instantpush/push_setting.png) - -另外，推送支持发送预览，Web界面会弹出推送预览界面，点击 **确认推送** 即可。 - -![img](/images/instantpush/push_preview.png) - -推送完成后，在 **推送任务** 推送任务界面查看推送结果 - -### 透传消息 - -透传消息受厂商限制，仅支持环信通道。 - -透传消息可以进行推送目标、推送时间、附加字段的设置。 - -![img](/images/instantpush/push_transparent_message.png) - -同样，透传消息支持 **发送预览** ，推送完成后，在 **推送任务** 推送任务界面查看推送结果。 \ No newline at end of file diff --git a/docs/push/push_createproduct_app.md b/docs/push/push_createproduct_app.md index ec6a3ff9b..c72d03119 100644 --- a/docs/push/push_createproduct_app.md +++ b/docs/push/push_createproduct_app.md @@ -7,29 +7,21 @@ ### 1、创建环信应用 -注册环信账号，并登录环信通讯云管理后台：[环信通讯云管理后台](https://console.easemob.com/user/login)，点击【添加应用】，根据提示填写应用信息，创建您的第一个应用。 +[注册环信账号，登录环信控制台](/product/console/account_register.html)，[创建应用](/product/console/app_create.html)。 -![img](/images/instantpush/push_create_app.png) +### 2、开通推送服务 -### 2、开通PUSH服务 +创建推送任务前，你需在 [环信控制台](https://console.easemob.com/user/login) 开通即时推送服务。 -APP创建成功后，将显示至【应用列表】中，选中创建的APP，点击其【查看】按钮，为您的APP开通相应业务。 +若仅需测试推送功能，请使用全功能应用 `Demo`，在对话框中点击 **测试DemoKey**。 -![img](/images/instantpush/push_view_app.jpg) - -左侧菜单栏为环信云支持的即时通讯、MQTT、短信服务、实时音视频以及PUSH等业务。 - -这里选中【即时推送】→【服务概览】，点击页面中【立即开通】按钮开通PUSH业务。 - -![img](/images/instantpush/push_enable.png) - -默认开通PUSH免费版，不收取任何费用，如需开通更高版本套餐，请咨询商务经理。 +![img](/images/console/push_task_create.png) ### 3、集成环信PUSH服务 #### 3.1 SDK下载 -环信推送与IM使用相同的SDK，SDK下载地址：[SDK下载页](https://www.easemob.com/download/im) 。 +环信推送与 IM 使用相同的 SDK，SDK下载地址：[SDK 下载页](https://www.easemob.com/download/im) 。 ![img](/images/instantpush/push_sdk_download.png) @@ -44,15 +36,16 @@ APP创建成功后，将显示至【应用列表】中，选中创建的APP， ### 4、配置推送证书 -点击进入【配置证书】，点击【添加推送证书】进行厂商证书的添加。 -环信PUSH支持全平台系统下发，覆盖谷歌、华为、小米、魅族、OPPO、vivo等主流手机厂商通道，iOS双证书支持。 PUSH与IM使用相同的SDK，证书配置可以通用。 +选择**功能配置 > 增值功能 > 即时推送 > 证书管理**，点击 **添加推送证书** 进行厂商证书的添加。 + +环信PUSH支持全平台系统下发，覆盖谷歌、苹果、华为、小米、魅族、OPPO、vivo、荣耀等主流手机厂商通道，iOS双证书支持。 PUSH与IM使用相同的SDK，证书配置可以通用。 -![img](/images/instantpush/push_add_certificate.png) +![img](/images/instantpush/push_certificate_add.png) ### 5、绑定推送用户 -未使用环信 IM 的用户，需要单独创建用户并进行用户体系集成。 -在环信即时通讯云的左侧导航栏中，选择 【即时通讯 > 运营服务 > 用户管理】，点击【创建IM用户】可以在页面中添加用户，也可使用 REST API进行用户配置。 +未使用环信即时通讯 IM 的用户，需要单独创建用户并进行用户体系集成。 +在环信即时通讯 IM 的左侧导航栏中，选择 **功能配置 > 增值功能 > 即时推送**，在 **用户管理** 页面，点击 **创建PUSH用户** 可以在页面中添加用户，也可使用 REST API进行用户配置。 用户体系集成介绍参考文档：[用户体系集成](/document/server-side/account_system.html) ![img](/images/instantpush/push_bind_user.png) 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/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/push/push_statistics.md b/docs/push/push_statistics.md index 10bec2688..680db3d59 100644 --- a/docs/push/push_statistics.md +++ b/docs/push/push_statistics.md @@ -1,22 +1,26 @@ -## 数据统计 +# 推送数据统计 -点击 **即时推送** 的 **数据统计** 页面，可以看到推送的数据统计。 +环信推送提供推送数据统计。[开通即时推送](push_task_create.html#开通服务) 后，若进行了通知推送，可选择 **功能配置** > **增值服务** > **即时推送** > **推送统计**，查看推送数量统计、推送成功率和推送厂商通道占比。 -环信即时推送平台提供推送信息、推送成功率、推送厂商占比、推送指标等信息。 +## 按天统计推送数据 -环信 PUSH 提供按天统计的推送详情： +环信推送提供按天统计的推送详情，如下图所示： -- 推送成功数、推送失败数、推送未知数 - - 推送失败的原因包含不具备推送条件（如未配置证书、没有绑定设备）以及厂商返回失败（如 bad device token、通道限额等原因） - - 推送未知的原因为环信服务器端未知异常 -- 推送成功率 -- 推送厂商通道占比 +![img](/images/console/push_statistics_1.png) -![img](/images/instantpush/push_statistics_1.png) +| 统计维度 | 描述 | +| :------- | :----- | +| 推送数量 | 包括推送成功数、推送失败数、推送未知数。
- 推送失败的原因包含不具备推送条件（如未配置证书、没有绑定设备）以及厂商返回失败（如 bad device token、通道限额等原因）。
- 推送未知的原因为环信服务器端未知异常。| +| 推送成功率 | 推送的成功率。 | +| 推送厂商通道占比 | 各推送厂商通道的推送数比例。 | -环信 PUSH 提供一定时间段的推送数据及推送指标统计详情： +## 按时间段统计推送数据 -- 推送数量：各个通道（全部、环信在线通道、谷歌、华为、小米、魅族、OPPO、VIVO、APNs）的推送详情：推送成功数、推送失败数、推送未知数 -- 推送指标：全部通道（包含环信在线通道、小米、魅族、VIVO、APNS）、环信在线通道、小米、魅族、VIVO、APNS 通道的发送数、送达数、点击数 +环信推送提供一定时间段的推送数据及推送指标统计详情，如下图所示： -![img](/images/instantpush/push_statistics_2.png) +![img](/images/console/push_statistics_2.png) + +| 统计维度 | 描述 | +| :------- | :----- | +| 推送数量 | 各个通道（全部、环信在线通道、谷歌、华为、小米、魅族、OPPO、VIVO、APNs）的推送详情：推送成功数、推送失败数、推送未知数。| +| 推送指标 | 全部通道（包含环信在线通道、小米、魅族、VIVO、APNS）、环信在线通道、小米、魅族、VIVO、APNS 通道的发送数、送达数、点击数。 | diff --git a/docs/push/push_tag_mgmt.md b/docs/push/push_tag_mgmt.md index 281135777..f44c6c95f 100644 --- a/docs/push/push_tag_mgmt.md +++ b/docs/push/push_tag_mgmt.md @@ -1,37 +1,49 @@ # 标签管理 -环信即时推送平台支持用户标签自定义，个性化用户属性，方便企业对客户精细化管理。 可以对标签进行创建标签、用户名绑定、用户名解绑、删除标签等操作。 +环信即时推送平台支持用户标签自定义，个性化用户属性，方便企业对客户精细化管理。 -![img](/images/instantpush/push_tag_mgmt.png) +[开通即时推送](push_task_create.html#开通服务) 后，选择 **功能配置** > **增值服务** > **即时推送** > **标签管理**，你可以创建标签、绑定或解绑用户、以及删除标签等操作。 + +![img](/images/console/push_tag_mgmt.png) ## 创建标签 -点击 **创建标签** 即可创建标签。 +在 **标签管理** 页面，点击 **创建标签** 创建推送标签。每个应用最多支持 100 个标签。 + +- **标签名称**：最多支持 20 个字符，支持中英文字符。 +- **标签描述**：最多支持 100 个字符。 + +![img](/images/console/push_tag_create.png) + +## 绑定用户 + +在 **标签管理** 页面，点击指定推送标签的 **操作** 栏中的 **用户名绑定**，向该标签添加用户。每个标签的用户数上线为 2 万。若需要增加标签的用户数，请联系商务。 + +你可以通过以下两种方式绑定用户： + +- **手动输入**：最多可输入 100 个用户 ID，每行一个，可多次绑定。 + +![img](/images/console/push_bindtaguser_manual.png) -- 标签名称：最多支持 20 个字符，支持中英文 -- 标签描述：最多支持 100 个字符 +- **文件上传**：支持 csv 格式，单个文件不能超过 2 MB，文件最多 2 万行（超过 2 万行只读取前 2 万数据），可多次上传。 -![img](/images/instantpush/push_tag_create.png) +![img](/images/console/push_bindtaguser_fileupload.png) -## 用户名绑定标签 +## 解绑用户 -点击 **用户名绑定** 为标签创建用户，用户名绑定支持手动输入以及文件上传两种方式。 +- 在 **标签管理** 页面，点击指定推送标签的 **操作** 栏中的 **解绑**，解绑单个用户。 -- 手动输入：最多填写 100 个用户名，每行代表一个用户，可多次上传 -- 文件上传：支持 csv 格式，单个文件不能超过 2 MB，文件最多 2 万行（超过 2 万行只读取前 2 万数据），可多次上传。 +![img](/images/console/push_tag_unbinduser.png) -**注意：每个标签的用户数上线为 2 万，需要增加标签的用户数可联系商务。** +- 选择多个用户，点击 **解绑所选用户**，批量解绑用户。 -![img](/images/instantpush/push_bindtaguser_manual.png) +![img](/images/console/push_tag_unbinduser_all.png) -![img](/images/instantpush/push_bindtaguser_fileupload.png) +## 删除标签 -## 用户名解绑 +当标签下没有用户时，可删除标签。若标签下有绑定的用户，需要先解绑所有用户，再删除标签。 -点击 **用户名解绑** 为标签解绑用户，可以选择单个用户进行解绑，也可以选择多个用户进行批量解绑。 +![img](/images/console/push_tag_delete.png) -![img](/images/instantpush/push_tag_unbinduser.png) -## 删除 -当标签下没有用户时，标签可以删除。 \ No newline at end of file diff --git a/docs/push/push_task.md b/docs/push/push_task.md index 326f3b1c0..3a4bbabe6 100644 --- a/docs/push/push_task.md +++ b/docs/push/push_task.md @@ -1,19 +1,22 @@ -## 推送任务 +# 推送任务 -**推送任务** 页面用于查看历史推送的统计详情。 +[开通即时推送](push_task_create.html#开通服务) 后，你在 **创建推送** 页面上创建推送任务后，即可在 **推送任务** 页面查看推送任务详情。 -![img](/images/instantpush/push_task_list.png) +1. 选择 **功能配置** > **增值服务** > **即时推送** > **推送服务**，查看历史推送任务详情，包括通知标题、推送内容、推送目标和任务状态等。 -点击 **查看** 可查询具体每个任务的下发状态，每当推送状态变更，环信PUSH都会有相应记录，用户每次更新网页可得到当前实时的推送结果展示。 +![img](/images/console/push_task_list.png) -环信PUSH提供的统计维度包括： +2. 查看推送任务详情。 -- 推送成功数、推送失败数、推送未知数 - - 推送失败的原因包含不具备推送条件（如未配置证书、没有绑定设备）以及厂商返回失败（如bad device token、通道限额等原因） - - 推送未知的原因为环信服务器端未知异常 -- 数据详情：各个通道（环信在线通道、谷歌、华为、小米、魅族、OPPO、vivo、APNS）的推送详情：推送成功数、推送总数 - - 支持查看各个通道的推送成功数、推送失败数、推送未知数 -- 推送成功率 -- 本次推送涉及到的通道（在线通道、苹果、小米、VIVO、魅族）的送达数、送达率、点击数、点击率 +在推送任务列表中，点击指定任务的 **操作** 栏中的 **查看**，查询该任务的详情，包括推送数量、推送成功率以及送达和点击详情。 -![img](/images/instantpush/push_task_statistics.png) \ No newline at end of file +![img](/images/console/push_task_details.png) + +环信推送提供的统计维度描述如下： + +| 统计维度 | 描述 | +| :------- | :----- | +| 推送数量统计 | 推送成功数量、推送失败数量、推送未知数量统计：
- 推送失败的原因包含不具备推送条件（如未配置证书、没有绑定设备）以及厂商返回失败（如 bad device token、通道限额等原因）。
- 推送未知的原因为环信服务器端未知异常。 | +| 推送数据详情 | 各个通道（环信在线通道、谷歌、华为、小米、魅族、OPPO、VIVO、APNS、鸿蒙）的推送详情：推送成功数、推送失败数、推送未知数。 | +| 推送成功率 | 本次推送涉及的推送通道的成功率、失败率和未知率。 | +| 送达/点击详情 | 本次推送涉及的推送通道的成功数、送达数、送达率、点击数和点击率。 | diff --git a/docs/push/push_task_create.md b/docs/push/push_task_create.md new file mode 100644 index 000000000..5675b1588 --- /dev/null +++ b/docs/push/push_task_create.md @@ -0,0 +1,118 @@ +# 创建推送任务 + +环信支持用户创建通知消息和透传消息的推送任务： + +- 通知消息：指定通知标题和内容后，环信 SDK 会自动处理，在系统通知栏中以通知栏消息的形式展示，同时响铃或震动提醒用户。 +- 透传消息：即自定义消息，客户自行定义消息体格式。环信只传递透传消息，不做任何处理，客户端接收到透传消息后需自行处理，如通知栏展示、弹框等。 + +## 开通服务 + +创建推送任务前，你需在 [环信控制台](https://console.easemob.com/user/login) 开通即时推送服务： + +1. 登录 [环信控制台](https://console.easemob.com/user/login)。 +2. 选择页面上方的 **应用管理**。在弹出的应用列表页面，单击你的应用的 **操作** 栏中的 **管理**。 +3. 在左侧导航栏，选择 **功能配置** > **增值功能** > **即时推送**。 +4. 选择 **创建推送** 页签，点击 **立即开通**。 +5. 在弹出的确认框中选择 **确定**，开通即时推送服务。 + + 若仅需测试推送功能，请使用全功能应用 `Demo`，在对话框中点击 **测试DemoKey**。 + +![img](/images/console/push_task_create.png) + +## 通知消息 + +你可以设置推送内容、厂商特殊配置、推送目标以及具体的推送设置。 + +### 内容编辑 + +推送通知的内容配置如下图所示： + +![img](/images/console/push_content_edit.png) + +| 参数 | 描述 | +| :------------ | :------------------------- | +| 目标平台 | 支持 Android 和 iOS 平台。该参数默认选择这两个平台，无需配置。 | +| 通知栏标题 | 通知栏展示的通知标题。 | +| 子标题 | 通知栏展示的通知副标题。 | +| 通知内容 | 通知栏展示的通知内容。 | + +配置完成后，推送通知预览如下： + +![img](/images/console/push_preview.png) + +### 厂商特殊配置 + +你可以配置推送厂商的特殊设置，如下图所示： + +![img](/images/console/push_vendor_setting.png) + +| 厂商 | 配置 | +| :------------ | :------------------------- | +| 苹果 |
- **是否启用扩展**：启用或不启用。
- **铃声** | +| 谷歌 | **Channel ID**：FCM 通道 ID。 | +| 小米 | **Channel ID**：小米通道 ID。 | +| vivo | **消息分类**：分为系统消息场景和运营消息场景。 | +| Oppo |
- **Channel ID**：OPPO 通道 ID
- **Category**：OPPO 消息分类
- **NotifyLevel**：OPPO 通知级别：**1**：通知栏；**2**：通知栏+锁屏；**16**：通知栏+锁屏+横幅+震动+铃声 | +| 华为 | **消息分类**：社交通讯、服务提醒和咨询营销。 | +| 鸿蒙 | **消息分类**：社交通讯、服务提醒和咨询营销。 | + +### 推送目标 + +- 推送给单个或多个指定用户： + +![img](/images/console/push_target.png) + +- 推送给指定标签下的用户： + +![img](/images/console/push_tag.png) + +| 参数 | 描述 | +| :------------ | :------------------------- | +| 推送目标 | 接收推送通知的用户：
- **用户名**：指定的单个或多个用户。在 **用户名** 文本框中输入用户 ID，多个用户 ID 以英文逗号分开，最多可输入 1000 个用户。
- **全部用户**。
- **标签用户**：最多可选 3 个推送，支持交集运算。 | + +### 推送设置 + +1. 配置推送设置，如下图所示： + +![img](/images/console/push_setting.png) + +| 参数 | 描述 | +| :------------ | :------------------------- | +| 通知图标 | 支持环信通道，可选择默认图标和指定图标。 | +| 展开样式 | 支持普通样式、大文本样式、大图片样式（iOS 暂不支持）。 | +| 后续动作 |
- Android 支持启动应用、打开链接、打开特定页面。
- iOS 环信通道支持启动应用、打开链接。
- APNs 仅支持启动应用。 | +| 附加字段 | 可以添加 key-value 格式字段。 | +| 推送时间 | 选择立即推送或者定时推送（例如 1 个小时之后，一个月之内）。 | +| 定时时间 | 推送通知的具体时间。 | +| 离线消息保留时长 | 离线消息保留时长设置只适用厂商通道，环信通道离线消息保留时长默认 7 天。 | +| 通道策略 |选择合适的推送发送策略：
- （默认策略）环信通道优先，在线走环信，离线走厂商。
- 只通过第三方厂商推送（失败后直接丢弃）。
- 在线或者离线都通过环信通道推送。
- 厂商通道优先，失败时走环信通道。| +| 角标数字 | 该角标为环信通道角标设置：
- 厂商通道仅支持华为 EMUI4.1 以上。
- APNS 仅支持不变和设置数字。
- 选择不变时，表示不改变角标数字（小米设备由于系统控制，无论选择环信通道还是厂商通道下发，默认角标 +1 的效果）。 | +| 消息提示 | 设置提醒方式，包含提示音和震动。 | + +2. 配置完成后，点击 **发送预览** 预览推送配置。 + +![img](/images/console/push_setting_preview.png) + +3. 点击 **确认推送**，发送推送通知。推送完成后，你可以在 **推送任务** 页面查看推送结果。 + +![img](/images/console/push_notification_view.png) + +## 透传消息 + +透传消息受厂商限制，仅支持环信通道。 + +1. 设置透传消息的推送目标、推送时间、附加字段。 + +![img](/images/console/push_transparent_message.png) + +2. 配置完成后，点击 **发送预览** 预览推送配置。 + +![img](/images/console/push_preview_transparent.png) + +3. 点击 **确认推送**，发送推送通知。推送完成后，你可以在 **推送任务** 页面查看推送结果。 + +![img](/images/console/push_transparent_view.png) + + + + 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..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/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..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/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 +- 已在[环信控制台](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 @@ -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..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/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..f9bd98616 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#创建用户)。 ### 第二步 创建项目 @@ -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 { @@ -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..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 @@ -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..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/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_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_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/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/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_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 进行翻译。 - `