批量转存暂存视频到云点播

接口描述

1、批量转存直播暂存录制视频文件到点播列表，接口转存过程为异步处理过程
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/record/convert

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
fileIds	true	String	要转存的录制视频文件ID，多个ID用英文逗号,分隔【fileId可通过查询频道录制视频信息获取】
fileName	false	String	转存后的文件名，目前暂不支持传多个文件名
canRepeat	false	Integer	点播视频回收站存在视频时是否返回成功，默认值为1(注：参数为1时，接口返回成功，实际不会重新转存点播视频)，建议传0 1：返回成功 0：返回异常
cataId	false	String	转存到点播的目录ID，默认为点播的根目录ID
callbackUrl	false	String	转存成功时候回调通知的url【详见回调说明】

示例

http://api.polyv.net/live/v3/channel/record/convert

表单参数：

fileName=%E6%B5%8B%E8%AF%95%E5%BC%82%E6%AD%A5%E8%BD%AC%E5%AD%98&fileIds=9a41298b5f032f3d5a8119b104c5dfcc%2C66fda01de2e11bf1d91e801ea7cbc431&appId=frlr1zazn3&sign=48F5D4ADC2A81256D906CCE715A2C267&cataId=1410431629027&callbackUrl=http%3A%2F%2Fabc.com&channelId=2191541&timestamp=1621840957439

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时返回提交成功信息 "submit success."：转存任务提交成功 "processing."：转存任务正在处理中

回调说明

转存结果实时信息回调，可以及时通知用户转存视频任务的结果。

原理

通过HTTP接口（设置的callbackUrl）向用户服务器发送GET请求，将转存结果推送给用户服务器。

举例说明

举例如下：http://abc.com/test.do?channelId=123456&vid=e6b23c6f5134943a015bc117e2854eae_e&title=视频标题&duration=01:23:45&fileSize=123400&timestamp=1557976774000&sign=xxxxxxxxxx&fileId=359a81ed8fd8cb83d88ddcd97d9e8a2b&videoId=b1c6f3ad2c&origin=auto&sessionIds=["20190703145126,4,fdqbopvtnv","20190703145126,8,fdqbopvtnv"]

转存成功回调参数

参数名	类型	说明
status	String	接口处理结果，成功为success，失败为error
channelId	String	频道号
vid	String	转存成功的视频id
title	String	视频标题
duration	String	视频时长，格式为：HH:mm:ss
fileSize	Long	视频文件大小（单位：字节）
timestamp	Long	13位毫秒级时间戳
sign	String	校验的加密字符串，生成的规则md5(AppSecret+timestamp)，AppSecret是直播系统的用密钥
sessionIds	String	录制的场次和时间对应的数组字符串，格式：["20190703145126,4,fdqbopvtnv","20190703145126,8,fdqbopvtnv"] ，其中："20190703145126,4,fdqbopvtnv" 第一个字段是开始时间，第二个字段是直播的时长，第三个是对应的sessionId。
fileId	String	转存对应的录制文件id
videoId	String	转存回放唯一的id
origin	String	转存的录制来源 manual：云录制 auto：自动录制 merge：合并 clip：裁剪
sessionId	String	回放对应的单个场次id
userId	String	POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）

转存失败回调参数

参数名	类型	说明
status	String	接口处理结果，成功为success，失败为error
code	String	错误码 userExpired：用户已过期 spaceOverSize：点播空间不足 unknown：未知异常
userId	String	POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）
channelId	String	频道号
fileId	String	转存的文件id
sign	String	校验的加密字符串，生成的规则md5(AppSecret+timestamp)，AppSecret是直播系统的用密钥
timestamp	Long	当前13位毫秒级时间戳

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 异步批量转存录制文件到点播
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRecordConvert() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/record/convert";
    String channelId = "2139283";
    String fileIds = "97e6b0ca2422069be036507218b7c2fb";
    String fileName = "测试异步转存";
    String cataId = "1410431629027";
    String callbackUrl = "http://abc.com";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("fileIds", fileIds);
    requestMap.put("fileName", fileName);
    requestMap.put("cataId", cataId);
    requestMap.put("callbackUrl", callbackUrl);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试异步批量转存录制文件到点播，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"submit success."
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}