Skip to content

Commit

Permalink
modify
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Nov 20, 2023
1 parent 93dac1a commit e0f6d47
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/document/server-side/callback.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,11 @@

以下是需要了解的发送后回调功能说明,包括在高并发可用性的基础上的使用限制说明,请按照此限制正确使用回调。

- 消息回调属于增值服务,需要开通相应版本后才能使用,具体见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 消息回调规则设置成功即可正常使用。最多支持 4 个回调规则(包含发送前回调和发送后回调),如果需要再增加回调规则,需要联系商务经理开通。
- 发送后回调范围,所有聊天消息有效(包含 REST 发送的消息),包含单聊/群聊;如果 app 开通了反垃圾/敏感词过滤,被识别的消息会在服务器被拦截并禁止发送,将不会回调。
- 消息回调属于增值服务,需要开通相应版本后才能使用,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 消息回调规则设置成功即可正常使用。最多支持 4 个回调规则(包含发送前回调和发送后回调),如果需要提升回调规则数量上限,需要联系商务经理开通。
- 发送后回调范围,所有聊天消息有效(包含通过 SDK 和 REST API 发送的消息),包含单聊/群聊;如果 app 开通了反垃圾/敏感词过滤,被识别的消息会在服务器被拦截并禁止发送,将不会回调。
- 发送后回调接收延时,是指消息服务器接收到客户端聊天消息、再将消息成功回调至客户指定服务器地址的时间间隔。消息接收延时保障是 99.95% 的消息在 30s 内。
- 发送后回调对同一个 app 可以针对不同类型的消息(chat 和 chat_offline)做配置,如果 app 同时需要 chat 和 chat_offline 两种消息,建议区分回调地址。当然,规则也可以把这两种消息同时回调至一个指定服务器地址,在接收到消息后,可以对 eventType 做判断,区分消息的类型。
- 发送后回调对同一个 app 可以针对不同类型的消息(聊天消息、离线消息和通过 REST API 发送的消息)进行配置,如果 app 同时需要聊天消息和离线消息两种消息,建议区分回调地址。当然,规则也可以把这两种消息同时回调至一个指定服务器地址,在接收到消息后,可以对 eventType 做判断,区分消息的类型。
- **发送后回调重试,当环信服务器执行发出回调后,响应状态码非 200,认为是指定服务器无网络、超过 10 秒或者其他因素导致失败,记录一次失败,然后立即重试,若再次失败,再记录一次失败;针对一条回调仅重试一次,重试失败后即丢弃。若开通了[补发回调存储信息功能](#补发回调存储信息接口描述),则将消息放入异常存储中。若 30 秒内累计 90 次失败,会封禁该 app 的回调规则,5 分钟后自动解封。重试失败以及封禁期间的回调不会自动补录,可以下载历史消息记录自行补充。**
- 指定服务器收到回调消息后,向消息服务器发出响应内容不能超过 1,000 字符长度,如果连续发送超长的响应内容,会导致回调规则封禁,只能手动解除,需要用户手动重新设置。
- 客户有特殊需求不能丢失回调消息的情况下,请联系环信商务经理开通回调异常缓存功能,并使用 [查询回调异常缓存](#查询回调储存详情接口描述)[补发回调储存信息](#补发回调存储信息接口描述) 接口。
Expand Down
23 changes: 18 additions & 5 deletions docs/product/enable_and_configure_IM.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,23 +125,36 @@

## 配置消息回调

环信即时通讯 IM 提供消息回调服务。配置回调后,应用服务器会收到所选类型的消息和事件。

购买环信即时通讯 IM 服务后,按照以下步骤添加消息回调规则。你可以配置 4 条发送前和发送后回调规则
环信即时通讯 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. 在回调配置对话框中,填写回调相关配置信息,点击 **保存** 按钮,完成回调配置。
3. 在回调配置对话框中,填写回调相关配置信息,点击 **保存** 按钮,完成回调配置。

- 配置发送前回调规则

Expand Down
Binary file added static/images/callback/callback_activation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/callback/callback_payment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/callback/callback_purchase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e0f6d47

Please sign in to comment.