查詢課節回放影片
更新時間:2024-10-21 09:33:43
介面描述
1、查询课节回放视频
2、接口支持https协议
介面URL
https://api.polyv.net/hi-class-api/open/lesson/v1/getPlaybackVideo
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值【詳見簽名生成規則】 |
| lessonId | true | Long | 課節號 |
範例
http://api.polyv.net/hi-class-api/open/lesson/v1/getPlaybackVideo?appId=fyirmfdak4×tamp=1638782295111&sign=4FFEE70C353D7F97F9D9057A8A72E453&lessonId=1015
響應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 響應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 響應狀態文字資訊 |
| error | Error | 錯誤物件【詳見全域錯誤說明】 |
| data | Array | 請求失敗時為空,請求成功時為響應資訊 【詳見data欄位描述】 |
data欄位描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| lessonId | Long | 課節ID |
| lessonName | String | 課節名稱 |
| firstImage | String | 首頁截圖 |
| duration | String | 影片時長,格式 HH:mm:ss |
| vid | String | 影片id |
| status | Long | 影片狀態碼 60/61:已發布 10:等待編碼 20:正在編碼 40:編碼失敗 50:等待審核 51:審核不通過 |
| createTime | String | 影片建立時間 yyyy-MM-dd HH:mm:ss |
| videoSize | Long | 影片檔案大小,單位:Bytes |
| playTimes | String | 播放次數 |
| url | String | 影片連結 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
/**
* 查询课节回放视频
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getPlaybackVideo() 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/hi-class-api/open/lesson/v1/getPlaybackVideo";
String lessonId = "1015";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("lessonId",lessonId);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("查询课节回放视频:{}",response);
//do somethings
}
響應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"data": [
{
"lessonId": "1015",
"lessonName": "课节1015",
"firstImage": "//s1.videocc.net/default-img/small-class/default-cover.png",
"duration": "00:00:36",
"vid": "43f5f9caa2028deb711233444540e5964_4",
"status": "61",
"createTime": "2021-11-08 10:21:32",
"videoSize": 1095207,
"playTimes": "0",
"url": "http://mpv.videocc.net/43f5f9caa2/4/43f5f9caa2028deb711233444540e5964_4.mp4"
}
],
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"error": {
"code": 20012,
"desc": "课节不存在"
},
"data": null,
"success": false
}
