查询频道直播场次信息

接口URL

https://api.polyv.net/live/v3/channel/session/list

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于查询频道直播场次信息
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId string 频道ID
startDate String 开始日期,格式YYYY-MM-DD
endDate String 结束日期,格式YYYY-MM-DD
page int 第一页 第几页
pageSize int 每页显示几条(默认20条)

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "limit": 20,
        "totalItems": 123,
        "contents":[{
            "channelId": 10001,
            "sessionId": "dadadadkjkdf",
            "startTime": "2019-01-02 00:00:00",
            "endTime": "2019-01-02 01:03:49"
        }]
    }
}

响应失败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 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为相关的信息
data.contents[0].channelId 频道ID
data.contents[0].sessionId 场次ID
data.contents[0].startTime 直播开始时间
data.contents[0].endTime 直播结束时间
data.totalItems 记录总数
data.limit 每页记录数
data.pageNumber 页数

php请求示例

<?php
//引用config.php
include 'config.php';

$channelId="183950";

$params = array(
  'appId' => $appId,
  'channelId' => $channelId,
  'timestamp' => $timestamp
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url = "http://api.polyv.net/live/v3/channel/session/list?appId=".$appId."&channelId=".$channelId."&timestamp=".$timestamp."&sign=".$sign;

echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...