将视频从播放列表移除
更新时间:2022-09-02 18:08:07
接口描述
1、通过播放列表id和视频id将视频从播放列表移除
2、接口支持https协议
接口URL
http://api.polyv.net/v2/play-list/remove-video
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| userid | true | String | 保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口) |
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| playListId | true | String | 播放列表ID |
| vid | true | String | 视频id |
示例
http://api.polyv.net/v2/play-list/remove-video
表单参数:
vid=1b448be3239c2ef0cb3ab9fd105f7fb2_1&sign=316893CB4ED5E1ABDDA1883E2FEB4423DAF612C4&userid=1b448be323&ptime=1621217938573&playListId=1616396785347
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
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 testRemoveVideoToPlaylist() 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/remove-video";
String playListId = "1616396785347";
String vid = "1b448be3239c2ef0cb3ab9fd105f7fb2_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
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "success"
}
异常示例
签名不正确
{
"code": 400,
"status": "error",
"message": "the sign is not right",
"data": ""
}
时间戳过期
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
