Batch Query Channel Live Status

Updated: 2022-11-11 23:57:21

Legacy API endpoint Query Batch Channel Status (Legacy)

API Description

1、批量查询频道直播状态（不支持研讨会）
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/live-status/list

Online API Call

Request Method

GET

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining credentials
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 used directly on the client side. All APIs must be called through your 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 200 channels.

Example

http://api.polyv.net/live/v4/channel/live-status/list?appId=frlr1zazn3&sign=79767F7E02132E1904C304E4F225CC2A&channelIds=2624138%2C2614940&timestamp=1634783281943

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging; should not be tied to business logic
error	Object	Error information when status code is not 200 See Error field description
data	Array	See data parameter description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
channelId	Long	Channel ID
liveStatus	String	Live status unStart: Not started live: Live end: Ended waiting: Waiting playback: Playback banpush: Banned from streaming

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. 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(getClass());
/**
 * 批量查询频道直播状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetAllLiveStatus() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/live-status/list";
    String channelIds = "2624138,2614940";
    
    //http 调用逻辑
    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.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",
    "requestId": "b38bdd97dc404213a2436e7a086b9db9.82.16347832877195279",
    "data": [
        {
            "channelId": 2614940,
            "liveStatus": "playback"
        },
        {
            "channelId": 2624138,
            "liveStatus": "unStart"
        }
    ],
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360832149273615",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}