修改频道播放器暂停广告

接口描述

1、管理系统修改频道播放器的暂停广告：频道管理-观看页设置-营销-广告
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channelAdvert/{channelId}/updateStop

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、请求参数传入enabled设置开关时，仅设置开关状态，其余设置参数无效

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
enabled	false	String	设置开关状态 Y：开启 N：关闭
stopAdvertImage	false	String	图片地址，不填代表删除
stopAdvertHref	false	String	点击图片跳转Url

示例

http://api.polyv.net/live/v2/channelAdvert/2191532/updateStop

表单参数：

stopAdvertHref=https%3A%2F%2Fbaidu.com&appId=frlr1zazn3&sign=E411A801BC903A0B7E863CE23A2EA27C&enabled=Y&stopAdvertImage=http%3A%2F%2Fliveimages.videocc.net%2Fuploadimage%2F20210318%2Fchat_img_1b448be323_16160330722736.jpeg&timestamp=1621844240434

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时返回true，失败时返回空字符串

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(PlayerTest.class);
/**
 * 修改频道播放器暂停广告
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateStop() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channelAdvert/%s/updateStop";
    String channelId = "2191532";
    String enabled = "Y";
    String stopAdvertImage = "http://liveimages.videocc.net/uploadimage/20210318/chat_img_1b448be323_16160330722736.jpeg";
    String stopAdvertHref = "https://baidu123.com";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("enabled", enabled);
    requestMap.put("stopAdvertImage", stopAdvertImage);
    requestMap.put("stopAdvertHref", stopAdvertHref);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道播放器暂停广告，返回值：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}