# 添加视频至播放列表

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/play-list/add-video/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)

### 请求参数描述

| 参数名        | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| ---------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userid     | true | String | 保利威点播账户id，可以参考【[获取密匙](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口）                                                           |
| ptime      | true | Long   | 当前时间的毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign       | true | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】 |
| playListId | true | String | 播放列表ID                                                                                                                                                                                                    |
| vid        | true | String | 视频ID                                                                                                                                                                                                      |

### 示例

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

表单参数：

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

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                              |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                        |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                               |
| data    | String  | 成功返回success，失败返回空                                                                                                               |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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

        }
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)

成功示例

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

异常示例

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