用户工具

站点工具


vhall_open:webinar_change-callback_设置活动状态变更通知回调接口

设置活动状态变更通知回调接口


接口地址

URL http://e.vhall.com/api/vhallapi/v2/webinar/change-callback 

请求参数

参数名 类型 必选 说明
callback_url string 回调通知地址
private_key string 回调接口验证私钥
webinar_id int 活动ID 活动ID不传时设置的是用户全局回调地址

响应参数

返回形如

{
    "code":200,
    "msg":"success",
    "data":{
        "user_id":"1302",
        "webinar_id":0,
        "callback_url":"http://t.e.vhall.com/home/callback",
        "private_key":"abcdefg"
    }
}

的json,data值的数据格式如下

参数名类型必选说明
user_id int 微吼用户ID
webinar_id int 微吼活动ID 活动ID为0时设置的是用户全局回调地址
callback_url string 回调通知地址
private_key string 回调接口验证私钥

响应示例

{
    "code":200,
    "msg":"success",
    "data":{
        "user_id":"1302",
        "webinar_id":0,
        "callback_url":"http://t.e.vhall.com/home/callback",
        "private_key":"abcdefg"
    }
}

错误码

code含义
12005 活动状态变更回调接口地址不能为空
12006 活动状态变更回调接口地址无法访问或者访问超时,请检查后再设置
12007 活动状态变更回调接口地址设置失败,请稍后重试
12008 活动状态变更回调接口地址不能超过255个字符
12009 私钥不能为空
12010 私钥不能超过255个字符

回调接口前置条件:

  • 普通列表项目如果用微吼主账号开启的直播需要调用主账号绑定第三方账号接口给主账号绑定第三方账号,否则主账号开启的直播因为缺失第三方账号信息不会通知回调接口。
  • 主账号绑定第三方账号接口给主账号绑定第三方账号,否则主账号开启的直播因为缺失第三方账号信息不会通知回调接口。]]

回传第三方接口数据

{
    "channel": "vhall",//标识为微吼
    "method": "webinar_type_change",//标识为状态变更
    "webinarId": "858184439",//活动ID
    "type": "1",//暂时不用
    "event":"start"//event=start为开始直播,event=stop为结束直播
    "unionId": "testuser",//发起活动的第三方账号
    "timestamp": "1504060666",//回调当时的时间戳
    "signature": "6cbd9d3ffd1bcef4407558784fc1c80b"//签名
}

回调接口示例代码:

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);
    }
?>

vhall_open/webinar_change-callback_设置活动状态变更通知回调接口.txt · 最后更改: 2017/10/16 18:24 由 xiaomeng