分頁查詢素材庫頻道直播回放列表
更新時間:2025-04-18 16:55:48
介面描述
1、分页查询素材库频道直播回放列表
2、接口支持https协议
介面URL
https://api.polyv.net/live/v4/channel/record-file/m-list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | Integer | 頻道號 |
| pageNumber | false | Integer | 分頁頁碼,預設 1 |
| pageSize | false | Integer | 分頁大小,預設 10 |
範例
https://api.polyv.net/live/v4/channel/record-file/m-list?appId=frlr1zazn3&sign=DABFF35FB3D25CAF37BB73F8944C2F44×tamp=1621840820088
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Array | 請求失敗時為空,請求成功時為頻道錄製影片資訊 【詳見data欄位描述】 |
data欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| fileId | String | 錄製檔案ID |
| startTime | String | 開始錄製時間,格式為:yyyyMMddHHmmss |
| endTime | String | 結束錄製時間,格式為:yyyyMMddHHmmss |
| fileSize | Long | 錄製檔案大小(單位:位元組) |
| duration | Integer | 時長(單位:秒) |
| channelSessionId | String | 直播的場次ID |
| fileName | String | 錄製檔案名稱 |
| origin | String | 錄製檔案來源 manual:手動錄製 auto:自動錄製 merge:合併 clip:裁剪 smart-clip:智慧裁剪 material:素材庫影片 |
| originSessionId | String | 原始直播場次ID 當該錄製檔案為 手动录制或自动录制時就等於目前直播場次ID 當該錄製檔案為 合并或裁剪時為原始直播場次ID |
| recordFileType | String | 錄製檔案類型 complete:完整回放 part:自動錄製_片段 merge:手動合併 clip:裁剪 |
| watchUrl | String | 觀看頁地址 |
| mp4 | String | mp4影片地址 url,素材庫影片有防盜鏈過期時間為 1 天,過期後需要重新請求介面取得 |
| firstImage | String | 首圖 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
* 查询频道录制视频信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetChannelRecordInfo() 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/v4/channel/record-file/m-list";
String channelId = "2139283";
url = String.format(url, channelId);
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("userId", userId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试分页查询素材库频道直播回放列表,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":[
{
"channelId":2191532,
"fileId":"94ea693e1733389ae2e7693ebdacbd43",
"mp4":"https://m-tc.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-11-16-13-14_2021-03-11-16-15-07.mp4",
"startTime":"",
"endTime":"",
"fileSize":9200637,
"duration":114,
"channelSessionId":"fwmnnydr06",
"fileName":"Spring",
"origin": "material",
"originSessionId": "fwmnnydr06",
"firstImage": "https://videolib-tc.videocc.net/material/2025-02-10/146b754735/video/146b7547358326684597f3499fa44887/146b7547358326684597f3499fa44887_1.jpg",
"watchUrl": "//live.polyv.cn/watch/55708844?vid=a6b1459bb9fcd342893511b2226daae61db&playbackType=material"
}
]
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
