开通消息抄送

更新时间: 2023/08/28 11:28:34

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

前提条件

  • 已创建应用,并开通 NERoom 房间组件能力。

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

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

    curl -H 'User-Agent: Apache-HttpClient/4.5.9 (Java/1.8.0_151)' -H 'appkey: 0eb**********************' -H 'CurTime: 1608110108512' -H 'MD5: 99914b932bd37a5**********' -H 'CheckSum: ea9e0af4****************' -X POST -d '{}' -i ${YourServerAddress}
    

    CheckSum 等相关参数的说明请参见服务验签

  • 已在本地服务器实现消息抄送的处理逻辑,NERoom 的事件请参见 NERoom事件

操作步骤

  1. 网易云信控制台左侧导航栏选择产品功能 > 房间组件模板

  2. 抄送/回调配置文本框中输入消息抄送服务器的地址,单击确定

    neroom消息抄送地址.png

    配置抄送地址后,云信服务器通过发送 POST 请求的方式自动校验该地址。此请求 Header 为鉴权相关参数,body 为 JSON 格式,校验时请求 body 为空。如果在 5 秒内收到该地址返回 HTTP 200 状态码,则校验成功。

    • 消息抄送的服务器可以是您的业务服务器,也可以是第三方开发者服务器。
    • 如果控制台提示校验失败,请确认抄送地址和本地处理逻辑的正确性,可以使用 Postman 等工具辅助自测。
    • 如果您的抄送地址是 IM 和音视频通话/互动直播 2.0 共用,对于收到的云信服务器发送的请求,HTTP Header 中的 type 字段应判断为必传字段,否则可能会导致抄送地址校验失败。

服务验签

NERoom 在回调时,会在 http 请求头中添加签名逻辑,客户服务器可根据签名逻辑来校验请求合法性,签名字段及校验逻辑如下:

Header 参数 类型 说明
AppKey String 抄送事件所属的应用的 App Key
CurTime String 当前 UTC 时间戳,从1970 年 1 月 1 日 0 时 0 分 0 秒开始到现在的 毫秒数
CheckSum String sha1(AppSecret + MD5 + CurTime),其中AppSecret值为应用的AppSecret(请勿与AppKey混淆)
MD5 String 根据request body计算出来的值, 即MD5=md5(request body)

以java为例,验签逻辑:

javaString requestBody = "{}";
String AppSecret = "90u757h67n87"; //注意:此处是AppSecret,不是AppKey。
String MD5 = CheckSumBuilder.getMD5(requestBody);
String CurTime = "1440570500855";  ////当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
String CheckSum = CheckSumBuilder.getCheckSum(AppSecret, MD5, CurTime); //参考 接口概述 -> API checksum校验 部分

CheckSumBuilder代码如下:

java import java.security.MessageDigest;

public class CheckSumBuilder {
    // 计算并获取CheckSum
    public static String getCheckSum(String appSecret, String nonce, String curTime) {
        return encode("sha1", appSecret + nonce + curTime);
    }

    // 计算并获取md5值
    public static String getMD5(String requestBody) {
        return encode("md5", requestBody);
    }

    private static String encode(String algorithm, String value) {
        if (value == null) {
            return null;
        }
        try {
            MessageDigest messageDigest
                    = MessageDigest.getInstance(algorithm);
            messageDigest.update(value.getBytes());
            return getFormattedText(messageDigest.digest());
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
    private static String getFormattedText(byte[] bytes) {
        int len = bytes.length;
        StringBuilder buf = new StringBuilder(len * 2);
        for (int j = 0; j < len; j++) {
            buf.append(HEX_DIGITS[(bytes[j] >> 4) & 0x0f]);
            buf.append(HEX_DIGITS[bytes[j] & 0x0f]);
        }
        return buf.toString();
    }
    private static final char[] HEX_DIGITS = { '0', '1', '2', '3', '4', '5',
            '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
}

此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 操作步骤
  • 服务验签