查詢分發地址資訊

更新時間：2022-09-15 09:50:53

介面描述

1、查询分发地址信息
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/distribute/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
distributeIds	false	String	分發ID，以英文逗號分隔，不傳則預設查詢頻道下全部分發地址

範例

http://api.polyv.net/live/v4/channel/distribute/list?appId=frlr1zazn3&sign=39744576F6CECA12533CD8C73EF166D2&channelId=2272655&timestamp=1639730848124

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	成功回應時返回分發列表資訊【詳見data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應與業務掛鉤

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

data參數描述

參數名	類型	說明
distributeEnable	String	頻道分發直播總開關 Y：開啟 N：關閉
result	Array	分發地址回應物件列表【詳見result欄位說明】

result參數描述

參數名	類型	說明
id	Integer	雲端分發ID
channelId	Integer	頻道號
name	String	分發地址名稱
distributeUrl	String	推流地址
distributeLiveCode	String	直播碼
status	String	分發直播開關 Y：開啟 N：關閉
connectionStatus	String	連線狀態 completed：已結束 processing：轉推中 waiting：等待連線中 error：轉推失敗

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询分发地址及开关状态
 * @throws IOException
 */
@Test
public void list() 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/v4/channel/distribute/list";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询分发地址及开关状态，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "e2e23029f14a46098842dde4d8f097b4.1885.16397300550491283",
    "data": {
        "distributeEnable": "Y",
        "result": [
            {
                "id": 3146,
                "channelId": 2272655,
                "name": "xx测试推流",
                "distributeUrl": "rtmp://xxx.polyv.net/xxx/57867407750",
                "distributeLiveCode": "",
                "status": "N",
                "connectionStatus": "completed"
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "366c4df40d814803a6ee3b04ceec437e.680953.16397317894687813",
    "error": {
        "code": 30004,
        "desc": "找不到频道"
    },
    "success": false
}