查詢多個頻道回放設定

更新時間：2025-02-18 16:20:20

介面描述

1、查询多个频道回放设置
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v4/channel/playback/list?appId=frlr1zazn3&sign=DA99F02427F3DF709AE0BE4007501DC4&channelIds=3385357%2C1965681&timestamp=1663859723019

回應參數描述

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

Error參數描述

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

data參數描述

參數名	類型	說明
channelId	Integer	頻道號
playBackEnabled	String	觀看回放功能開關 Y：開啟 N：關閉
origin	String	回放來源 record：暫存 playback：回放列表 vod：點播列表
type	String	回放方式 single：單一影片回放 list：列表回放
videoList	Array	影片列表，回放方式為單一影片時只會回傳一個影片，列表回放時回傳前10個影片，回放開關關閉時也會回傳影片列表【詳見videoList欄位說明】
globalSettingEnabled	String	是否開啟全域設定 Y：開啟 N：關閉

videoList參數描述

參數名	類型	說明
videoId	String	直播系統產生的id （回放來源為回放列表或點播列表有值）
videoPoolId	String	點播影片videoPoolId （回放來源為回放列表或點播列表有值）
fileId	String	回放影片轉存前的暫存檔案ID（回放來源為暫存時有值）
duration	String	影片時長，格式為HH:mm:ss
name	String	影片名稱
watchUrl	String	回放影片的觀看地址。留意，當「回放來源」不等於「暫存」時，該欄位才有值

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询多个频道回放设置视频列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getChannelPlaybackListTest() 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/playback/list";
    String channelIds = "3385357,1965681";
    
    //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",
    "requestId": "4a3bcfe6010942ab801d53e76db05227.68.16638597246720685",
    "data": [
        {
            "channelId": 1965681,
            "playBackEnabled": "Y",
            "origin": "playback",
            "type": "single",
            "videoList": [
                {
                    "videoId": "1dcabe17a4",
                    "videoPoolId": "1b448be32347e1dfeb92fbf92849fda7",
                    "duration": "00:02:30",
                    "name": "Junit测试(勿删)",
                    "fileId": null
                }
            ],
            "globalSettingEnabled": "N"
        },
        {
            "channelId": 3385357,
            "playBackEnabled": "Y",
            "origin": "record",
            "type": "single",
            "videoList": [],
            "globalSettingEnabled": "Y"
        }
    ],
    "success": true
}

異常範例

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