保利威文档中心

幫助中心

查詢頻道單個直播暫存資訊

更新時間：2023-02-22 18:17:04

介面描述

1、通过文件ID查询频道内录制视频文件信息
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/record/get

線上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 頻道號
fileId true String 檔案ID【可透過查詢頻道錄製影片資訊取得】

範例

https://api.polyv.net/live/v3/channel/record/get?appId=frlr1zazn3&sign=697FE70BFEDEED1FB424A30557C8459C&channelId=2191532&timestamp=1621840860506&fileId=94ea693e1733389ae2e7693ebdacbd43

回應參數描述

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

data欄位描述

參數名 類型 說明
fileId String 檔案ID
userId String POLYV使用者ID，和保利威官網一致，取得路徑：官網->登入->直播（開發設定）
channelId String 頻道號
startTime String 開始錄製時間，格式為：yyyyMMddHHmmss
endTime String 結束錄製時間，格式為：yyyyMMddHHmmss
fileName String 錄製檔案名稱
fileSize Long 錄製檔案大小（單位：位元組）
createdTime Long 建立時間，13位毫秒級時間戳
width Integer 影片寬度（像素）
height Integer 影片高度（像素）
duration Integer 時長（單位：秒）
bitrate Integer 錄製檔案碼率（單位：位元組）
mp4 String mp4檔案位址
m3u8 String m3u8檔案位址
channelSessionId String 直播的場次ID
liveType String 直播類型
alone：活動直播
ppt：三分屏
topclass：大班課
seminar：研討會
daysLeft Integer 錄製檔案剩餘天數，大於0：剩餘天數，0：過期，-1：永久
originSessionId String 來源場次Id

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询指定文件ID的录制文件信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetRecordFile() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/record/get";
    String channelId = "2191532";
    String fileId = "94ea693e1733389ae2e7693ebdacbd43";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("fileId", fileId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询指定文件ID的录制文件信息，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "fileId":"94ea693e1733389ae2e7693ebdacbd43",
        "userId":"1b448be323",
        "channelId":2191532,
        "startTime":"20210311161313",
        "endTime":"20210311161507",
        "filename":"Spring 知识精讲1111",
        "filesize":9200637,
        "createdTime":1615450629000,
        "width":1280,
        "height":720,
        "duration":114,
        "bitrate":0,
        "mp4":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-12-16-13-14_2021-03-12-16-15-07.mp4",
        "m3u8":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-12-16-13-14_2021-03-12-16-15-07.m3u8",
        "channelSessionId":"fwmnnydr06",
        "liveType":"ppt",
        "daysLeft":165
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服，在线咨询