Merge pull request #508 from haoxiuwen/doc-v2

Add Callback & Product Dynamics

docs/.vuepress/sidebar/index.ts

@@ -20,6 +20,7 @@ export const zhSidebar = sidebar({
       text: '产品简介',
       children: [
         { text: '产品概述', link: 'introduction.html' },
+        { text: '产品动态', link: 'product_dynamics.html' },
         { text: 'IM 产品使用限制', link: 'limitation.html' },
         { text: '接口频率限制', link: 'limitationapi.html' },
         { text: '产品价格', link: 'pricing.html' },

docs/product/enable_and_configure_IM.md

@@ -125,25 +125,76 @@
 
 ## 配置消息回调
 
-环信即时通讯 IM 提供消息回调服务。配置回调后，应用服务器会收到所选类型的消息和事件。
 
-购买环信即时通讯 IM 服务后，按照以下步骤添加消息回调证书：
+环信即时通讯 IM 提供消息回调服务。旗舰版 IM 服务包含回调服务，而专业版 IM 服务不包含回调服务，需要按以下步骤单独购买。
 
 1. 在环信即时通讯云控制台首页的**应用列表**中，在目标应用的 **操作** 栏中点击 **查看**。
 
 ![img](@static/images/product/app-view.png)
 
-2. 在左侧导航栏，选择 **即时通讯** > **功能配置** > **消息回调**，进入 **消息回调** 页面。
+2. 选择**即时通讯** > **功能配置** > **功能配置总览**，在**基础功能**页签的功能列表上，点击**回调**对应的 **增值服务**。
+
+![img](@static/images/callback/callback_activation.png)
+
+3. 在弹出页面的**可选增值服务**区域，选择**回调**对应的**付费开通**，确定购买时长，选择 **我已阅读并同意《环信云服务购买协议》**，然后点击**提交订单**。
+
+![img](@static/images/callback/callback_purchase.png)
+
+4. 在支付页面，点击**立即支付**支付费用后即可使用
+
+![img](@static/images/callback/callback_payment.png)
+
+你可以下步骤添加消息回调规则，最多可以配置 4 条发送前和发送后回调规则。配置回调后，应用服务器会收到所选类型的消息和事件。
+
+1. 在左侧导航栏，选择 **即时通讯** > **功能配置** > **消息回调**，进入 **消息回调** 页面。
 
 ![img](@static/images/product/push-callback.png)
 
-3. 点击 **添加回调地址** 按钮，打开回调配置对话框。
+2. 点击 **添加回调地址** 按钮，打开回调配置对话框。
 
 ![img](@static/images/product/push-callback-window.png)
 
-4. 在回调配置对话框中，填写回调相关配置信息，点击 **保存** 按钮，完成回调配置，具体配置内容说明见 [回调配置](/document/server-side/callback.html#实现步骤)。
+3. 在回调配置对话框中，填写回调相关配置信息，点击 **保存** 按钮，完成回调配置。
+
+- 配置发送前回调规则
+
+![img](@static/images/product/pre_delivery_rule_add.png)
+
+在**发送前回调**对话框中配置以下参数：
+
+| 参数           | 是否必填 | 描述       |
+| :----------------- | :------- | :--------------- |
+| 规则名称           | 是       | 填写文字，支持中英文，长度限制为 32 字符。每个规则的名称必须唯一 。     |
+| 会话类型           | 是       | 会话类型：<br/> • 单聊；<br/> • 群组；<br/> • 聊天室。   |
+| 消息类型           | 是       | 支持发送前回调的消息类型包括文本、图片、视频、位置、语音、文件和自定义消息（“TEXT”，“IMAGE”，“VIDEO”，“LOCATION”，“VOICE” 和 ”FILE”）。 |
+| 等待响应时间       | 是       | 后台判断超时时间，默认 200，单位为毫秒。如果回调超时无应答，消息默认会正常下发，支持修改消息处理逻辑。  |
+| 调用失败时默认策略 | 是       | 当您的服务器返回结果异常或等待时间内未返回结果时，消息放行或不放行。  |
+| 消息拦截报错时显示 | 是       | 当消息被拦截时，是否通知发送者 SDK 消息发送失败： <br/> • 报错：通知发送者 SDK 消息发送失败，发送者会感知到消息发送失败； <br/> • 不报错：不通知发送者 SDK 消息发送失败，发送者无感知。 |
+| 启用状态           | 是       | 回调规则是否马上生效：<br/> • 启用：马上生效； <br/> • 不启用：暂不生效。 (建议首次创建配置为“不启用”，等您的服务器配置好验证信息后再修改为“启用”)  |
+| 回调地址           | 是       | 回调 URL，环信 IM 对 HTTP 和 HTTPS 的回调地址均支持。 |
+
+- 配置发送后回调规则
+
+![img](@static/images/callback/post_delivery_rule_add.png)
+
+在**发送后回调**对话框中配置以下参数：
+
+| 参数<div style="width: 80px;"></div> | 是否必填 | 内容       |
+| :--------------------- | :------- | :--------------- |
+| 规则名称 | 是 | 唯一的规则名称，只支持字母、数字和下划线，不支持中文字符，且长度不超过 32 字符。 |
+| 回调地址 | 是 |环信 IM 服务器会将消息推送到指定的 URL 地址，支持针对不同类型的消息配置不同的 HTTP 和 HTTPS 回调地址。   |
+| 启用状态 | 是 |是否启用该规则。|
+| 回调类型 | 是 |回调类型。你可以选择对各种类型的单聊、群聊、和聊天室消息以及各种事件进行回调。|
+| 消息类型 | 是 |需要回调的类型：<br/> - **聊天消息**：发送成功的消息，包括通过客户端和 REST API 发送的消息。这些消息与通过 REST 导出的聊天记录查询到的消息一致。例如，用户 u1 向用户 u2 发送消息，则会产生一条聊天消息，与接收方是否在线无关。收到的消息中 `from` 为 u1，`to` 为 u2。用户 u1 在群组 g1 中发送消息，则会产生一条聊天消息，收到的消息中 `from` 为 u1，`to` 为 g1，且返回值包含 `group_id` 字段。<br/> - **离线消息**：消息发送时接收方为离线的消息。例如：单聊中发送消息，若对端用户不在线，则会产生一条离线消息；在群聊中发送消息，若有几个群成员不在线，则会产生几条离线消息，这些离线消息的 `to` 参数为接收消息用户的 ID，并不是群组 ID。App 可以通过推送服务对这些消息进行个性化推送。|
+| REST 消息是否需要回调 | 是 | 通过 REST API 发送的消息是否需要回调：<br/> - **是**：需要；<br/> - **否**：不需要。 |
+| From ID  | 否 |消息发送方或操作执行者的用户 ID。每行输入一个用户 ID，一次最多输入 50 条。设置该参数后，环信服务器只针对该用户发送的消息及执行的操作（例如好友、群组或聊天室相关操作）进行回调。若不指定该参数，规则对消息发送方不限制。 |
+| To ID | 否 | 消息接收方：<br/> - 单聊：接收方的用户 ID。环信服务器只针对该用户接收的消息或事件通知进行回调。<br/> - 群组聊天：群组 ID。环信服务器只针对该群组中接收的消息或事件通知进行回调。<br/> - 聊天室：聊天室 ID。环信服务器只针对该聊天室中接收的消息或事件进行回调。<br/>每行输入一个接收方 ID，一次最多输入 50 条。若不指定该参数，规则则对消息接收方不限制。|
+| 群组/聊天室 ID | 否 | 群组或聊天室 ID。每行输入一个群组 ID 或聊天室 ID，一次最多输入 50 条。设置该参数后，环信服务器只针对该群组中的消息或事件进行回调。若不指定该参数，规则则对群组和聊天室不限制。|
+| 扩展字段中的 Key | 否 | 消息扩展字段中的属性 key。每行输入一个 key，一次最多输入 50 条。设置该参数后，只针对包含该属性 Key 的消息进行回调。若不指定该参数，规则对消息扩展字段不限制。| 
+
+回调规则配置后，环信服务器会自动为该规则生成 secret。环信服务器向你的 app server 发送数据时会基于该 secret 生成签名（即请求中的 `security` 参数），作为你的服务器识别环信服务器的依据。若要使用自定义密钥，可以联系环信商务经理。
 
-![img](@static/images/product/push-callback-form.png)
+![img](@static/images/callback/post_delivery_addsuccess.png)
 
 ## 敏感词设置
 

docs/product/product_dynamics.md

@@ -0,0 +1,10 @@
+# 产品动态
+
+
+## 2023-11
+
+| 动态名称   | 动态描述 | 发布时间       | 相关文档          |
+| :----- | :------- | :---------------- | :---------------- |
+| SDK 4.2.0 开发版发布 | **新增特性**：<br/> - 客户端支持[好友备注功能](/document/android/releasenote.html)。<br/> - 客户端新增消息属性用于判断消息是否为聊天室全局广播消息。<br/> - 移动端新增 API 用于[从服务器获取当前用户已加入的群组数量](/document/android/group_manage.html#查询当前用户已加入的群组数量)。<br/> - 移动端的申请入群被拒绝的回调中添加申请者和拒绝者的用户 ID。<br/> - 移动端新增错误码 706，表示聊天室所有者不允许离开聊天室。若初始化时，将是否允许聊天室所有者离开聊天室的参数设置为否时，聊天室所有者在移动端调用离开聊天室的方法时会提示该错误。<br/> - 移动端在 `EMOptions` 类中新增属性用于在初始化时配置获取会话列表时是否返回空会话。<br/> **优化** <br/> - 客户端统一 Agora Token 和 EaseMob Token 登录方式，新增 EaseMob Token 即将过期及已过期的回调。<br/> - 移动端优化发消息时重试的逻辑。<br/> - 移动端优化数据库升级逻辑。| 2023-11-17  | <br/> - [Android 4.2.1 更新日志](/document/android/releasenote.html)<br/> - [iOS 4.2.1 更新日志](/document/ios/releasenote.html)<br/> - [Web 4.3.0 更新日志](/document/web/releasenote.html)。  |
+| REST API    | 支持[通过 REST API 向 app 下的所有活跃聊天室发送全局广播消息](/document/server-side/message_chatroom.html#发送聊天室全局广播消息) 。活跃聊天室指聊天室至少存在一个成员，而且至少发送过一条消息。| 2023-11-17  | 详见[发送聊天室广播消息](/document/server-side/message_chatroom.html#发送聊天室全局广播消息)。  |
+| IM Demo   | 好友详情页面可添加和修改好友备注。 | 2023-11-17       | <br/> - [Android 4.2.1 Demo](https://www.easemob.com/download/demo) <br/> - [iOS 4.2.0 Demo](https://www.easemob.com/download/demo)        |