创建播放列表

接口描述

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

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名必选类型说明

userid

true

String

保利威点播账户id,可以参考【获取密匙】获取,获取路径:官网->登录->点播(API接口)

ptime

true

Long

当前时间的毫秒级时间戳,3分钟内有效

sign

true

String

签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

title

true

String

播放列表标题

description

false

String

描述

tag

false

String

标签

示例

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

表单参数:

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

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

Object

成功返回播放列表ID,失败返回空【详见data字段说明

data字段说明

参数名类型说明

playListId

Long

播放列表ID

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

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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

Last updated