Modify Live Countdown Settings

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

API Description

1、接口用于修改频道的倒计时设置
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-countdown

<a href="/req.html?api=http://api.polyv.net/live/v2/channelSetting/{channelId}/set-countdown"" target="_blank">Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details
The booking feature only takes effect when the correct live start time is set.

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
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 not be stored 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 for response data.` See signature generation rules
bookingEnabled	false	String	Booking toggle, Y or N. Default does not change the current state. Y: Enable N: Disable
startTime	false	String	Live start time. If not provided, the live time and countdown will not be displayed. Format: yyyy-MM-dd HH:mm:ss

Example

http://api.polyv.net/live/v2/channelSetting/1958888/set-countdown

Form Parameters:

bookingEnabled=Y&appId=frlr1zazn3&sign=A4B3677AD1F0675FB792A50E3B20D7AB&startTime=2021-3-15+15%3A01%3A00&timestamp=1621840695352

Response Parameters Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides additional error details.
data	String	Empty on success, empty on failure.

Java Request Example

For quick integration of 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 pools.

private static final Logger log = LoggerFactory.getLogger(WebInfoTest.class);
/**
 * 修改直播倒计时设置
 * @throws IOException
 */
@Test
public void testSetCountdown() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/set-countdown", "1958888");
    String bookingEnabled = "Y";
    String startTime = "2021-3-15 15:01:00";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("bookingEnabled",bookingEnabled);
    requestMap.put("startTime",startTime);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试修改直播倒计时设置：{}",response);
    //do somethings

}

Response Example

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

Success Example

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

Error Example

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