取得所有播放清單
更新時間:2026-03-31 10:14:55
介面說明
1、获取播放列表详细信息
2、接口支持https协议
介面URL
http://api.polyv.net/v2/play-list/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| userid | true | String | 保利威點播帳戶id,可參考【取得密鑰】取得,取得路徑:官網->登入->點播(API介面) |
| ptime | true | Long | 當前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值,產生簽名的secretkey密鑰作為通訊資料安全的關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| playListIds | false | String | 播放清單ID,多個以英文逗號分隔,最大1000個如"1620153765497,1620142496099" |
| title | false | String | 標題,按標題模糊搜尋 |
| vidStyle | false | String | vid樣式, 當傳值為LONG_STYLE時, 介面回傳的vid攜帶下橫線和userId首字母, 如e4f34f779d7b2933adf2ef91419e15fc_e, 傳SIMPLE或不傳此參數時, vid格式如下: e4f34f779d7b2933adf2ef91419e15fc |
| page | false | Integer | 當前頁碼,預設為1 |
| pageSize | false | Integer | 每頁大小,最大1000條,預設為10 |
範例
http://api.polyv.net/v2/play-list/list?playListIds=1620281719396&sign=9F5DC096563BF829DB240ABE3D2A3CB59B8437C4&pageSize=10&page=1&userid=1b448be323&ptime=1620282908818
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 成功回傳播放清單資訊,失敗回傳空【詳見data欄位說明】 |
data欄位說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 頁碼 |
| totalPages | Integer | 總頁數 |
| pageSize | Integer | 每頁大小 |
| contents | Array | 播放清單分頁資料【詳見contents欄位說明】 |
| totalItems | Integer | 總數 |
contents欄位說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| id | Long | 播放清單ID |
| description | String | 播放清單描述資訊 |
| tag | String | 播放清單標籤 |
| title | String | 播放清單標題 |
| creationTime | Long | 播放清單建立時間,13位毫秒時間戳 |
| updateTime | Long | 播放清單最近更新時間,13位毫秒時間戳 |
| videoCount | Integer | 播放清單的影片數量 |
| videoList | Array | 播放清單的影片列表【詳見videoList欄位說明】 |
videoList欄位說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| vid | String | 影片ID |
| title | String | 影片標題 |
| cateId | Long | 分類id |
| cateName | String | 分類名稱 |
| tags | String | 影片標籤 |
| duration | Float | 影片時長,單位:秒 |
| coverURL | String | 影片首圖URL |
| miniCoverURL | String | 首圖地址,小圖,同coverURL |
| largeCoverURL | String | 首圖地址,大圖 |
| addTime | Long | 影片新增時間,13位毫秒時間戳 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(VodPlaylistTest.class);
/**
* 获取所有播放列表
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetPlayLists() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v2/play-list/list";
String playListIds = "1620281719396";
String page = "1";
String pageSize = "10";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userid", userId);
requestMap.put("ptime", ptime);
requestMap.put("playListIds", playListIds);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试获取所有播放列表,{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "success",
"data": {
"pageNumber": 1,
"totalPages": 1,
"pageSize": 10,
"contents": [
{
"id": 1620281719396,
"description": "这是描述",
"tag": "测试创建",
"title": "测试创建播放列表接口5-6",
"creationTime": 1620281719396,
"updateTime": 1620282805755,
"videoCount": 1,
"videoList": [
{
"vid": "1b448be32368e6eb106c31d490c19144",
"title": "junit-远程批量上传视频",
"duration": 85,
"addTime": 1620282805755,
"coverURL": "http://img.videocc.net/uimage/1/1b448be323/first_image/a626c3c8-8e73-4a9e-90f4-ea5217d5678d_s.jpg"
}
]
}
],
"totalItems": 1
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "the sign is not right",
"data": ""
}
