接口描述
1、通过视频URL链接,异步批量上传视频
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
接口URL
http://api.polyv.net/v2/video/grab/{userid}/upload/multi
在线API调用
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、uploadInfos 和 (fileUrl、title)必传其一,并且 uploadInfos 的优先级高于 (fileUrl、title),建议使用 uploadInfos
请求参数描述
参数名 | 必选 | 类型 | 说明 |
---|
| | | 保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口) |
| | | |
| | | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据 【详见签名生成规则】 |
| | | |
| | | 是否录屏优化,默认为0:不优化
0:不优化
1:优化 |
| | | 自定义水印图片链接,图片格式必须是png格式,支持http、https协议 |
| | | 自定义水印图片位置,如没该参数,则自定义水印的显示情况跟随分类或账号设置
1:左上角
2:右上角
3:左下角
4:右下角 |
| | | |
| | | 待批量上传视频的URL,多个URL之间使用英文逗号隔开,支持http、https协议,已不建议使用,请使用 uploadInfos 参数 |
| | | 标题,多个标题使用英文逗号隔开,标题数量必须和文件地址fileUrl数量一致,已不建议使用,请使用 uploadInfos 参数 |
uploadInfos参数说明
参数名 | 必选 | 类型 | 说明 |
---|
| | | 待上传视频的URL,支持http、https协议,长度限制:1000 个字符 |
| | | |
| | | 自定义数据,长度限制:100 个字符,如果提交了该字段,会在上传完成回调时透传返回,详见【回调通知使用说明】 |
uploadInfos示例:
[{"fileUrl":"test.mp4","title":"test","state":"test"}]
示例
http://api.polyv.net/v2/video/grab/1b448be323/upload/multi
表单参数:
watermark=https%3A%2F%2Fimg.videocc.net%2Fuimage%2F1%2F1b448be323%2Fe%2F1b448be323fddcd3f8823f534918039e_0_b.jpg&uploadInfos=%5B%7B%22fileUrl%22%3A%22https%3A%2F%2Foss.polyv.net%2Fuploads%2F2023%2F12%2F27YlLZVCM_test.mp4%22%2C%22title%22%3A%22%E6%B5%8B%E8%AF%95%E5%BC%82%E6%AD%A5%E4%B8%8A%E4%BC%A0%E8%A7%86%E9%A2%911%22%2C%22state%22%3A%22test%22%7D%5D&sign=68EF1B1A3F9D4D726D68F882C9EBA11A0584CFE8&cataid=1602671097888&luping=0&ptime=1670902537111&watermarkLocation=4
响应参数描述
参数名 | 类型 | 说明 |
---|
| | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| | |
| | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| | |
回调说明
接口只返回上传结果,异步上传的视频文件处理结果,需要通过回调获取,【详见回调通知使用说明】
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodVideoUploadTest.class);
/**
* 异步批量上传视频
*/
@Test
public void testUrlBatchUpload() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userid = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = String.format("http://api.polyv.net/v2/video/grab/%s/upload/multi", userid);
String uploadInfos = "[{\"fileUrl\":\"https://oss.polyv.net/uploads/2023/12/27YlLZVCM_test.mp4\"," +
"\"title\":\"测试异步上传视频1\",\"state\":\"test\"}]";
String cataid = "1602671097888";
String luping = "0";
String watermark = "https://img.videocc.net/uimage/1/1b448be323/e/1b448be323fddcd3f8823f534918039e_0_b.jpg";
String watermarkLocation = "4";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("uploadInfos", uploadInfos);
requestMap.put("cataid", cataid);
requestMap.put("luping", luping);
requestMap.put("watermark", watermark);
requestMap.put("watermarkLocation", watermarkLocation);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFormBody(url, requestMap);
log.debug("测试异步批量上传视频,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": "成功"
}
异常示例
文件url不能为空
{
"code":400,
"status":"error",
"message":"FileUrl is null!",
"data":""
}
文件标题不能为空
{
"code":400,
"status":"error",
"message":"Title is null!",
"data":""
}
uploadInfos数量超出限制
{
"code":400,
"status":"error",
"message":"[uploadInfos] exceed the limit.",
"data":""
}
uploadInfos参数格式不合法
{
"code":400,
"status":"error",
"message":"[uploadInfos] is invalid",
"data":""
}
文件的url个数必须和title个数相同
{
"code":400,
"status":"error",
"message":"FileUrl and title are inconsistent!",
"data":""
}