Modify Warm-Up Setting Switch

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

API Description

1、通过频道号，修改暖场开关
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/set-warmup-enabled

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls are subject to rate limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and retrieve response data.` See Signature Generation Rules
channelId	true	String	Channel ID
warmUpEnabled	true	String	Switch value Y: Enable N: Disable

Example

http://api.polyv.net/live/v3/channel/set-warmup-enabled

Form Parameters:

appId=frlr1zazn3&warmUpEnabled=Y&sign=39959D3A4001039B5B1F6BA1DC509D98&channelId=2202970&timestamp=1621842366226

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See Global Error Description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	String	Empty on failure, "success" on success

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelWarmUpTest.class);

/**
 * 修改暖场设置开关
 * @throws IOException
 */
@Test
public void testUpdateWarmUpSwitch() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v3/channel/set-warmup-enabled";
        String channelId = "2202970";
        String warmUpEnabled = "Y";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("warmUpEnabled",warmUpEnabled);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试修改暖场设置开关接口返回值：{}",response);

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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