录制回调

编辑文档更新于 2024-11-11 06:14:32

功能描述

BRTC 提供消息通知服务，你可以配置一个接收回调的 HTTP/HTTPS 服务器地址来接收云端录制的事件通知。当事件发生时，BRTC 云端录制服务会将事件消息发送给 BRTC 消息通知服务器，然后 BRTC 消息通知服务器会通过 HTTP/HTTPS 请求将事件投递给你的服务器

通过主动调用 call_back 方法可以查询录制任务和文件的状态
在百家云后台 -> BRTC -> 应用管理,在对应的应用下配置回调地址
录制任务状态会以 POST 方式向回调地址发起 HTTP/HTTPS 请求，请求包体为 JSON 格式
回调失败后，系统继续回调三次，都失败后，记录失败
失败恢复后，不保证发送顺序，报文上会记录事件发生时间戳

配置回调地址如下图所示：

配置.png

回调参数

参数	类型	描述
app_id	string	BRTC 给开发者分配的 appId，唯一标识一个应用
room_id	string	录制的房间 ID
task_id	string	云录制服务分配的任务 id。任务 id 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。未开始录制时 task_id 的有效期为 5 分钟
mode	int	录制类型 - `1`:单流录制; - `2`:混流录制
event_timestamp	string	事件发生时间戳
event_type	int	事件通知类型 - `31`: 录制完成并上传成功 - `41`：录制中，房间中用户全部离开
status	int	录制状态 - `1`: 录制任务未开始 - `2`: 录制任务进行中 - `3`: 录制任务已完成 - `4`: 录制任务异常结束
target_user	string	录制用户 ID (混流录制为空)
stream_type	int	流类型 - `0`:大流; - `1`:小流; 若对方未开启大小流，默认为大流
msg	string	事件描述
nonce	string	随机数
timestamp	string	回调发送时的 Unix 时间戳，用于检验串计算
signature	string	检验串，验证回调发送方身份
file_info	json	录制文件信息
comments	json	客户业务透传的数据

file_info成员如下

参数	类型	描述
date	string	录制日期
total_size	float	录制文件大小
duration	int	录制文件时长，单位是秒
name	string	录制文件名称
oss_path	string	录制文件在 oss 上的地址
created_at	string	录制文件开始上传到 oss 的时间

event_type 回调事件

参数	事件描述
31	录制成功并已上传至云存储

回调示例

{
    "msg": "succeed"
    "app_id": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "room_id": "33669",
    "event_type": 31,
    "targer_user": "string",
    "stream_type": 0,
    "nonce": "445266",
    "timestamp": "1611557246",
    "signature": "23485d0bd35c2dba6211bf3837a732640b4c64e4",
    "file_info": [
        {
            "date": "2021-07-28",
            "name": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO_33669_1_123456_2021-08-02 10:20:58_2021-08-02 10:20:58",
            "total_size":123,
            "oss_path":"http://xxx.com/20240417%2Fnas%2Frecord%2F9999%xxx-xxxx17024918.flv?Expires=1728874171&OSSAccessKeyId=xxx&Signature=xxxx",
            "created_at": "2021-08-02 10:20:58"
        }
    ],
    "comments":{
        "des": "this room is leve 2",
        "leve": 2
    }

}

来源校验

校验回调请求的发起来源是否为 BRTC 云端录制

校验方法

通过比较自行计算的 signature 与回调请求中的 signature 是否一致可以验证请求的发起方是否为 BRTC 云端录制。计算 signature 的流程如下图：

nonce：回调请求中的参数
timestamp：回调请求中的参数
secret：在百家云管理控制台可在控制台 > 应用中心 > 对应应用名称/应用ID > 配置 > 应用密钥如图所示：

app- secret.png

示例代码

[# PHP #]

$signature = $_POST["signature"];
$timestamp = $_POST["timestamp"];
$nonce = $_POST["nonce"];

$secret = callbacksecret;//后台获取的callbacksecret
$tmpArr = array($secret, $timestamp, $nonce);
sort($tmpArr, SORT_string);
$tmpStr = implode( $tmpArr );
$tmpStr = sha1( $tmpStr );

if( $tmpStr == $signature ){
    return true;
} else {
    return false;
}

[# Java #]

// 从请求参数中获取到 signature, timestamp, nonce
string signature = request.getParameter("signature");
long timestamp = request.getParameter("timestamp");
string nonce = request.getParameter("nonce");

// 后台获取的secret
string secret = secret;

string[] tempArr = {secret, ""+timestamp, nonce};
Arrays.sort(tempArr);

string tmpStr = "";
for (int i = 0; i < tempArr.length; i++) {
    tmpStr += tempArr[i];
}
tmpStr = org.apache.commons.codec.digest.DigestUtils.sha1Hex(tmpStr);

return tmpStr.equals(signature);

输出示例

$timestamp = 1470820198;
$nonce = 123412;
$secret = 'secret';

排序拼接后需要加密的原始串为: `1234121470820198secret`
加密的结果为: `5bd59fd62953a8059fb7eaba95720f66d19e4517`