回调ID | 回调事件 |
---|---|
1 | 活动开始,结束回调通知 |
2 | JSSDK 上传视频完成创建回放成功后通知 |
3 | JSSDK 上传视频完成转码后通知 |
4 | 回放生成成功后通知 |
回调接口示例代码:
<?php //PHP版本代码 $privateKey = 'abcdefg';//接口设置的private_key参数(回调接口验证私钥) data = $_POST; $sign = $data['signature']; unset($data['signature']); $sign_new = makeSignature($data , $privateKey);//调用签名生成函数 if($sign == $sign_new){ echo 'succ'; }else{ echo 'fail'; } //$privateKey为回调接口私钥 //$data为回传的POST数据数组,剔除掉signature键值 //签名生成函数 function makeSignature(array $data, $privateKey){ ksort($data); $str = null; $privateKey = md5($privateKey); foreach ($data as $k => $v){ $str .= $k.'|'.$privateKey.'|'.$v; } return md5($str); } ?>
User-Agent: vhall Content-Type: application/json Content-Length: content length
{ record_id: 56345, // 回放ID method_id: 3, // 回调事件ID status: "3", // 转码ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 sign: "58d85e40c577596c49e0217e2297728, // 签名 }
回调域名在收到消息后需要返回 字符串 success 任何非success的数据返回会未返回均被认为是失败的回调
Vhall服务器器会在时候后尝试从新放松,当失败3次后 失败消息会记录到失败列表中,可通过失败回调接口查询
设置回调事件
URL http://e.vhall.com/api/vhallapi/v2/callback/set-event
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
type | int | 否 | 1:添加 2:删除 默认为 1 |
secret_key | string | 否(第一次设置该参数为必选,非第一次为更新) | 数据传输私钥 |
callback_url | string | 否(第一次设置该参数为必选,非第一次为更新) | 回调URL |
callback_event | int | 是 | 需要回调的事件 |
返回形如
{ "code":200, "msg":"success", "data":{} }
的json,data值的数据格式如下
参数名 | 类型 | 必选 | 说明 |
---|
错误码
code | 含义 |
---|---|
12014 | 设置回调事件不能为空 |
12015 | 第一次设置回调事件,回调地址不能为空 |
12016 | 未注册过回调事件 |
12017 | 第一次设置回调事件,秘钥不能为空 |
查看当前回调信息
URL http://e.vhall.com/api/vhallapi/v2/callback/event-info
参数名 | 类型 | 必选 | 说明 |
---|
返回形如
{ "code": "200", "msg": "成功", "data": { "callback_url": "http://www.domain.com/api/callback", "callback_event": "2,3", "secret_key": "abcedfg" } }
的json,data值的数据格式如下
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
callback_url | string | 是 | 回调通知地址 |
private_key | string | 是 | 回调接口验证私钥 |
callback_event | string | 是 | 回调事件 以逗号分隔 |
错误码
code | 含义 |
---|---|
12018 | 当前回调事件为空 |
{ method_id: 1, // int 回调事件ID refer: "vhall", // string 来源 time: 1505095994, // int 当前时间戳 webinar_id: 123456, // int 活动ID third_user_id : "123456", // string 第三方用户ID (无第三方账户,返回空字符串) type : 1, // int 活动状态 1 开始 3 结束 signature: "7ffa066561d280d0d51f8fdaad29f4a4", // string 签名 }
{ method_id: 2, // 回调事件ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 record_id: 56345, // 回放ID signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名 }
{ method_id: 3, // int 回调事件ID refer: "vhall", // string 来源 time: 1505095994, // int 当前时间戳 record_id: 56345, // int 回放ID status: "3", // string 转码状态 1 成功 3 失败 signature: "58d85e40c577596c49e0217e2297728, // string 签名 }
{ method_id: 4, // int 回调事件ID refer: "vhall", // string 来源 time: 1505095994, // int 当前时间戳 record_id: 56345, // int 回放ID webinar_id: 673246345, // int 活动ID status: "3", // string 转码状态 1 成功 2 失败 signature: "58d85e40c577596c49e0217e2297728, // string 签名 }