查询所有频道的回放视频
更新时间:2025-03-07 11:50:38
接口描述
1、查询账号下回放列表和点播列表, 注意:不包括暂存列表
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/user/playback/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| channelId | false | String | 频道号,不传查询账号下所有回放视频 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| page | false | String | 页码,默认为1 |
| pageSize | false | String | 每页数据大小,默认为20,合法范围为1-1000 |
| order | false | String | 排序规则,取值 timeDesc:按createdTime降序 rankDesc:按rank降序 time:按createdTime升序 rank:按rank升序,默认是timeDesc |
| listType | false | String | playback:回放列表 vod:点播列表,默认是playback |
示例
https://api.polyv.net/live/v3/user/playback/list?categoryIds=340019%2C345134&appId=frlr1zazn3&sign=CD602DA08E520D4EA28F20554907E0F2&pageSize=2&page=2&listType=playback×tamp=1621841524123&order=timeDesc
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 响应成功时返回回放视频列表信息【详见data字段说明】 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageSize | Integer | 每页数据大小,默认10,最大值1000 |
| pageNumber | Integer | 当前页数 |
| totalItems | Integer | 总的条数 |
| contents | Array | 查询的结果列表【详见Contents参数描述】 |
| startRow | Integer | 当前页第一条记录在总结果集中的位置 |
| firstPage | Boolean | 是否为第一页,值为:true/false,默认false |
| lastPage | Boolean | 是否为最后一页,值为:true/false,默认false |
| prePageNumber | Integer | 上一页编号 |
| limit | Integer | 每页数量大小 |
| nextPageNumber | Integer | 下一页编号 |
| endRow | Integer | 当前页最后一条记录在总结果集中的位置 |
| totalPages | Integer | 总页数 |
| offset | Integer | 分页起始记录 |
Contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| 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 Y:是 N:否 |
| url | String | 视频播放地址,注:如果视频为加密视频,则此地址无法访问 |
| channelSessionId | String | 用于PPT请求数据,与PPT直播的回放相关,普通直播回放值为null |
| status | String | 转存点播视频完成状态,已完成:Y,未完成:N |
| fileUrl | String | 视频地址 |
| fileId | String | 回放视频转存前的暂存fileId |
| startTime | String | 直播开始时间,格式:yyyyMMddHHmmss |
| liveType | String | 直播类型 alone:活动直播 ppt:三分屏 topclass:大班课 seminar:研讨会 |
| width | Integer | 视频宽度,返回为null,暂不返回具体值 |
| height | Integer | 视频高度,返回为null,暂不返回具体值 |
| origin | String | 转存文件来源 manual:手动录制 auto:自动录制 merge:合并 clip:裁剪 smart-clip:智能裁剪,返回为null,暂不返回具体值 |
| callbackUrl | String | 转存视频时设置的回调地址,返回为null,暂不返回具体值 |
| errorCount | Integer | 处理失败的次数,返回为null,暂不返回具体值 |
| lang | String | 语言 zh_CN:中文 EN:英文,返回为null,暂不返回具体值 |
| videoIdEN | String | 英文回放videoId,返回为null,暂不返回具体值 |
| enFileUrl | String | 英文回放文件地址,返回为null,暂不返回具体值 |
| mergeinfo | String | 视频合并信息 |
| watchUrl | String | 观看回放视频的地址 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
* 查询所有频道的回放视频
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testUserPlaybackList() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/live/v3/user/playback/list";
String categoryIds="340019,345134";
String page = "2";
String pageSize="2";
String order="timeDesc";
String listType="playback";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("categoryIds", categoryIds);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("order", order);
requestMap.put("listType", listType);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询所有频道的回放视频,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"",
"data":{
"pageSize":2,
"pageNumber":2,
"totalItems":8,
"contents":[
{
"videoId":"8073e37567",
"videoPoolId":"1b448be323a9076c9941604ac1c667f9_1",
"userId":"1b448be323",
"channelId":1965681,
"title":"Junit测试(勿删)",
"firstImage":"//doc.polyv.net/images/default/blackboard.png",
"duration":"05:15:01",
"myBr":"1",
"qid":null,
"seed":0,
"ordertime":0,
"createdTime":1610358017000,
"lastModified":1615521715000,
"rank":3,
"asDefault":"N",
"url":"https://hls.videocc.net/source/1b448be323/9/1b448be323a9076c9941604ac1c667f9_1.m3u8",
"channelSessionId":"fsz5i7qzr2",
"status":"Y",
"fileUrl":"http://oss-live-2.videocc.net/record/2020-11-12/1b448be3231603155365715c1aa/recordmerge-20201112093918.m3u8",
"fileId":"0145efa91ec0b1bf6f82cc2f6ac98abb",
"startTime":"20201028110419",
"liveType":"ppt",
"width":null,
"height":null,
"origin":null,
"callbackUrl":null,
"errorCount":null,
"lang":null,
"videoIdEN":null,
"enFileUrl":null,
"mergeinfo":"["20201028110421,18617,fsiog0shsh","20201028161448,4,fsix03jel5","20201028161455,65,fsix07id6x","20201028161618,38,fsix2mm1qj","20201028161705,119,fsix3fcffb","20201028164653,63,fsixx18b0p"]",
"watchUrl":"//live.polyv.cn/watch/1965681?vid=8073e37567"
},
{
"videoId":"b24edc10fd",
"videoPoolId":"1b448be3230a0194d959426ae005645f_1",
"userId":"1b448be323",
"channelId":1965681,
"title":"Junit测试(勿删)",
"firstImage":"//doc.polyv.net/images/default/blackboard.png",
"duration":"00:03:00",
"myBr":"1",
"qid":null,
"seed":0,
"ordertime":0,
"createdTime":1610358014000,
"lastModified":1615521715000,
"rank":2,
"asDefault":"N",
"url":"https://hls.videocc.net/source/1b448be323/f/1b448be3230a0194d959426ae005645f_1.m3u8",
"channelSessionId":"ftmnaan4l3",
"status":"Y",
"fileUrl":"https://oss-live-2.videocc.net/record/record/recordf/1b448be3231603155365715c1aa/1b448be3230a0194d959426ae005645f/2020-12-03-17-03-44_2020-12-03-17-06-53.m3u8",
"fileId":"387c5c4ca5f5d8aef24726ed3f0845b7",
"startTime":"20201203170345",
"liveType":"ppt",
"width":null,
"height":null,
"origin":null,
"callbackUrl":null,
"errorCount":null,
"lang":null,
"videoIdEN":null,
"enFileUrl":null,
"mergeinfo":"["20201203170401,174,ftmnaan4l3"]",
"watchUrl":"//live.polyv.cn/watch/1965681?vid=b24edc10fd"
}
],
"startRow":3,
"firstPage":false,
"lastPage":false,
"prePageNumber":1,
"limit":2,
"nextPageNumber":3,
"endRow":4,
"totalPages":4,
"offset":2
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
