查询多个频道回放设置
更新时间:2025-02-18 16:20:20
接口描述
1、查询多个频道回放设置
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/playback/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelIds | true | String | 用英文逗号隔开的频道号,如:10000,100001 最多100个 |
示例
http://api.polyv.net/live/v4/channel/playback/list?appId=frlr1zazn3&sign=DA99F02427F3DF709AE0BE4007501DC4&channelIds=3385357%2C1965681×tamp=1663859723019
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见Error字段描述】 |
| data | Array | 视频列表【详见data字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | Integer | 频道号 |
| playBackEnabled | String | 观看回放功能开关 Y:开启 N:关闭 |
| origin | String | 回放来源 record:暂存 playback:回放列表 vod:点播列表 |
| type | String | 回放方式 single:单个视频回放 list:列表回放 |
| videoList | Array | 视频列表,回放方式为单个视频时只会返回一个视频,列表回放时返回前10个视频,回放开关关闭时也会返回视频列表【详见videoList字段说明】 |
| globalSettingEnabled | String | 是否开启全局设置 Y:开启 N:关闭 |
videoList参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| videoId | String | 直播系统生成的id (回放来源为回放列表或点播列表有值) |
| videoPoolId | String | 点播视频videoPoolId (回放来源为回放列表或点播列表有值) |
| fileId | String | 回放视频转存前的暂存文件ID(回放来源为暂存时有值) |
| duration | String | 视频时长,格式为HH:mm:ss |
| name | String | 视频名称 |
| watchUrl | String | 回放视频的观看地址。留意,当“回放来源”不等于“暂存”时,该字段才有值 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询多个频道回放设置视频列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getChannelPlaybackListTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/playback/list";
String channelIds = "3385357,1965681";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelIds", channelIds);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询多个频道回放设置视频列表成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "4a3bcfe6010942ab801d53e76db05227.68.16638597246720685",
"data": [
{
"channelId": 1965681,
"playBackEnabled": "Y",
"origin": "playback",
"type": "single",
"videoList": [
{
"videoId": "1dcabe17a4",
"videoPoolId": "1b448be32347e1dfeb92fbf92849fda7",
"duration": "00:02:30",
"name": "Junit测试(勿删)",
"fileId": null
}
],
"globalSettingEnabled": "N"
},
{
"channelId": 3385357,
"playBackEnabled": "Y",
"origin": "record",
"type": "single",
"videoList": [],
"globalSettingEnabled": "Y"
}
],
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
