帮助中心

文档管理

目录

回调事件

回调ID 回调事件 备注
1 活动开始,结束回调通知
2 JSSDK 上传视频完成创建回放成功后通知
3 JSSDK 上传视频完成转码后通知

回调签名

回调接口示例代码:
callback.php
<?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

body 示例

{ record_id: 56345, // 回放ID method_id: 3, // 回调事件ID status: "3", // 转码ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 sign: "58d85e40c577596c49e0217e2297728, // 签名 }

callback/set-event 设置回调事件

设置回调事件 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 第一次设置回调事件,秘钥不能为空

callback/event-info 查看当前回调信息

查看当前回调信息 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, // 回调事件ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 webinar_id: 123456, // 活动ID third_user_id : 123456 // 第三方用户ID (无第三方账户,返回空字符串) type : 1 // 活动状态 1 开始 3 结束 signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名 }

JSSDK 上传视频完成创建回放通知

{ method_id: 2, // 回调事件ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 record_id: 56345, // 回放ID signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名 }

JSSDK 上传视频完成转码后通知

{ method_id: 3, // 回调事件ID refer: "vhall", // 来源 time: 1505095994, // 当前时间戳 record_id: 56345, // 回放ID status: "3", // 转码状态 1 成功 3 失败 signature: "58d85e40c577596c49e0217e2297728, // 签名 }