将点播视频添加到视频库

接口描述

1、添加账号对应的点播视频到直播频道下的视频库
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/playback/add

在线API调用

请求方式

POST

接口约束

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

2、跨频道设置三分屏回放，需要调用修改视频信息接口将vid对应视频tag修改为：频道号|ppt，如：2566989|ppt

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
vid	true	String	点播视频vid【可通过点播API-搜索视频获取】，如果跨频道请阅读接口约束第二点
setAsDefault	false	String	添加到视频库列表中的位置，默认为N Y：回放列表中置顶 N：回放列表中置底
listType	false	String	列表类型，普通直播场景默认为vod，三分屏默认为playback playback：回放列表 vod：点播列表

示例

http://api.polyv.net/live/v3/channel/playback/add

表单参数：

vid=1b448be32378ab852b8989f5cbf1359c_1&appId=frlr1zazn3&sign=A7AB37F4D0FC3EFFA4B40344E145410D&listType=playback&channelId=2191541&timestamp=1621841372083

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	请求失败时为空，请求成功时为频道录制视频信息 【详见data字段描述】

data字段描述

参数名	类型	说明
videoId	String	直播系统生成的id
videoPoolId	String	点播视频vid
userId	String	POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）
channelId	String	回放视频对应的直播频道号
title	String	视频标题
firstImage	String	视频首图
duration	String	视频长度，格式为HH:mm:ss
myBr	String	默认视频的播放清晰度 1：流畅 2：高清 3：超清
qid	String	访客信息收集id
seed	Integer	视频加密状态 1：加密 0：非加密
ordertime	Integer	关联点播视频的排序字段
createdTime	Long	添加为回放视频的日期，13位毫秒级时间戳
lastModified	Long	视频最后修改日期，13位毫秒级时间戳
rank	Integer	排序值，值越大优先级越高
asDefault	String	是否为默认播放视频 Y：播放 N：不播放
url	String	视频播放地址，注：如果视频为加密视频，则此地址无法访问
channelSessionId	String	用于PPT请求数据，与PPT直播的回放相关，普通直播回放值为null
status	String	关联点播视频的状态
fileUrl	String	视频地址
fileId	String	回放视频转存前的暂存fileId
startTime	String	直播开始时间，格式为：yyyyMMddHHmmss
liveType	String	直播类型 alone：活动直播 ppt：三分屏 topclass：大班课 seminar：研讨会
width	Integer	视频宽度
height	Integer	视频高度
origin	String	转存文件来源 manual：手动录制 auto：自动录制 merge：合并 clip：裁剪
callbackUrl	String	转存视频时设置的回调地址
errorCount	Integer	处理失败的次数
lang	String	语言类型，默认为中文 zh_CN：中文 EN：英文
videoIdEN	String	英文回放videoId
enFileUrl	String	英文回放文件地址
mergeInfo	String	视频合并信息

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 testAddVodPlayback() 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/playback/add";
    String channelId = "2191532";
    String vid = "1b448be323e68e4404332113a57353b2_1";
    String setAsDefault = "Y";
    String listType = "playback";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("vid", vid);
    requestMap.put("setAsDefault", setAsDefault);
    requestMap.put("listType", listType);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试将点播中的视频添加到视频库，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "videoId":"1b96d90bf5",
        "videoPoolId":"1b448be323e68e4404332113a57353b2",
        "userId":"1b448be323",
        "channelId":2191532,
        "title":"Spring 知识精讲1111",
        "firstImage":"1b448be323/2/1b448be323e68e4404332113a57353b2_0.jpg",
        "duration":"00:01:53",
        "myBr":"1",
        "qid":null,
        "seed":0,
        "ordertime":0,
        "createdTime":1615515464000,
        "lastModified":1615777234000,
        "rank":0,
        "asDefault":"N",
        "url":"https://hls.videocc.net/source/1b448be323/2/1b448be323e68e4404332113a57353b2_1.m3u8",
        "channelSessionId":"fwmnnydr06",
        "status":"Y",
        "fileUrl":"https://oss-live-2.videocc.net/record/record/recordf/1b448be323161536226913173df/1b448be323e68e4404332113a57353b2/2021-03-11-16-13-14_2021-03-11-16-15-07.m3u8",
        "fileId":"94ea693e1733389ae2e7693ebdacbd43",
        "startTime":"20210311161313",
        "liveType":"ppt",
        "width":1280,
        "height":720,
        "origin":"auto",
        "callbackUrl":null,
        "errorCount":0,
        "lang":"zh_CN",
        "videoIdEN":null,
        "enFileUrl":null,
        "mergeinfo":null
    }
}

异常示例

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