同步转存录制文件到点播

接口描述

1、将直播录制文件转存至点播后台中
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channel/recordFile/{channelId}/convert

请求方式

POST

接口约束

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

2、同一个POLYV账号,调用该接口的间隔至少5分钟

3、可以同时传fileUrl和sessionId,或必传其中一个

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

userId

true

String

直播账号ID

fileName

true

String

转存后的点播视频名称

fileUrl

false

String

转存到录制文件地址【可通过查询频道录制视频信息获取】

sessionId

false

String

直播场次ID,只传此参数时,可将对应场次的直播录制视频转存到点播

cataid

false

String

目录ID,不填或者填写错误即为默认分类

cataname

false

String

目录名称,默认为默认分类,当cataid设置为-1时,会新建一个名称为cataname的目录,并将视频放到该目录下

toPlayList

false

String

是否存放到回放列表,默认为N,Y:存放到回放列表,N:不存放

setAsDefault

false

String

是否设为默认回放视频,默认为Y,Y:设置默认回放视频(转存后在回放列表中位于第一个),N:转存后在回放列表位于最后一个。此参数仅在toPlayList=Y时生效

响应参数描述

参数名类型说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

String

响应结果,请求成功时返回转存成功后的点播视频的id(即vid)

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 testRecordConvertSyn() 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/v2/channel/recordFile/%s/convert";
    String channelId = "2139283";
    String fileName = "测试同步转存";
    String fileUrl = "";
    String sessionId = "fvlyin8qz3";
    String cataId = "";
    String cataname = "默认分类";
    String toPlayList = "Y";
    String setAsDefault = "Y";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("userId", userId);
    requestMap.put("fileName", fileName);
    requestMap.put("sessionId", sessionId);
    requestMap.put("cataId", cataId);
    requestMap.put("cataname", cataname);
    requestMap.put("toPlayList", toPlayList);
    requestMap.put("setAsDefault", setAsDefault);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试同步转存录制文件到点播,返回值:{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"1b448be32353f0f4638f70a9545c75bd_1"
}

异常示例

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

Last updated