Skip to content

Commit

Permalink
Merge pull request #513 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify Console Callback Doc
  • Loading branch information
haoxiuwen authored Nov 21, 2023
2 parents 97b6098 + d9b8892 commit eb6cb5a
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions docs/product/enable_and_configure_IM.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@
## 配置消息回调


环信即时通讯 IM 提供消息回调服务。旗舰版 IM 服务包含回调服务,而专业版 IM 服务不包含回调服务,需要按以下步骤单独购买。
环信即时通讯 IM 提供消息回调服务。**旗舰版 IM 服务包含回调服务,而专业版 IM 服务不包含回调服务,需要按以下步骤单独购买**

### 开通消息回调

1. 在环信即时通讯云控制台首页的**应用列表**中,在目标应用的 **操作** 栏中点击 **查看**

Expand All @@ -144,17 +146,15 @@

![img](@static/images/callback/callback_payment.png)

你可以下步骤添加消息回调规则,最多可以配置 4 条发送前和发送后回调规则。配置回调后,应用服务器会收到所选类型的消息和事件。
### 配置回调规则

你可以按照以下步骤添加消息回调规则,最多可以配置 4 条发送前和发送后回调规则。配置回调规则后,环信服务器会自动为该规则生成 secret,向你的 app server 发送数据时会基于该 secret 生成签名(即请求中的 `security` 参数),作为你的服务器识别环信服务器的依据。若要使用自定义密钥,可以联系环信商务经理。

1. 在左侧导航栏,选择 **即时通讯** > **功能配置** > **消息回调**,进入 **消息回调** 页面。

![img](@static/images/product/push-callback.png)

2. 点击 **添加回调地址** 按钮,打开回调配置对话框。

![img](@static/images/product/push-callback-window.png)

3. 在回调配置对话框中,填写回调相关配置信息,点击 **保存** 按钮,完成回调配置。
2. 点击 **添加回调地址** 按钮,打开回调配置对话框,填写回调相关配置信息,点击 **保存** 按钮,完成回调配置。

- 配置发送前回调规则

Expand Down Expand Up @@ -188,13 +188,23 @@
| 消息类型 ||需要回调的类型:<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 条。设置该参数后,环信服务器只针对该群组中的消息或事件进行回调。若不指定该参数,规则则对群组和聊天室不限制|
| To ID || 单聊的消息或事件接收方的用户 ID。若不指定该参数,规则对消息接收方不限制|
| 群组/聊天室 ID || 群组或聊天室 ID。每行输入一个群组 ID 或聊天室 ID,一次最多输入 50 条。设置该参数后,环信服务器只针对该群组中的消息或事件进行回调。若不指定该参数,规则对群组和聊天室不限制|
| 扩展字段中的 Key || 消息扩展字段中的属性 key。每行输入一个 key,一次最多输入 50 条。设置该参数后,只针对包含该属性 Key 的消息进行回调。若不指定该参数,规则对消息扩展字段不限制。|

回调规则配置后,环信服务器会自动为该规则生成 secret。环信服务器向你的 app server 发送数据时会基于该 secret 生成签名(即请求中的 `security` 参数),作为你的服务器识别环信服务器的依据。若要使用自定义密钥,可以联系环信商务经理。
其中,**From ID****To ID****群组/聊天室 ID****扩展字段中的 Key** 为配置发送后回调规则时需指定的高级筛选条件,配置示例如下:

- 仅对单聊回调:仅设置 **From ID****To ID**。指定的发送方向接收方发单聊消息时收到回调消息。例如,**From ID** 设置为 test 1,**To ID** 设置为 test 2,test 1 向 test 2 发单聊消息时收到回调。

![img](@static/images/callback/post_delivery_addsuccess.png)
- 仅对群组或聊天室的聊天回调:仅设置**群组/聊天室 ID** 参数。这种情况下,只有在指定的群组或聊天室中发送消息时收到回调。例如,**群组/聊天室 ID** 设置为群组 ID 228918676226049,则仅在该群组中发送消息时收到回调。

- 仅对群聊中某个用户发送消息时回调:仅设置 **From ID****群组/聊天室 ID**。例如,**From ID** 设置为 test 1,**群组/聊天室 ID** 设置为 群组 ID 228918676226049,仅 test 1 用户在群组中发送消息时收到回调。

:::tip

**From ID****To ID****群组/聊天室 ID** 同时设置,发送方向接收方发送单聊、群聊消息时不会收到回调。

:::

## 敏感词设置

Expand Down

0 comments on commit eb6cb5a

Please sign in to comment.