查询视频库列表

接口描述

1、管理系统视频列表信息入口：云直播-我的直播-频道设置-回放管理-视频库-回放列表/点播列表
2、接口URL中的{channelId}为频道号
3、接口支持https协议

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名必选类型说明

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
page	false	String	页数
pageSize	false	String	每页显示的数据条数
listType	false	String	视频列表类型，普通直播场景默认为vod，三分屏默认为playback playback：回放列表 vod：点播列表
sessionIds	false	String	场次ID，多个用英文逗号分割（仅查询转存文件来源为频道录制的视频）

appId

true

String

账号appId【详见获取密钥】

timestamp

true

Long

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

sign

true

String

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

page

false

String

页数

pageSize

false

String

每页显示的数据条数

listType

false

String

视频列表类型，普通直播场景默认为vod，三分屏默认为playback playback：回放列表 vod：点播列表

sessionIds

false

String

场次ID，多个用英文逗号分割（仅查询转存文件来源为频道录制的视频）

示例

http://api.polyv.net/live/v2/channel/recordFile/2191541/playback/list?appId=frlr1zazn3&sign=A4A5F279EC0D80E545B901982430CFE6&pageSize=10&page=1&listType=playback&timestamp=1621841458928

响应参数描述

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

参数名

类型

说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

Object

请求失败时为空，请求成功时为回放视频的视频列表信息【详见data字段描述】

data字段描述

参数名	类型	说明
pageSize	Integer	每页数据条数
pageNumber	Integer	当前页数
totalItems	Integer	总条数
contents	Array	查询的结果列表【详见Contents参数描述】
startRow	Integer	当前页第一条记录在总结果集中的位置
firstPage	Boolean	是否为第一页，值为：true/false
lastPage	Boolean	是否为最后一页，值为：true/false
prePageNumber	Integer	上一页编号
nextPageNumber	Integer	下一页编号
limit	Integer	每页数量大小
totalPages	Integer	总页数
endRow	Integer	当前页最后一条记录在总结果集中的位置
offset	Integer	分页起始记录

参数名

类型

说明

pageSize

Integer

每页数据条数

pageNumber

Integer

当前页数

totalItems

Integer

总条数

contents

Array

查询的结果列表【详见Contents参数描述】

startRow

Integer

当前页第一条记录在总结果集中的位置

firstPage

Boolean

是否为第一页，值为：true/false

lastPage

Boolean

是否为最后一页，值为：true/false

prePageNumber

Integer

上一页编号

nextPageNumber

Integer

下一页编号

limit

Integer

每页数量大小

totalPages

Integer

总页数

endRow

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：不播放
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：裁剪 smart-clip：智能裁剪
callbackUrl	String	转存视频时设置的回调地址
errorCount	Integer	处理失败的次数
lang	String	语言类型，默认为中文 zh_CN：中文 EN：英文
videoIdEN	String	英文回放videoId
enFileUrl	String	英文回放文件地址
mergeInfo	String	视频合并信息
watchUrl	String	观看回放视频的地址
originSessionId	String	来源场次Id
subtitleList	Array	回放字幕列表【详见subtitleList参数描述】

参数名

类型

说明

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：裁剪 smart-clip：智能裁剪

callbackUrl

String

转存视频时设置的回调地址

errorCount

Integer

处理失败的次数

lang

String

语言类型，默认为中文 zh_CN：中文 EN：英文

videoIdEN

String

英文回放videoId

enFileUrl

String

英文回放文件地址

mergeInfo

String

视频合并信息

watchUrl

String

观看回放视频的地址

originSessionId

String

来源场次Id

subtitleList

Array

回放字幕列表【详见subtitleList参数描述】

subtitleList参数描述

参数名	类型	说明
id	Long	字幕ID
name	String	字幕文件名称
srtUrl	String	字幕文件URL
language	String	字幕语言
status	String	字幕状态，publish--显示，finish-不显示

参数名

类型

说明

Long

字幕ID

name

String

字幕文件名称

srtUrl

String

字幕文件URL

language

String

字幕语言

status

String

字幕状态，publish--显示，finish-不显示

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 testGetPlayback() 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/playback/list";
    String channelId = "1965681";
    String page = "1";
    String pageSize = "10";
    String listType = "playback";
        
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    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":10,
        "pageNumber":1,
        "totalItems":1,
        "contents":[
            {
                "videoId":"1b96d90bf5",
                "videoPoolId":"1b448be323e68e4404332113a57353b2_1",
                "userId":"1b448be323",
                "channelId":2191532,
                "title":"Spring 知识精讲1111",
                "firstImage":"//doc.polyv.net/images/default/blackboard.png",
                "duration":"00:01:53",
                "myBr":"1",
                "qid":null,
                "seed":0,
                "ordertime":0,
                "createdTime":1615515464000,
                "lastModified":1615515464000,
                "rank":1,
                "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":null,
                "height":null,
                "origin":null,
                "callbackUrl":null,
                "errorCount":null,
                "lang":"zh_CN",
                "videoIdEN":null,
                "enFileUrl":null,
                "mergeinfo":"["20210311161313,113,fwmnnydr06"]",
                "watchUrl":"//live.polyv.cn/watch/2191532?vid=1b96d90bf5"
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":1,
        "totalPages":1,
        "endRow":1,
        "nextPageNumber":1,
        "offset":0
    }
}

异常示例

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

Previous查询频道回放开关 Next查询频道回放设置

Last updated 18 days ago