文档转码相关接口

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

描述

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

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

请求参数

参数	类型	描述
nonce	int	随机数
timestamp	int	回调发送时的 Unix 时间戳，用于检验串计算
signature	string	检验串，验证回调发送方身份
task_id	int	文件转码任务 id
status	int	文件转码状态，详情请参考下文中 status 字段说明表

status 成员

Code	说明
10200	请求转码任务创建成功
10201	转码任务开始执行
10301	开始下载 source_file_url 原始文件
10302	原始文件从 source_file_url 下载失败
10401	原始文件从 source_file_url 下载保存失败
10402	原始文件 Hash 校验失败
10403	原始文件大小校验失败
10501	原始文件开始上传至oss服务器
10601	原始文件进入转码队列
10602	原始文件开始转码
20301	内部文件下载失败
20302	文件被加密
20303	ppt 文件含有隐藏页
20401	上传静态文件失败
20402	上传动态文件失败
20403	上传动态文件目录失败
20501	office 转换 pdf 文件失败
20502	pdf 文件转换 png 图片失败
20503	文档动态转码H5失败
20601	内部转码失败
20701	打包动态文档 tar 包失败
20702	打包动态文档 zip 包失败
30200	文件转码成功
30500	未知错误

检验说明

校验回调请求的发起来源是否为 BRTC 转码服务

校验方法

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

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

示例代码

[# 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;
}

输出示例

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

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