查詢重製課件任務列表
更新時間:2023-06-09 09:08:29
介面描述
1、查询课件重制任务列表
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/pptRecord/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 | 頻道號 |
| sessionId | false | String | 重製課件模組中的場次id |
| status | false | String | 狀態值 waiting:等待處理 process:處理中 success:重製成功 fail:重製失敗 uploaded:上傳點播成功 uploadFailed:上傳點播失敗 vodOweUploadFailed:點播欠費 vodSpaceOverUploadFailed:點播空間不足 |
| startTime | false | String | 直播開始時間開始區間,格式為yyyyMMddHHmmss |
| endTime | false | String | 直播開始時間結束區間,格式為yyyyMMddHHmmss |
| page | false | Integer | 分頁頁碼 |
| pageSize | false | Integer | 每頁資料大小 |
範例
http://api.polyv.net/live/v3/channel/pptRecord/list?appId=frlr1zazn3&sign=4D564199C480715472D1929201121282&pageSize=2&startTime=20200111000000&sessionId=fsb50pwxec&endTime=20201111000000&page=1&channelId=1965681×tamp=1621842179615&status=success
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 回應成功時返回重製課件結果集【詳見data欄位說明】 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 目前頁數 |
| totalPages | Integer | 總頁數 |
| pageSize | Integer | 每頁資料大小 |
| contents | Array | 任務列表【詳見Contents參數描述】 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| taskId | Integer | 任務id |
| channelId | String | 頻道號 |
| title | String | 對應回放的名稱 |
| url | String | 重製mp4下載地址,有24小時的防盜鏈逾時時間 |
| sessionId | String | 重製課件模組中的場次id |
| startTime | String | 對應回放的直播開始時間,格式為yyyyMMddhhmmss |
| status | String | 狀態值 waiting:等待處理 process:處理中 success:重製成功 fail:重製失敗 uploaded:上傳點播成功 uploadFailed:上傳點播失敗 |
| remainDay | Integer | 重製剩餘的過期時間,過期後將無法存取和下載 |
| duration | Integer | 重製的影片時長,單位秒 |
| videoId | String | 直播系統影片ID,如:992d36fa40 |
| vid | String | 重製課件上傳到點播的點播影片VID |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 查询重制课件任务列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testPptRecordList() 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/pptRecord/list";
String channelId="1965681";
String sessionId="fsb50pwxec";
String status="success";
String startTime="20200111000000";
String endTime="20201111000000";
String page=String.valueOf(1);
String pageSize=String.valueOf(2);
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sessionId", sessionId);
requestMap.put("status", status);
requestMap.put("startTime", startTime);
requestMap.put("endTime", endTime);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询重制课件任务列表,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageNumber": 1,
"totalPages": 1,
"pageSize": 2,
"contents": [
{
"taskId": 236067,
"channelId": 1965681,
"title": "修改标题后",
"url": "http://playback.videocc.net/transform/992d36fa40_0.mp4?auth_key=1652509714-0-0-31919e0b005ec2c1b89b0385394f88ec",
"sessionId": "fsb50pwxec",
"startTime": "20201021145602",
"status": "success",
"remainDay": 0,
"duration": 5,
"videoId": "992d36fa40",
"vid": "1b448be32312e7504159ce7008c81295_1"
},
{
"taskId": 402456,
"channelId": 1965681,
"title": "回放183-33",
"url": "http://playback.videocc.net/transform/14785e39ff_1.mp4?auth_key=1654219664-0-0-a3ca953d6666a788151abe56009ac90a",
"sessionId": "g1yjsdnu9q",
"startTime": "20210901171754",
"status": "success",
"remainDay": 0,
"duration": 92,
"videoId": "14785e39ff",
"vid": null
}
]
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
