Query Channel Live Start Time

Updated: 2022-11-16 16:20:54

API Description

1、接口用于获取倒计时设置的相关信息
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

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

Example

http://api.polyv.net/live/v2/channelSetting/1958888/get-countdown?appId=frlr1zazn3&sign=A39376D4B87D91E62273EA6D6A8741E3&timestamp=1621839974009

Response Parameter Description

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, auxiliary error description when code is 400 or 500
data	Object	Channel live countdown info on success See Data Parameter Description, empty on failure

Data Parameter Description

Parameter	Type	Description
bookingEnabled	String	Booking watch toggle, Y or N Y: Enabled N: Disabled
countEnabled	String	Countdown toggle, Y or N Y: Enabled N: Disabled
startTime	String	Live start time, format: yyyy-MM-dd HH:mm:ss
endTime	String	Live end time, format: yyyy-MM-dd HH:mm:ss. Returns null if not set

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 from the test cases are included in the download 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 testGetCountdown() 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/get-countdown", "1958888");

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);
    log.info("测试查询频道直播开始时间：{}",response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "bookingEnabled":"Y",
        "countTips":null,
        "countEnabled":"Y",
        "startTime":"2021-03-15 15:01:00",
        "endTime":"2021-03-15 18:00:00"
    }
}

Error Example

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