根據自訂場次ID查詢頻道暫存檔案ID

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

介面描述

1、根据自定义场次ID查询频道暂存文件ID
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/session/list-file-id-by-external

請求方式

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	場次ID
externalSessionId	true	String	自訂直播場次UUID，該參數設定自【直播場次關聯自訂ID】

範例

http://api.polyv.net/live/v3/channel/session/list-file-id-by-external?appId=frlr1zazn3&sign=9847BBA541A0BF0CBF5380208CE259AD&externalSessionId=test&channelId=2272655&timestamp=1655780318088

回應參數說明

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

data欄位描述

參數名	類型	說明
originSessionId	String	原始直播場次ID
fileIds	Array	暫存檔案ID列表，按生成時間倒序
createdTime	Long	最新暫存檔案生成時間，13位毫秒級時間戳

Java請求範例

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 根据自定义场次ID查询频道暂存文件ID
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getFileIdByExternalTest() 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/session/list-file-id-by-external";
    String channelId = "2272655";
    String externalSessionId = "test";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("externalSessionId", externalSessionId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试根据自定义场次ID查询频道暂存文件ID成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "originSessionId": "g9uya0mbrq",
            "fileIds": [
                "7c3ad56bb6d4e8e6058d7754e10ee4e8",
                "abfb68494b9dd9b58c5e2b7d0a3ee8ce",
                "1fd2500682429db92c1c67dc99af2ef4"
            ],
            "createdTime": 1652775098000
        },
        {
            "originSessionId": "g9uy303rsu",
            "fileIds": [
                "0f5ccaa11c6edd7fcc1f145a6e21ec82"
            ],
            "createdTime": 1652774575000
        },
        {
            "originSessionId": "g9uy0i6b0y",
            "fileIds": [
                "30dc5aa5e7f9e87fc03d0614cb308c34"
            ],
            "createdTime": 1652774321000
        }
    ]
}

異常範例

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