消息通知服务

消息通知服务可以将 anyRTC 各业务下的事件，以 HTTP/HTTPS 请求的形式通知到你的服务器。消息通知服务已集成实时通信、服务端推流到 CDN 和云端录制业务下的一些事件。你可以向 anyRTC 提供相关的配置信息来开通该服务。

术语说明如下：

术语	说明
业务	业务类型分为：1:实时通信；2:服务端推流到CDN；3:云端录制。你可以根据自己场景需要开通相应的业务。
事件	事件类型为业务类型驱使的，来区分回调事件类型。

用户配置

你需要联系技术支持或者客服开通消息通知服务，并提供以下配置信息:

接收消息通知的 HTTP/HTTPS 服务器地址。
开通消息通知服务的项目所对应的 App ID。
开通通知服务的业务。
根据开通的业务获得通知的事件。
消息通知服务是实时通知，消息通知服务器就会在第一次通知失败后10s后重试，再次发送消息通知，最多会尝试三次通知。

配置消息通知服务后，你需要注意以下事项：

5 分钟后，该服务即会生效。你的服务器需要尽快响应消息通知服务器，响应的 body 格式必须为 JSON。
我们系统将自动生成 secret。secret 是字符串类型的密钥，密钥可以用来生成签名，你需要保存这个密钥以备后续验签，详见验证签名。

消息通知回调格式

消息通知回调以 HTTP/HTTPS POST 请求发送给你的服务器，请求的 body 格式为 JSON。字符编码为 UTF-8。

消息通知回调的 header 中包含以下字段：

字段名	值
Content-Type	application/json
Ar-Signature	签名值，联系技术支持或者客服获取

消息通知回调的 body 中包含以下字段：

字段名	类型	含义
noticeId	String	通知 ID，标识来自业务服务器的一次事件通知。
productId	Number	业务 ID: 1：Real-Time Communication（实时通信） 2：Push Stream to CDN 3.0（推流到 CDN） 3：Cloud Recording and Extension Service（云端录制及扩展服务）
eventType	Number	通知的事件类型：如果你使用实时通信业务，请参考实时通信事件类型如果你使用推流到 CDN 业务，请参考服务端推流到 CDN 事件类型。如果你使用云端录制及扩展服务，请参考云端录制事件类型。
notifyMs	Number	消息通知服务器向你的服务发出回调请求的 Unix 时间戳，单位为毫秒。Note：通知重试时会更新该时间。
payload	JSON Object	事件内容：如果你使用实时通信业务，请参考实时通信 payload 字段。如果你使用推流到 CDN 业务，请参考服务端推流到 CDN payload 字段。如果你使用云端录制及扩展服务，请参考云端录制payload字段。

验证签名

我们系统直接生成了密钥（secret），并通过 HMAC/SHA1 算法最终生成 Ar-Signature 签名。你可以使用已经保存了的这个密钥（secret）来验证 Ar-Signature 签名，验证签名时你可以参考以下代码：

python

#!/usr/bin/env python3
# !-*- coding: utf-8 -*-
import hashlib
import hmac
# 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 request_body 是反序列化之前的 binary byte array，不是反序列化之后的 dictionary
request_body = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
secret = 'secret'
signature = hmac.new(secret, request_body, hashlib.sha1).hexdigest()
print(signature) # 033c62f40f687675f17f0f41f91a40c71c0f134c

Node.js

const crypto = require('crypto')
// 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 requestBody 是反序列化之前的 binary byte array，不是反序列化之后的 object
const requestBody = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
const secret = 'secret'
const signature = crypto.createHmac('sha1', secret).update(requestBody, 'utf8').digest('hex')
console.log(signature) // 033c62f40f687675f17f0f41f91a40c71c0f134c

java

import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;

public class HmacSha {
    // 将加密后的字节数组转换成字符串
    public static String bytesToHex(byte[] bytes) {
        StringBuffer sb = new StringBuffer();

        for (int i = 0; i < bytes.length; i++) {
            String hex = Integer.toHexString(bytes[i] & 0xFF);

            if (hex.length() < 2) {
                sb.append(0);
            }

            sb.append(hex);
        }

        return sb.toString();
    }

    //HMAC/SHA1 加密，返回加密后的字符串
    public static String hmacSha1(String message, String secret) {
        try {
            SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(
                        "utf-8"), "HmacSHA1");
            Mac mac = Mac.getInstance("HmacSHA1");
            mac.init(signingKey);

            byte[] rawHmac = mac.doFinal(message.getBytes("utf-8"));

            return bytesToHex(rawHmac);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) {
        //拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 request_body 是反序列化之前的 binary byte array，不是反序列化之后的 object
        String request_body = "{\"eventMs\":1560408533119,\"eventType\":10,\"noticeId\":\"4eb720f0-8da7-11e9-a43e-53f411c2761f\",\"notifyMs\":1560408533119,\"payload\":{\"a\":\"1\",\"b\":2},\"productId\":1}";
        String secret = "secret";
        System.out.println(hmacSha1(request_body, secret)); //033c62f40f687675f17f0f41f91a40c71c0f134c
    }
}

注意事项

你的服务器收到的通知顺序和事件发生的顺序不一定完全一致。

你的服务器需要能处理重复消息，为确保消息通知的可靠性，每次事件可能会有不止一次消息通知。

请确保你的服务器有足够的处理能力，如实时通信业务中的 105 或 106 事件。