查询频道单个直播暂存信息
更新时间:2023-02-22 18:17:04
接口描述
1、通过文件ID查询频道内录制视频文件信息
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/record/get
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
| fileId | true | String | 文件ID【可通过查询频道录制视频信息获取】 |
示例
https://api.polyv.net/live/v3/channel/record/get?appId=frlr1zazn3&sign=697FE70BFEDEED1FB424A30557C8459C&channelId=2191532×tamp=1621840860506&fileId=94ea693e1733389ae2e7693ebdacbd43
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 请求失败时为空,请求成功时为录制视频文件信息 【详见data字段描述】 |
data字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| fileId | String | 文件ID |
| userId | String | POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置) |
| channelId | String | 频道号 |
| startTime | String | 开始录制时间,格式为:yyyyMMddHHmmss |
| endTime | String | 结束录制时间,格式为:yyyyMMddHHmmss |
| fileName | String | 录制文件名称 |
| fileSize | Long | 录制文件大小(单位:字节) |
| createdTime | Long | 创建时间,13位毫秒级时间戳 |
| width | Integer | 视频宽度(像素) |
| height | Integer | 视频高度(像素) |
| duration | Integer | 时长(单位:秒) |
| bitrate | Integer | 录制文件码率(单位:字节) |
| mp4 | String | mp4文件地址 |
| m3u8 | String | m3u8文件地址 |
| channelSessionId | String | 直播的场次ID |
| liveType | String | 直播类型 alone:活动直播 ppt:三分屏 topclass:大班课 seminar:研讨会 |
| daysLeft | Integer | 录制文件剩余天数,大于0:剩余天数,0:过期,-1:永久 |
| originSessionId | String | 来源场次Id |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
* 查询指定文件ID的录制文件信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetRecordFile() 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/channel/record/get";
String channelId = "2191532";
String fileId = "94ea693e1733389ae2e7693ebdacbd43";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("fileId", fileId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询指定文件ID的录制文件信息,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"",
"data":{
"fileId":"94ea693e1733389ae2e7693ebdacbd43",
"userId":"1b448be323",
"channelId":2191532,
"startTime":"20210311161313",
"endTime":"20210311161507",
"filename":"Spring 知识精讲1111",
"filesize":9200637,
"createdTime":1615450629000,
"width":1280,
"height":720,
"duration":114,
"bitrate":0,
"mp4":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-12-16-13-14_2021-03-12-16-15-07.mp4",
"m3u8":"https://oss-live-1.videocc.net/record/record/recordf/1b448be323161536226913173df/2021-03-12-16-13-14_2021-03-12-16-15-07.m3u8",
"channelSessionId":"fwmnnydr06",
"liveType":"ppt",
"daysLeft":165
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
