接口URL
https://api.polyv.net/live/v3/channel/callback/update-setting
接口说明
(接口调用有频率限制，详细请查看)
1、接口用于修改频道回调设置接口
2、接口支持https
3、如频道需要跟随用户设置，可以调用设置频道默认项开关接口
请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | 是 | string | 签名，32位大写MD5值 |
| channelId | 是 | int | 频道ID |
| recordCallbackVideoType | 否 | string | 录制回调文件类型，可选值m3u8或mp4或m3u8,mp4 |
| recordCallbackUrl | 否 | string | 录制回调http(s)地址，需要url编码，如果要清空设置传入空串 |
| playbackCallbackUrl | 否 | string | 转存成功回调http(s)地址，需要url编码，如果要清空设置传入空串 |
| streamCallbackUrl | 否 | string | 流状态回调http(s)地址，需要url编码，如果要清空设置传入空串 |
| pptRecordCallbackUrl | 否 | string | 课件重制成功回调http(s)地址，需要url编码，如果要清空设置传入空串 |
| liveScanCallbackUrl | 否 | string | 直播内容鉴别回调http(s)地址，需要url编码，如果要清空设置传入空串 |
| playbackCacheCallbackUrl | 否 | string | 回放转存回调http(s)地址，需要url编码，如果要清空设置传入空串 |
响应成功JSON示例：
// 修改成功
{
"code": 200,
"status": "success",
"message": "",
"data": null
}
响应失败JSON示例：
// 签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
// 未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
// appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
// 时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
// 频道非法
{
"code": 400,
"status": "error",
"message": "illegal channel id: xxx",
"data": ""
}
// url非法
{
"code": 400,
"status": "error",
"message": "url invalid:tttt",
"data": ""
}
// recordCallbackVideoType非法
{
"code": 400,
"status": "error",
"message": "invalid record callback type",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码，成功为200，失败为400，签名错误为403，异常错误500 |
| status | 成功为success，失败为error |
| message | 错误时为错误提示消息 |
| data | 响应数据，这里暂无，为null |
php请求示例
<?php
//引用config.php
include 'config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => 195770,
'recordCallbackVideoType' => 'm3u8,mp4',
'recordCallbackUrl' => ''
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "http://api.polyv.net/live/v3/channel/callback/update-setting?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
Loading...