查詢影片庫列表
更新時間:2026-04-10 14:35:28
介面描述
1、管理系统视频列表信息入口:云直播-我的直播-频道设置-回放管理-视频库-回放列表/点播列表
2、接口URL中的{channelId}为频道号
3、接口支持https协议
4、素材库类型的频道仅查询回放列表视频
介面URL
http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| page | false | String | 頁數 |
| pageSize | false | String | 每頁顯示的資料筆數 |
| listType | false | String | 影片列表類型,一般直播場景預設為vod,三分屏預設為playback playback:回放列表 vod:點播列表 頻道為素材庫類型下該參數無效,僅查詢回放列表 |
| sessionIds | false | String | 場次ID,多個用英文逗號分隔(僅查詢轉存檔案來源為頻道錄製的影片) |
| title | false | String | 回放影片標題,支援模糊查詢 |
範例
http://api.polyv.net/live/v2/channel/recordFile/2191541/playback/list?appId=frlr1zazn3&sign=A4A5F279EC0D80E545B901982430CFE6&pageSize=10&page=1&listType=playback×tamp=1621841458928
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 請求失敗時為空,請求成功時為回放影片的影片列表資訊 【詳見data欄位描述】 |
data欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料筆數 |
| pageNumber | Integer | 目前頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表【詳見Contents參數描述】 |
| startRow | Integer | 目前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false |
| prePageNumber | Integer | 上一頁編號 |
| nextPageNumber | Integer | 下一頁編號 |
| limit | Integer | 每頁數量大小 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 目前頁最後一筆記錄在總結果集中的位置 |
| offset | Integer | 分頁起始記錄 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| videoId | String | 直播系統產生的id |
| videoPoolId | String | 點播影片vid / 素材id |
| userId | String | POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| channelId | String | 回放影片對應的直播頻道號 |
| title | String | 影片標題 |
| firstImage | String | 影片首圖 |
| duration | String | 影片長度,格式為HH:mm:ss |
| myBr | String | 預設影片的播放清晰度 1:流暢 2:高清 3:超清 |
| qid | String | 訪客資訊收集id |
| seed | Integer | 影片加密狀態 1:加密 0:非加密 |
| ordertime | Integer | 關聯點播影片的排序欄位 |
| createdTime | Long | 新增為回放影片的日期,13位毫秒級時間戳 |
| lastModified | Long | 影片最後修改日期,13位毫秒級時間戳 |
| rank | Integer | 排序值,值越大優先級越高 |
| asDefault | String | 是否為預設播放影片 Y:播放 N:不播放 |
| url | String | 影片播放位址,註:如果影片為加密影片,則此位址無法存取 |
| channelSessionId | String | 用於PPT請求資料,與PPT直播的回放相關,一般直播回放值為null |
| status | String | 關聯點播影片的狀態 |
| fileUrl | String | 影片位址 |
| fileId | String | 回放影片轉存前的暫存fileId |
| startTime | String | 直播開始時間,格式為:yyyyMMddHHmmss |
| liveType | String | 直播類型 alone:活動直播 ppt:三分屏 topclass:大班課 seminar:研討會 |
| width | Integer | 影片寬度 |
| height | Integer | 影片高度 |
| origin | String | 轉存檔案來源 manual:手動錄製 auto:自動錄製 merge:合併 clip:裁剪 smart-clip:智慧裁剪 |
| callbackUrl | String | 轉存影片時設定的回呼位址 |
| errorCount | Integer | 處理失敗的次數 |
| lang | String | 語言類型,預設為中文 zh_CN:中文 EN:英文 |
| videoIdEN | String | 英文回放videoId |
| enFileUrl | String | 英文回放檔案位址 |
| mergeInfo | String | 影片合併資訊 |
| watchUrl | String | 觀看回放影片的位址 |
| originSessionId | String | 來源場次Id |
| subtitleList | Array | 回放字幕列表【詳見subtitleList參數描述】 |
| mp4 | String | mp4影片位址 (如果為素材庫影片,則有防盜鏈過期時間為 1 天,過期後需重新請求介面取得) |
subtitleList參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Long | 字幕ID |
| name | String | 字幕檔案名稱 |
| srtUrl | String | 字幕檔案URL |
| language | String | 字幕語言 |
| status | String | 字幕狀態,publish--顯示,finish-不顯示 |
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 testGetPlayback() 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/v2/channel/recordFile/%s/playback/list";
String channelId = "1965681";
String page = "1";
String pageSize = "10";
String listType = "playback";
url = String.format(url, channelId);
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("listType", listType);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询视频库列表,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":{
"pageSize":10,
"pageNumber":1,
"totalItems":1,
"contents":[
{
"videoId":"1b96d90bf5",
"videoPoolId":"1b448be323e68e4404332113a57353b2_1",
"userId":"1b448be323",
"channelId":2191532,
"title":"Spring 知识精讲1111",
"firstImage":"//doc.polyv.net/images/default/blackboard.png",
"duration":"00:01:53",
"myBr":"1",
"qid":null,
"seed":0,
"ordertime":0,
"createdTime":1615515464000,
"lastModified":1615515464000,
"rank":1,
"asDefault":"N",
"url":"https://hls.videocc.net/source/1b448be323/2/1b448be323e68e4404332113a57353b2_1.m3u8",
"channelSessionId":"fwmnnydr06",
"status":"Y",
"fileUrl":"https://oss-live-2.videocc.net/record/record/recordf/1b448be323161536226913173df/1b448be323e68e4404332113a57353b2/2021-03-11-16-13-14_2021-03-11-16-15-07.m3u8",
"fileId":"94ea693e1733389ae2e7693ebdacbd43",
"startTime":"20210311161313",
"liveType":"ppt",
"width":null,
"height":null,
"origin":null,
"callbackUrl":null,
"errorCount":null,
"lang":"zh_CN",
"videoIdEN":null,
"enFileUrl":null,
"mergeinfo":"["20210311161313,113,fwmnnydr06"]",
"watchUrl":"//live.polyv.cn/watch/2191532?vid=1b96d90bf5"
}
],
"startRow":1,
"firstPage":true,
"lastPage":true,
"prePageNumber":1,
"limit":1,
"totalPages":1,
"endRow":1,
"nextPageNumber":1,
"offset":0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
