创建视频源文件取回任务
更新时间:2023-09-15 10:54:33
接口描述
1、创建获取已发布视频的源文件下载链接的任务。当单个视频资源准备好就会回调给用户,用户亦可以主动查询任务
2、接口支持https协议
接口URL
http://api.polyv.net/v3/video/source-file-task/create
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 保利威点播子账户appId,获取路径:保利威点播后台->设置->账号管理 |
| timestamp | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,32位大写MD5值【详见MD5签名生成规则】 |
| vids | true | String | 视频ID,多个用英文逗号隔开,上限是100个。例如: "1b448be32370f4822ac40fd926112a66_1,1b448be32305bb29879b1eb06abd9fa1_1" |
| expireDays | true | Integer | 文件解冻有效天数。取值范围(包含):1-7 |
示例
http://api.polyv.net/v3/video/source-file-task/create
表单参数:
vids=1b448be32370f4822ac40fd926112a66_1%2C1b448be32305bb29879b1eb06abd9fa1_1&expireDays=1&appId=a0Wmol5EwX&sign=197679CCF105DD80E0378BEF75993D31×tamp=1617950661602
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| requestId | String | 本次请求的业务流水号,便于客户端/服务器端排查问题 |
| error | Object | 响应失败时返回错误的详细信息【详见error字段说明】,响应成功时返回空 |
| data | Object | 响应成功时返回任务ID【详见data字段说明】,响应失败时返回空 |
error字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误码 |
| desc | String | 错误描述【详见全局错误说明】 |
data字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| taskId | String | 任务ID |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
private static final Logger log = LoggerFactory.getLogger(Test.class);
/**
* 创建视频源文件取回任务
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void tesCreateVideoSourceFileTask() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v3/video/source-file-task/create";
String vids = "1b448be32370f4822ac40fd926112a66_1,1b448be32305bb29879b1eb06abd9fa1_1";
int expireDays = 1;
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("vids", vids);
requestMap.put("expireDays", expireDays);
//用md5进行签名,使用子账号的secretKey签名
requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.debug("测试创建视频源文件取回任务,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"requestId": "9d43e946-5354-45a8-a4a7-0db49784fecf",
"code": 200,
"status": "success",
"error": null,
"data": {
"taskId": "16661c08b9564c1ea6f4544ccd568e58"
}
}
异常示例
{
"requestId": "e7544473-250a-40eb-b53b-8768195617e0",
"code": 403,
"status": "error",
"error": {
"code": 104,
"desc": "invalid signature"
},
"data": null
}
