Modify Channel Player Pause Ad

Updated: 2022-09-02 18:08:07

Interface Description

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

Interface URL

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

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details
When the request parameter enabled is passed to set the switch state, only the switch state is set, and all other parameters are invalid.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details for signature generation rules
enabled	false	String	Set switch state Y: Enable N: Disable
stopAdvertImage	false	String	Image URL, leave empty to delete
stopAdvertHref	false	String	Click image redirect URL

Example

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

Form parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details for global error description
status	String	Response status text
message	String	Response description message, assists in describing error reasons when code is 400 or 500
data	String	Returns true on successful request, returns empty string on failure

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

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

Error Example

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