Query Batch Channel Status (Legacy)

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

The new API endpoint is Batch Query Channel Live Status. It is strongly recommended to use the new API.

API Description

1、批量查询频道直播状态
2、接口支持https协议

API URL

http://api.polyv.net/live/v2/channels/live-status

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details
When querying the status of a relay channel that is currently live, this API returns "end". It is recommended to use the new API.

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 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]
channelIds	true	String	Channel IDs separated by commas, e.g., 10000,100001. Maximum 20.

Example

http://api.polyv.net/live/v2/channels/live-status

Form Parameters:

appId=frlr1zazn3&sign=19DAF4C4375B0352B0B9A37148C6E830&channelIds=2149813%2C2149710&timestamp=1621840930470

Response Parameter 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, provides auxiliary error reason.
data	Array	Empty on failure. On success, contains channel live stream status information. [See data field description]

data Field Description

Parameter	Type	Description
channelId	String	Channel ID
status	String	Live status of the channel live: Currently live end: Not live
seminarStatus	String	Seminar status for seminar channels seminar_live: Seminar in progress seminar_end: No seminar

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the 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(ChannelStateTest.class);
/**
 * 批量查询频道直播流状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetLiveStatusList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channels/live-status";
    String channelIds = "2149813,2149710";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelIds", channelIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量查询频道直播状态，返回值：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "channelId":2149710,
            "status":"end",
            "seminarStatus":"seminar_end"
        },
        {
            "channelId":2149813,
            "status":"live",
            "seminarStatus":"seminar_live"
        }
    ]
}

Error Example

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

Live Streaming Server API