第三方回调是云信一项基于客户需求开放的事件回调能力。简单来讲，就是由客户应用服务器干预事件处理的结果。例如在企业办公场景、接入第三方反垃圾服务场景下，需要在发送方发送消息后，不直接投递给接收方，而是先由云信服务器向应用服务器发出 POST 请求到应用服务器，根据应用服务器返回的回调结果，决定是否放行。

技术原理

开通第三方回调服务后，云信 IM 服务器会在客户端发送消息时，通过向您的应用服务器发送请求，将消息内容和用户信息发往应用服务器。您的应用服务器判断消息是否可以发送，并返回结果，云信 IM 服务器再选择是否投递消息。

开通和配置第三方回调

使用第三方回调前，需开通和配置该服务：

1. 在云信控制台首页应用管理中选择应用进入应用配置页面，然后单击 IM 即时通讯 专业版下的功能配置按钮进入 IM 功能配置页。

   

2. 顶部选择基础功能页签，在第三方回调中配置第三方回调地址（通常为您的应用服务器地址），示例：POST https://******.com ，单击保存完成配置。

   

3. （可选）如需多环境配置，请跳转至自定义抄送 / 第三方回调配置进行配置。

   1. 在自定义抄送/第三方回调配置中单击右侧的添加按钮。

      

   2. 填写需要映射的环境名称和第三方回调地址。

      

4. 单击子功能配置，配置接口调用失败时的默认策略、第三方回调超时时间及第三方服务的校验范围。

   

   • 接口调用失败时的默认策略：可设置第三方回调超时或其他原因失败后期望的处理策略，默认放行。

   • 第三方回调超时时间：可设置第三方回调的超时时间，默认 2S。如果请求失败或者超时，云信 IM 服务器会使用网易云信控制台上配置的默认回调结果（放行/不放行）继续处理业务逻辑。

   • 第三方服务的校验范围：勾选需要第三方服务的配置项。群组、超大群以及圈组模块下可单独选择。

     

   聊天室消息的回调不在此处开通，需要在聊天室模块中单独开通。在 IM 功能配置页顶部选择聊天室页签，开通聊天室消息回调功能。

第三方回调概述

请求格式

请求头说明

• MD5值计算示例：

  java
      String requestBody = "{}";
      String MD5 = CheckSumBuilder.getMD5(requestBody); //参考 接口概述 -> API checksum校验 部分
  
  

• CheckSum值计算示例：

  java
      String AppSecret = "90ud57s6****";
      String MD5 = "9894907e4ad9de467809127750******";
      String CurTime = "1440570500855";  ////当前UTC时间戳，从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
      String CheckSum = CheckSumBuilder.getCheckSum(AppSecret, MD5, CurTime); //参考 接口概述 -> API checksum校验 部分
  

请求的 HTTP Body 说明

消息体统一为 JSON 格式，示例：

java    {
        "body": "Hello",
        "eventType": 1,
        "fromAccount": "000266",
        "fromClientType": "WEB",
        "fromDeviceId": "617715aa8579db03f0cf054c199c****",
        "fromNick": "yj000266",
        "msgTimestamp": "1541560157286",
        "msgType": "TEXT",
        "msgidClient": "",
        "to": "005877",
        "fromClientIp":"115.211.**.**",
        "fromClientPort":"568**"
    }

//Json中的属性请参考具体的回调类型

响应格式说明

第三方回调响应的 Content-Type Header 需要设置为 application/json; charset=utf-8

响应消息体为 JSON 格式，示例：

java    {
        "errCode":0,
        "responseCode": 20000,
        "modifyResponse": {},
        "callbackExt": "aa"
    }

第三方回调事件类型

IM 登录

单聊

群聊

聊天室

圈组

好友关系

音视频通话 1.0