建立播放清單

更新時間：2022-09-02 18:08:07

介面說明

1、创建点播视频播放列表
2、接口支持https协议

介面URL

http://api.polyv.net/v2/play-list/create

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP及HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必填	類型	說明
userid	true	String	保利威點播帳戶id，可參考【取得密鑰】取得，取得路徑：官網->登入->點播（API介面）
ptime	true	Long	目前時間的毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey密鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
title	true	String	播放清單標題
description	false	String	描述
tag	false	String	標籤

範例

http://api.polyv.net/v2/play-list/create

表單參數：

sign=B7B1EC6A8B3E8391A242034E1E42400A3944F879&description=%E8%BF%99%E6%98%AF%E6%8F%8F%E8%BF%B0&tag=%E6%B5%8B%E8%AF%95%E5%88%9B%E5%BB%BA&title=%E6%B5%8B%E8%AF%95%E5%88%9B%E5%BB%BA%E6%92%AD%E6%94%BE%E5%88%97%E8%A1%A8%E6%8E%A5%E5%8F%A35-6&userid=1b448be323&ptime=1620281717034

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	成功返回播放清單ID，失敗返回空【詳見data欄位說明】

data欄位說明

參數名	類型	說明
playListId	Long	播放清單ID

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 testAddPlayList() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/v2/play-list/create";
    String title = "测试创建播放列表接口5-6";
    String tag = "测试创建";
    String description = "这是描述";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("title", title);
    requestMap.put("tag", tag);
    requestMap.put("description", description);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试创建播放列表,{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": {
    "playListId": 1620281719396
  }
}

異常範例

{
  "code":400,
  "status":"error",
  "message":"the sign is not right",
  "data":""
}