查询账号下所有频道缩略信息

接口URL

http://api.polyv.net/live/v3/channel/management/list

接口说明

1、获取账号下所有的频道简单信息列表
2、列表信息仅包含频道简单信息,如需频道具体信息,请使用【获取频道信息】接口
3、接口支持https协议

支持格式

JSON

请求方式

 GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
page int 页数,默认为1
pageSize int 每页显示的数据条数,默认每页显示20条数据
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级时间戳,3分钟内有效
categoryId int 所属分类id
watchStatus string 观看页状态筛选,live-直播中,playback-回放中,end-已结束,waiting-未开始

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageSize": 5, 
        "pageNumber": 1, 
        "totalItems": 18, 
        "contents": [
            {
                "channelId": 324322, 
                "name": "t1", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "topclass", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "大班课", 
                "watchUrl": "https://live.polyv.cn/watch/324322"
            }, 
            {
                "channelId": 323876, 
                "name": "ffff", 
                "channelPasswd": "333", 
                "categoryId": "182162", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/323876"
            }, 
            {
                "channelId": 269428, 
                "name": "rrr", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/269428"
            }, 
            {
                "channelId": 244314, 
                "name": "tttt", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "waiting", 
                "watchStatusText": "未开始", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/244314"
            }, 
            {
                "channelId": 221626, 
                "name": "tttttt", 
                "channelPasswd": "333", 
                "categoryId": "89380", 
                "scene": "alone", 
                "watchStatus": "live", 
                "watchStatusText": "直播中", 
                "sceneText": "活动直播", 
                "watchUrl": "https://live.polyv.cn/watch/221626"
            }
        ], 
        "startRow": 1, 
        "firstPage": true, 
        "lastPage": false, 
        "nextPageNumber": 2, 
        "prePageNumber": 1, 
        "limit": 5, 
        "endRow": 5, 
        "totalPages": 4, 
        "offset": 0
    }
}

响应异常JSON示例:

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
pageNumber 当前页
totalItems 记录的总数
channelId 频道号
name 频道名称
channelPasswd 频道密码
scene 场景,alone-活动直播,ppt-三分屏,topclass-大班课
sceneText 场景描述
watchStatus 观看页状态,live-直播中,playback-回放中,end-已结束,waiting-未开始
watchStatus 观看页状态描述,直播中,回放中,已结束,未开始
watchUrl 观看页链接
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一条记录在总记录中的位置
endRow 当前页最后一个记录在总记录中的位置
limit 当前页纪录数
offset 当前页第一条记录在总记录中的位置

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'pageSize' => '5',
  'categoryId' => 89380
);

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

$url = "http://api.polyv.net/live/v3/channel/management/list?".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;
?>

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

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

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