设置播放器自定义url跑马灯
更新时间:2026-01-28 18:58:52
接口描述
1、通过接口可以设置播放器内容保护自定义url跑马灯开关,在开启时需提交url参数。
2、接口URL中的{channelId}为 频道ID
3、接口支持https协议
接口URL
http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-diyurl-marquee
请求方式
GET,POST
具体请参考自定义url跑马灯.
支持格式
JSON
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
| timestamp | 是 | string | 当前13位毫秒级时间戳,3分钟内有效 |
| marqueeRestrict | 是 | Y 或 N | 自定义url内容保护跑马灯开关 |
| url | 是 | string | 自定义url, 在开关为关时可为空,开启开关时为必填 |
| sign | 是 | string | 签名,32位大写MD5值 |
响应成功JSON示例:
{
"code": 200,
"status": "success",
"message": "",
"data": "设置成功"
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId not found.",
"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": "channel not found.",
"data": ""
}
跑马灯开关错误
{
"code": 400,
"status": "error",
"message": "marqueeRestrict is wrong",
"data": ""
}
跑马灯开关为开时,未提交自定义Url
{
"code": 400,
"status": "error",
"message": "url is required",
"data": ""
}
其他情况
{
"code": 400,
"status": "error",
"message": "设置失败",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 请求结果代码,成功为200 |
| status | 请求结果,成功时为"success"错误时为"error" |
| message | 错误信息,请求成功时为空,错误时错误信息 |
php请求示例
<?php
//引用config.php
include 'config.php';
//接口需要的参数(非sign)赋值
$channelId = "127075";
$marqueeRestrict = "Y";
$url = "http://demo.ipolyv.cn/wfy/marquee.php";
$params = array(
'appId'=>$appId,
'url'=>$url,
'marqueeRestrict'=>$marqueeRestrict,
'timestamp'=>$timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.polyv.net/live/v2/channelRestrict/$channelId/set-diyurl-marquee?appId=$appId×tamp=$timestamp&sign=$sign&url=$url&marqueeRestrict=$marqueeRestrict";
//输出接口请求结果
echo file_get_contents($url);
?>
