获取频道回放的详细信息
更新时间:2022-09-02 18:08:07
接口URL
https://api.polyv.net/live/v3/channel/playback/list-playback-detail
接口说明
1、接口用于获取频道回放的详细信息
2、接口支持https
支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
| timestamp | 是 | long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | 是 | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | 是 | int | 频道号 |
| page | 否 | int | 页码,默认为1 |
| pageSize | 否 | int | 页面大小,默认为12,上限为1000 |
| startTime | 否 | string | 开始时间,格式为yyyyMMddHHmmss。筛选直播开始时间大于等于该参数的回放 |
| endTime | 否 | string | 结束时间,格式为yyyyMMddHHmmss。筛选直播开始时间小于等于该参数的回放 |
| fileId | 否 | string | 录制id,使用该参数则为精确查询,忽略日期区间过滤 |
响应成功JSON示例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageNumber": 1,
"totalPages": 1,
"pageSize": 1,
"contents": [
{
"channelId": 352078,
"sessionId": "fhbc977k1j",
"sessionIds": "[\"20191028151506,922,fhbc977k1j\"]",
"fileId": "73fe1f8f609ce315d7d8ab8a5a3c839e",
"title": "title",
"startTime": "20191028151506",
"endTime": "20191028153028",
"duration": 922,
"videoId": "eba9c64cae",
"mp4Url": "http://dl.videocc.net/23c0193d81/none_23c0193d819dcfc3e9184662f4fa56cd_1.mp4",
"recordPPTStatus": 1,
"recordPPTUrl": "http://dl.videocc.net/23c0193d81/none_23c0193d813efe97b0578b0c25ef2788_1.mp4",
"zipUrl": "http://liveimages.videocc.net/ppt/23c0193d819dcfc3e9184662f4fa56cd.zip",
"zipStatus": 1,
"origin": "auto"
}
]
}
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
频道号格式错误
{
"code": 400,
"status": "error",
"message": "param is not digit: dsadasd",
"data": ""
}
日期格式错误
{
"code": 400,
"status": "error",
"message": "invalid date time format",
"data": ""
}
数值范围错误
{
"code": 400,
"status": "error",
"message": "number range error",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码,成功为200,失败为400,签名错误为401,异常错误500 |
| status | 成功为success,失败为error |
| message | 错误时为错误提示消息 |
| data | 成功响应时为回放详情分页数据 |
| pageNumber | 当前页码 |
| totalPages | 总页数 |
| pageSize | 页面大小 |
| contents | 回放详情数据列表 |
| channelId | 所属频道号 |
| sessionId | 回放对应的单个场次id |
| sessionIds | 场次和时间对应的数组字符串,格式:["20190703145126,4,fdqbopvtnv","20190703145126,8,fdqbopvtnv"] ,其中:"20190703145126,4,fdqbopvtnv" 第一个字段是开始时间,第二个字段是直播的时长,第三个是对应的sessionId。 |
| fileId | 对应的录制文件id |
| title | 回放标题 |
| startTime | 直播开始时间,格式为yyyyMMddHHmmss。筛选直播开始时间大于等于该参数的回放 |
| endTime | 直播结束时间,格式为yyyyMMddHHmmss。筛选直播开始时间小于等于该参数的回放 |
| duration | 直播时长,单位秒 |
| videoId | 回放id,可用于SDK播放在线回放 |
| mp4Url | 回放转存后的mp4下载地址 |
| recordPPTStatus | 重制状态,1为重制已经可用,0为重制未完成 |
| recordPPTUrl | 当重制状态为1时,该字段为重制的mp4下载地址 |
| zipUrl | 离线包下载地址 |
| zipStatus | 离线包状态,0代表还未打包完成,1代表已完成 |
| origin | 回放来源,manual-云录制,auto-自动录制,merge-合并,clip-裁剪 |
php请求示例
<?php
//引用config.php
include 'config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => 206204,
'page' => 1,
'pageSize' => 5,
'startTime' => '20191001120000',
'endTime' => '20191015235959'
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "https://api.polyv.net/live/v3/channel/playback/list-playback-detail?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 0);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
