接口URL
https://api.polyv.net/live/v3/channel/auth/download-record-info
接口说明
1、接口用于下载频道的登记观看列表,包含登记观看记录字段和数据内容
2、接口支持https
支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
timestamp | 是 | long | 13位当前时间戳 |
sign | 是 | string | 签名值 |
rank | 是 | int | 1为首要条件,2为次要条件。影响导出的表格表头 |
channelId | 是 | int | 频道号 |
响应成功说明:
响应成功时,接口将返回文件流,格式为.xls,内容为导出的登记观看记录数据。
响应失败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": 404,
"status": "error",
"message": "channel not found.",
"data": ""
}
字段说明
参数名 | 说明 |
---|---|
code | 响应代码,失败为400,签名错误为401,异常错误500 |
status | 成功为success,失败为error |
message | 错误时为错误提示消息 |
data | 错误时为空串 |
php构建下载链接示例
<?php
//引用config.php
include '/srv/http/local.php';
$channelId="206204";
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => $channelId,
'rank' => '1'
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "http://api.polyv.net/live/v3/channel/auth/download-record-info?".http_build_query($params);
// 输出构建后的下载链接
echo $url;
?>