API 参考
圈组

开通和配置消息抄送

更新时间: 2024/07/17 17:57:35

消息抄送服务可以将 IM 即时通讯业务下的消息或事件等数据,以 HTTP/HTTPS 请求的形式实时同步给您预设的服务器。使用消息抄送服务之前需要在网易云信控制台中开通消息抄送服务。

前提条件

  • 已开通 IM 即时通讯产品。

  • 已准备接收抄送消息的服务器地址。

    为保证服务器地址的正确性,建议配置前通过以下命令校验。

    curl -H 'Content-Type: application/json' -H 'charset: utf-8' -H 'AppKey: 0eb**********************' -H 'CurTime: 1608110108512' -H 'MD5: 99914b932bd37a5**********' -H 'CheckSum: ea9e0af4****************' -X POST -d '{}' -i ${YourServerAddress}
    
  • 已在本地服务器实现消息抄送的处理逻辑。

    消息抄送的流程及注意事项请参考消息抄送服务概述

背景信息

消息抄送是网易云信提供的消息同步服务,通过这一服务,可以将 IM 即时通讯业务下的消息或事件等数据,以 HTTP/HTTPS 请求的形式实时同步给您预设的服务器。可以是您的业务服务器,也可以是第三方开发者服务器。您可以通过消息抄送服务实现用户在线状态分析和特殊事件处理等业务。

操作步骤

  1. 登录网易云信控制台

  2. 在控制台首页应用管理中选择应用进入应用配置页面。

  3. 在顶部选择消息抄送页签,填写消息抄送地址。

    • 若所有类型消息都统一抄送给同一个地址,那么可以直接编辑消息抄送地址,单击确定,消息状态自动开启。

    • 若需要通过指定环境名称(env)进行自定义配置抄送地址,那么单击自定义抄送/第三方回调配置下的添加,填写对应的环境名称和抄送地址。

      对于部分抄送类型(如 API 发消息、SDK 发消息等),可以在发消息的参数里设置环境变量,服务器将根据环境抄送到不同的地址,环境和抄送地址的映射关系可在此处配置。

  4. 消息抄送类型中选择 IM 即时通讯需要接收的事件抄送类型,然后单击确认

    具体的抄送类型说明请参考消息抄送类型

注意事项

  • 配置抄送地址后,云信服务器通过发送 POST 请求的方式自动校验该地址。此请求 Header 为鉴权相关参数,body 为 JSON 格式,校验时请求 body 为空。如果在 5 秒内收到该地址返回 HTTP 200 状态码,则校验成功。
  • 如果控制台提示校验失败,请确认抄送地址和本地处理逻辑的正确性,可以使用 Postman 等工具辅助自测。
  • 抄送地址支持 httphttps,如果是 https 地址,开发者需要保证 https 证书的有效性,且配置时需携带http://https://前缀。抄送地址支持 IP 和域名。
  • 如果您的抄送地址是 IM 和音视频通话/互动直播 2.0 共用,对于收到的云信服务器发送的请求,HTTTP Header 中的 type 字段应判断为必传字段,否则可能会导致抄送地址校验失败。
  • 消息抄送的超时时间是 5 秒,如果在 5 秒内收到开发者服务器返回 HTTP 200 或 HTTP 500 状态码,则认为消息抄送成功,否则认为抄送失败。若有特殊需求不能丢弃消息抄送,请联系商务经理开通高保障抄送。开通后,如果抄送失败,网易云信服务器将会尝试重新抄送最多 1000 次。如果您接收消息抄送的接口在一段时间内持续无法响应,网易云信服务器支持将最多 50 万条消息缓存下来,待您的消息接收接口恢复后,联系云信技术支持申请重新抄送。
此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 背景信息
  • 操作步骤
  • 注意事项