Add Video to Playlist

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

API Description

1、通过视频id添加视频到播放列表
2、接口支持https协议

API URL

http://api.polyv.net/v2/play-list/add-video

Online API Call

Request Method

POST

API Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to frequency 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, 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 never be saved or used directly on the client side. All APIs must be relayed through the customer's own server to call the POLYV server and retrieve response data.` See Signature Generation Rules for details
playListId	true	String	Playlist ID
vid	true	String	Video ID

Example

http://api.polyv.net/v2/play-list/add-video

Form Parameters:

vid=1b448be32366f55b1422ac94a4fb7932_1&sign=BCA4C97EFC471F976B1EAFF668EB82184B0E8A2E&userid=1b448be323&ptime=1620284595522&playListId=1620281719396

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	String	Returns "success" on success, empty on failure

Java Request Example

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

It is strongly recommended to use the VOD Java SDK for API functionality 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 testAddVideoToPlaylist()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/add-video";
        String playListId="1620281719396";
        String vid="1b448be32366f55b1422ac94a4fb7932_1";

        Map<String, String> requestMap=new HashMap<>();
        requestMap.put("userid",userId);
        requestMap.put("ptime",ptime);
        requestMap.put("playListId",playListId);
        requestMap.put("vid",vid);
        requestMap.put("sign",VodSignUtil.getSign(requestMap,secretKey));

        String response=HttpUtil.postFormBody(url,requestMap);
        log.debug("测试添加视频至播放列表,{}",response);
        //do somethings

        }

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "message": "success"
}

Error Example

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

VOD Server API