批量查詢頻道直播推流資訊

更新時間：2026-02-27 09:38:24

介面描述

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

2、取得頻道直播流資訊需要頻道為直播中狀態

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelIds	true	String	直播中的頻道號，多個頻道用英文逗號分隔，最多100個

範例

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

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Array	請求成功時為頻道即時推流資訊列表【詳見data欄位描述】

data欄位描述

參數名	類型	說明
channelId	String	頻道號
live	Boolean	頻道是否直播中 true：直播中 false：未直播
streamInfo	Object	頻道推流資訊，直播中才有值，未直播時為null【詳見streamInfo欄位描述】

streamInfo欄位描述

參數名	類型	說明
deployAddress	String	推送的CDN節點IP位址
inAddress	String	推流出口IP位址
streamName	String	流名稱
fps	String	推流幀率
lfr	String	推流丟幀率
inBandWidth	String	推流碼率，單位：bps

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

    /**
 * 批量查询频道直播流信息
 * @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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "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"
            }
        }
    ]
}

異常範例

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