查询频道直播暂存列表
更新时间:2024-08-26 15:59:15
接口描述
1、管理系统频道录制视频信息入口:云直播-我的直播-频道设置-回放管理-视频库-直播暂存
2、接口URL中的{channelId}为频道号
3、接口支持https协议
接口URL
http://api.polyv.net/live/v2/channels/{channelId}/recordFiles
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、请求参数startDate与endDate需要同时传,可查询时间范围内频道录制的视频信息
3、当sessionIds和startDate、endDate同时传时,仅sessionIds有效
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| userId | true | String | POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置) |
| startDate | false | String | 开始日期,格式:yyyy-MM-dd |
| endDate | false | String | 结束日期,格式:yyyy-MM-dd |
| sessionIds | false | String | 直播场次ID,多个用英文逗号分割 |
示例
http://api.polyv.net/live/v2/channels/2191541/recordFiles?appId=frlr1zazn3&sign=DABFF35FB3D25CAF37BB73F8944C2F44&userId=1b448be323×tamp=1621840820088
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Array | 请求失败时为空,请求成功时为频道录制视频信息 【详见data字段描述】 |
data字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | String | 频道号 |
| fileId | String | 录制文件ID |
| url | String | 录制文件地址,优先返回MP4,若没有MP4会返回M3U8 |
| startTime | String | 开始录制时间,格式为:yyyyMMddHHmmss |
| endTime | String | 结束录制时间,格式为:yyyyMMddHHmmss |
| fileSize | Long | 录制文件大小(单位:字节) |
| duration | Integer | 时长(单位:秒) |
| bitrate | Integer | 录制文件码率(单位:字节) |
| resolution | String | 分辨率,示例:1280x720 |
| channelSessionId | String | 直播的场次ID |
| fileName | String | 录制文件名称 |
| daysLeft | Integer | 录制文件剩余天数,大于0:剩余天数,-1:永久,不会返回过期的录制文件记录 |
| origin | String | 录制文件来源 manual:手动录制 auto:自动录制 merge:合并 clip:裁剪 smart-clip:智能裁剪 |
| originSessionId | String | 原始直播场次ID 当该录制文件为 手动录制或自动录制时就等于当前直播场次ID 当该录制文件为 合并或裁剪时为原始直播场次ID |
| recordFileType | String | 录制文件类型 complete:完整回放 part:自动录制_片段 merge:手动合并 clip:裁剪 |
| subtitleList | Array | 回放字幕列表【详见subtitleList参数描述】 |
subtitleList参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | 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 testGetChannelRecordInfo() 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/channels/%s/recordFiles";
String channelId = "2139283";
String startDate = "2020-01-01";
String endDate = "2021-04-01";
String sessionIds = "fwmnnydr06";
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("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道录制视频信息,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"",
"data":[
{
"channelId":2191532,
"fileId":"94ea693e1733389ae2e7693ebdacbd43",
"url":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-11-16-13-14_2021-03-11-16-15-07.mp4",
"startTime":"20210311161313",
"endTime":"20210311161507",
"fileSize":9200637,
"duration":114,
"bitrate":0,
"resolution":"1280x720",
"channelSessionId":"fwmnnydr06",
"fileName":"Spring 知识精讲1111",
"daysLeft": 165,
"origin": "auto",
"originSessionId": "fwmnnydr06"
}
]
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
