# 修改播放列表信息

### 接口描述

```
1、通过播放列表ID修改播放列表信息
2、接口支持https协议
```

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/play-list/update/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                                                                                                                                                                                                    |
| title       | true  | String | 标题                                                                                                                                                                                                        |
| description | false | String | 描述                                                                                                                                                                                                        |
| tag         | false | String | 标签                                                                                                                                                                                                        |

### 示例

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

表单参数：

```requestUrl
sign=609227D5F17FA3EED7A250691F68D0334614C554&description=%E6%B5%8B%E8%AF%95%E4%BF%AE%E6%94%B9%E6%8F%8F%E8%BF%B0&tag=%E4%BF%AE%E6%94%B9%E6%A0%87%E7%AD%BE&title=%E6%B5%8B%E8%AF%95%E4%BF%AE%E6%94%B9%E5%88%97%E8%A1%A8%E4%BF%A1%E6%81%AF5-6&userid=1b448be323&ptime=1620284179218&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    | Object  | 成功返回被修改的播放列表ID，失败返回空【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/playlist/modify_playlist.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名        | 类型   | 说明     |
| ---------- | ---- | ------ |
| playListId | Long | 播放列表ID |

### 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 testModifyPlaylist() 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/update";
    String playListId = "1620281719396";
    String title = "测试修改列表信息5-6";
    String tag = "修改标签";
    String description = "测试修改描述";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("playListId", playListId);
    requestMap.put("title", title);
    requestMap.put("description", description);
    requestMap.put("tag", tag);
    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",
  "data": {
    "playListId": 1620281719396
  }
}
```

异常示例

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