# 查询所有频道的基础信息

### 接口描述

```
1、查询账号下所有的频道基础信息列表
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/basic/channel-list
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/basic/channel-list/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名         | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ----------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId       | true  | String  | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp   | true  | Long    | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign        | true  | String  | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| categoryIds | false | String  | 分类ID，多个id用英文逗号分隔                                                                                                                                                                                          |
| page        | false | Integer | 查询页数，默认1                                                                                                                                                                                                  |
| pageSize    | false | Integer | 每页数据大小，默认20，最大20                                                                                                                                                                                          |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/basic/channel-list?categoryIds=340019%2C391352&appId=frlr1zazn3&sign=6E5E01CBF9D9B7F5216C0A7C93A897A7&pageSize=2&page=2&timestamp=1642734203497
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                               |
| ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                         |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                |
| data    | Object  | 成功响应时返回全账号频道基础信息【详见[data字段说明](#Data参数描述)】                                                                                        |

### Data参数描述

| 参数名            | 类型      | 说明                                       |
| -------------- | ------- | ---------------------------------------- |
| pageSize       | Integer | 每页数据大小，默认20，最大20                         |
| pageNumber     | Integer | 当前页数                                     |
| totalItems     | Integer | 总的条数                                     |
| contents       | Array   | 查询的结果列表【详见[Contents参数描述](#Contents参数描述)】 |
| startRow       | Integer | 当前页第一条记录在总结果集中的位置                        |
| firstPage      | Boolean | 是否为第一页，值为：true/false，默认为false            |
| lastPage       | Boolean | 是否为最后一页，值为：true/false，默认为false           |
| prePageNumber  | Integer | 上一页编号                                    |
| limit          | Integer | 每页数量大小                                   |
| nextPageNumber | Integer | 下一页编号                                    |
| endRow         | Integer | 当前页最后一条记录在总结果集中的位置                       |
| totalPages     | Integer | 总页数                                      |
| offset         | Integer | 分页起始记录                                   |

### Contents参数描述

| 参数名             | 类型      | 说明                                                                                        |
| --------------- | ------- | ----------------------------------------------------------------------------------------- |
| channelId       | String  | 频道号                                                                                       |
| name            | String  | 频道名称                                                                                      |
| publisher       | String  | 主持人名称                                                                                     |
| startTime       | Long    | 直播开始时间，关闭时为0，开启时为13位毫秒级时间戳                                                                |
| pageView        | Integer | 页面累计观看数                                                                                   |
| likes           | Integer | 观看页点赞数                                                                                    |
| coverImg        | String  | 频道图标url                                                                                   |
| splashImg       | String  | 频道引导图url                                                                                  |
| splashEnabled   | String  | <p>引导页开关，取值<br>Y：开启<br>N：关闭</p>                                                           |
| desc            | String  | 直播介绍                                                                                      |
| maxViewer       | Integer | 最大在线观看人数                                                                                  |
| watchStatus     | String  | <p>频道的观看页状态，取值为<br>live：直播中<br>end：直播结束<br>playback：回放中<br>waiting：等待中<br>unStart：未开始</p> |
| watchStatusText | String  | 观看页状态描述，直播中，回放中，已结束，等待中，未开始                                                               |
| onlineNum       | Integer | 在线人数                                                                                      |
| bgImg           | String  | 暖场图片URL                                                                                   |
| videoList       | Array   | 回放视频列表，当有多个时按添加时间倒叙排列【详见[videoList参数描述](#VideoList参数描述)】                                  |
| categoryId      | Integer | 分类ID                                                                                      |

### VideoList参数描述

| 参数名         | 类型     | 说明                    |
| ----------- | ------ | --------------------- |
| videoId     | String | 直播系统生成的id （视频库中的回放视频） |
| videoPoolId | String | 点播视频vid （视频库中的回放视频）   |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询所有频道的基础信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testChannelBasicList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/basic/channel-list";
    String categoryIds = "340019,391352";
    String page = "2";
    String pageSize = "2";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryIds", categoryIds);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询所有频道的基础信息，返回值：{}", response);
    //do somethings
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 2,
        "totalItems": 59,
        "contents": [
            {
                "channelId": 2791952,
                "name": "⌛Emoji⌛⌚⌨",
                "publisher": "主持人",
                "startTime": 0,
                "pageView": 0,
                "likes": 0,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
                "splashEnabled": "Y",
                "desc": "",
                "maxViewer": 0,
                "watchStatus": "unStart",
                "watchStatusText": "未开始",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null,
                "categoryId": 340019
            },
            {
                "channelId": 2779196,
                "name": "测试",
                "publisher": "主持人",
                "startTime": 1642453440000,
                "pageView": 0,
                "likes": 0,
                "coverImg": "https://liveimages.videocc.net/assets/wimages/pc_images/logo.png",
                "splashImg": "https://liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
                "splashEnabled": "Y",
                "desc": "",
                "maxViewer": -1,
                "watchStatus": "unStart",
                "watchStatusText": "未开始",
                "onlineNum": 0,
                "bgImg": null,
                "videoList": null,
                "categoryId": 340019
            }
        ],
        "limit": 2,
        "offset": 2,
        "endRow": 4,
        "totalPages": 30,
        "nextPageNumber": 3,
        "startRow": 3,
        "firstPage": false,
        "lastPage": false,
        "prePageNumber": 1
    }
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```
