取得硬碟推流(偽直播)影片列表
更新時間:2023-12-27 15:43:51
介面說明
1、获取硬盘推流(伪直播)视频列表
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/disk-video/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 | String | 頻道號 |
| page | false | Integer | 目前頁碼,預設為1 |
| limit | false | Integer | 分頁大小,預設為10 |
範例
http://api.polyv.net/live/v3/channel/disk-video/list?appId=frlr1zazn3&sign=2E8DE3C2E5D62468917CF3A9B2DBC3D6&channelId=3889955×tamp=1681983834988
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 返回資料【詳見Data參數說明】 |
data參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料大小 |
| pageNumber | Integer | 目前頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 頻道詳細資訊列表【詳見Contents參數說明】 |
Content參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| videoId | String | 直播系統videoId |
| videoPoolId | String | 點播系統videoPoolId |
| userId | String | 直播系統userId |
| channelId | Integer | 頻道號 |
| title | String | 偽直播影片標題 |
| firstImage | String | 偽直播首圖,需拼接網域才能使用 |
| duration | String | 影片長度,如:00:17:36 |
| startTime | Long | 偽直播開始時間,13位時間戳 |
| endTime | Long | 偽直播結束時間,13位時間戳 |
| createdTime | Long | 該記錄儲存時間 |
| lastModified | Long | 該記錄最後修改時間 |
| url | String | 偽直播mp4位址 |
| streamStatus | String | 偽直播串流狀態:waiting-未直播,live-直播中,end-已結束 |
| langType | String | 語言:CN-中文,EN-英文(頻道開啟雙流直播可設定英文偽直播) |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
* 获取硬盘推流(伪直播)视频列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testListDiskVideo() 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/v3/channel/disk-video/list";
String channelId = "3889955";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
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": "gjzwgmer37",
"videoPoolId": "1b448be323e0bb0564cdd816ce4fac61",
"userId": "1b448be323",
"channelId": 3889955,
"title": "2-1 认识对象",
"firstImage": "1b448be323/1/1b448be323e0bb0564cdd816ce4fac61_0.jpg",
"duration": "00:17:36",
"status": "N",
"startTime": 1681373864000,
"endTime": 1681374920000,
"createdTime": 1681373802000,
"lastModified": 1681373865000,
"url": "http://mpv.videocc.net/1b448be323/1/1b448be323e0bb0564cdd816ce4fac61_1.mp4",
"localFileName": "/data/diskvideo/202304/gjzwgmer37.mp4",
"processId": 27944,
"streamStatus": "end",
"pushIp": "172.18.148.58",
"langType": "CN",
"source": "VideoPool"
}
],
"limit": 1,
"endRow": 1,
"nextPageNumber": 1,
"totalPages": 1,
"startRow": 1,
"firstPage": true,
"lastPage": true,
"prePageNumber": 1,
"offset": 0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
