查詢頻道直播暫存列表
更新時間:2024-08-26 15:59:15
介面描述
1、管理系统频道录制视频信息入口:云直播-我的直播-频道设置-回放管理-视频库-直播暂存
2、接口URL中的{channelId}为频道号
3、接口支持https协议
介面URL
http://api.polyv.net/live/v2/channels/{channelId}/recordFiles
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、請求參數startDate與endDate需同時傳送,可查詢時間範圍內頻道錄製的影片資訊
3、當sessionIds和startDate、endDate同時傳送時,僅sessionIds有效
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| userId | true | String | POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| startDate | false | String | 開始日期,格式:yyyy-MM-dd |
| endDate | false | String | 結束日期,格式:yyyy-MM-dd |
| sessionIds | false | String | 直播場次ID,多個用英文逗號分隔 |
範例
http://api.polyv.net/live/v2/channels/2191541/recordFiles?appId=frlr1zazn3&sign=DABFF35FB3D25CAF37BB73F8944C2F44&userId=1b448be323×tamp=1621840820088
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Array | 請求失敗時為空,請求成功時為頻道錄製影片資訊【詳見data欄位描述】 |
data欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| fileId | String | 錄製檔案ID |
| url | String | 錄製檔案位址,優先回傳MP4,若沒有MP4會回傳M3U8 |
| startTime | String | 開始錄製時間,格式為:yyyyMMddHHmmss |
| endTime | String | 結束錄製時間,格式為:yyyyMMddHHmmss |
| fileSize | Long | 錄製檔案大小(單位:位元組) |
| duration | Integer | 時長(單位:秒) |
| bitrate | Integer | 錄製檔案碼率(單位:位元組) |
| resolution | String | 解析度,範例:1280x720 |
| channelSessionId | String | 直播的場次ID |
| fileName | String | 錄製檔案名稱 |
| daysLeft | Integer | 錄製檔案剩餘天數,大於0:剩餘天數,-1:永久,不會回傳過期的錄製檔案記錄 |
| origin | String | 錄製檔案來源 manual:手動錄製 auto:自動錄製 merge:合併 clip:裁剪 smart-clip:智慧裁剪 |
| originSessionId | String | 原始直播場次ID 當該錄製檔案為 手动录制或自动录制時就等於當前直播場次ID 當該錄製檔案為 合并或裁剪時為原始直播場次ID |
| recordFileType | String | 錄製檔案類型 complete:完整回放 part:自動錄製_片段 merge:手動合併 clip:裁剪 |
| subtitleList | Array | 回放字幕列表【詳見subtitleList參數描述】 |
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 testGetChannelRecordInfo() 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/channels/%s/recordFiles";
String channelId = "2139283";
String startDate = "2020-01-01";
String endDate = "2021-04-01";
String sessionIds = "fwmnnydr06";
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",
"url":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-11-16-13-14_2021-03-11-16-15-07.mp4",
"startTime":"20210311161313",
"endTime":"20210311161507",
"fileSize":9200637,
"duration":114,
"bitrate":0,
"resolution":"1280x720",
"channelSessionId":"fwmnnydr06",
"fileName":"Spring 知识精讲1111",
"daysLeft": 165,
"origin": "auto",
"originSessionId": "fwmnnydr06"
}
]
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
