Batch Query Channel Live Stream Push Information

Updated: 2026-02-27 09:38:24

Interface Description

1、批量获取频道直播的实时推流信息
2、deployAddress、inAddress、lfr信息可能无法获取，返回值为null
3、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/monitor/get-streams

Online API Call

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details
Obtaining channel live stream information requires the channel to be in a live streaming state.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 and must not be saved or used directly on the client. 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 currently live streaming. Multiple channels separated by commas, up to 100 channels.

Example

http://api.polyv.net/live/v3/channel/monitor/get-streams?appId=frlr1zazn3&sign=6DDD5D27EAE6C9EE1713F9E2AEB59D99&channelIds=4184547%2C4184544%2C4146015%2C4146008&timestamp=1692322685465

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 description.
data	Array	On successful request, a list of real-time channel stream push information. See data field description

data Field Description

Parameter	Type	Description
channelId	String	Channel ID
live	Boolean	Whether the channel is live streaming. true: Live streaming false: Not live streaming
streamInfo	Object	Channel stream push information. Only available when live streaming; null when not live. See streamInfo field description

streamInfo Field Description

Parameter	Type	Description
deployAddress	String	Pushed CDN node IP address
inAddress	String	Stream push egress IP address
streamName	String	Stream name
fps	String	Stream push frame rate
lfr	String	Stream push frame loss rate
inBandWidth	String	Stream push bitrate, unit: bps

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 project. The test cases HttpUtil.java and LiveSignUtil.java are included in the download file.

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

    /**
 * 批量查询频道直播流信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getStreamsInfoTest() 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/monitor/get-streams";
    String channelIds = "4184547,4184544,4146015,4146008";
    
    //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 system global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "channelId": "4146008",
            "live": false,
            "streamInfo": null
        },
        {
            "channelId": "4184547",
            "live": true,
            "streamInfo": {
                "deployAddress": "113.96.140.25",
                "inAddress": "106.55.200.246",
                "streamName": "1b448be32316919995568637549",
                "fps": "16",
                "lfr": "0.0",
                "inBandWidth": "64318"
            }
        },
        {
            "channelId": "4146015",
            "live": true,
            "streamInfo": {
                "deployAddress": null,
                "inAddress": "30.171.154.159",
                "streamName": "1b448be3231690474521694979d",
                "fps": "15",
                "lfr": null,
                "inBandWidth": "20756"
            }
        },
        {
            "channelId": "4184544",
            "live": true,
            "streamInfo": {
                "deployAddress": null,
                "inAddress": null,
                "streamName": "1b448be32316919995083869e11",
                "fps": "15.15",
                "lfr": null,
                "inBandWidth": "70058.266"
            }
        }
    ]
}

Error Example

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