Create Playlist

Updated: 2022-09-02 18:08:07

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
userid	true	String	Polyv VOD account ID. Refer to Get Secret Key for acquisition. Path: Official website -> Login -> VOD (API Interface)
ptime	true	Long	Current time in milliseconds timestamp, valid for 3 minutes
sign	true	String	Signature, a 40-character uppercase SHA1 value. `The secretkey used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
title	true	String	Playlist title
description	false	String	Description
tag	false	String	Tag

Example

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

Form Parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides auxiliary error reason
data	Object	Returns playlist ID on success, empty on failure. See data field description

data Field Description

Parameter	Type	Description
playListId	Long	Playlist ID

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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