接口URL
https://api.polyv.net/live/v3/channel/switch/update
接口说明
1、接口用于修改功能开关设置，可修改全局开关设置或频道开关设置
2、接口支持https
支持格式
JSON
请求方式
POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 13位当前时间戳 |
| sign | 是 | string | 签名值 |
| channelId | 否 | int | 频道号，不传该参数为获取全局设置 |
| type | 是 | string | 开关类型 |
| enabled | 是 | string | 开关值，Y或N |
开关类型
| type | 描述 |
|---|---|
| isClosePreview | 是否关闭系统观看页，Y时表示关闭 |
| mobileWatch | 是否开启移动端系统观看页 |
| mobileAudio | 是否开启移动端音视频切换 |
| autoPlay | 是否开启播放器自动播放功能 |
| booking | 是否开启预约功能 |
| redPack | 是否开启红包功能 |
| shareBtnEnabled | 是否开启分享功能 |
| chat | 是否开启聊天室 |
| closeChaterList | 是否关闭在线列表，Y时表示关闭 |
| consultingMenu | 是否开启咨询提问 |
| closeDanmu | 是否关闭弹幕功能，Y时表示关闭 |
| praise | 是否开启点赞语功能 |
| welcome | 是否开启欢迎语功能 |
| viewerSendImgEnabled | 是否开启观众发送图片 |
注：isClosePreview当enabled值为Y时，表示的是关闭系统观看页;closeDanmu当enabled值为Y时，表示的是关闭弹幕;closeChaterList当enabled值为Y时，表示的是关闭在线列表
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": true
}
响应失败JSON示例：
未输入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": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
频道号格式错误
{
"code": 400,
"status": "error",
"message": "param is not digit: dsadasd",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码，成功为200，失败为400，签名错误为401，异常错误500 |
| status | 成功为success，失败为error |
| message | 错误时为错误提示消息 |
| data | 修改成功过时为true |
php请求示例
<?php
//引用config.php
include '/srv/http/config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => '206204',
'type' => 'viewerSendImgEnabled',
'enabled' => 'N'
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "http://api.polyv.net/live/v3/channel/switch/update?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
Loading...
