批量查詢頻道單個回放資訊

更新時間：2022-09-02 18:08:07

介面描述

1、根据多个频道号查询每个频道设置的回放视频信息（仅支持非直播暂存的单个视频的回放查询）
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/play-back/get

請求方式

GET

介面限制

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

2、僅支援非直播暫存的單個影片的回放查詢，否則回傳資料為null

請求參數描述

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

範例

http://api.polyv.net/live/v4/channel/play-back/get?appId=frlr1zazn3&sign=5CE29DB9BDF1C24F85B096C38B9156B8&channelIds=1965681%2C2722361&timestamp=1639717803069

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛鉤
data	Object	頻道回應物件【詳見data參數描述】
error	Object	錯誤資訊【詳見error參數描述】

Error參數描述

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

data參數描述

參數名	類型	說明
channelId	Integer	頻道ID
vid	String	點播系統VID（常用該欄位）
videoId	String	直播系統產生的id （不常用，影片庫中的回放影片）
videoPoolId	String	點播影片videoPoolId （不常用）
videoName	String	影片名稱
firstImg	String	影片首圖
duration	String	影片時間，如：05:15:01

Java請求範例

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

    /**
     * 批量查询频道单个回放信息
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void testPlaybackVideoInfoList() 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/play-back/get";
        String categoryIds="340019,345134";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        
        requestMap.put("channelIds", "1965681,2722361");
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试批量查询频道单个回放信息，返回值：{}", response);
        //do somethings
        
    }

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f4b2f18c-f8f6-41f0-b0c8-9eef00af4fba",
    "data": [
        {
            "channelId": 2722361,
            "videoId": null,
            "videoPoolId": null,
            "videoName": null,
            "firstImg": null,
            "duration": null,
            "vid": null
        },
        {
            "channelId": 1965681,
            "videoId": "8073e37567",
            "videoPoolId": "1b448be323a9076c9941604ac1c667f9",
            "videoName": "Junit测试(勿删)",
            "firstImg": "//doc.polyv.net/images/default/blackboard.png",
            "duration": "05:15:01",
            "vid": "1b448be323a9076c9941604ac1c667f9_1"
        }
    ],
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}