# 分页获取简单频道信息列表接口

### 接口URL

```
http://api.polyv.net/live/v3/channel/management/query-list-sample
```

### 接口说明

```
1、分页获取简单频道列表信息接口
2、每页数据最大100个
2、接口支持https
```

### 支持格式

```
JSON
```

### 请求方式

```
GET
```

### 请求数限制

```
TRUE
```

### 请求参数

| 参数名        | 必选 | 类型     | 说明                                                                                                                                                                                                        |
| ---------- | -- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId      | 是  | string | 从API设置中获取，在直播系统登记的appId                                                                                                                                                                                   |
| timestamp  | 是  | long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign       | 是  | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelIds | 否  | string | 频道号,多个以英文逗号分割开，如：100001,100002                                                                                                                                                                            |
| startDay   | 否  | string | 开始日期，格式yyyy-MM-dd                                                                                                                                                                                         |
| endDay     | 否  | string | 结束日期，格式yyyy-MM-dd                                                                                                                                                                                         |
| size       | 否  | int    | 每页大小                                                                                                                                                                                                      |
| page       | 否  | int    | 当前页                                                                                                                                                                                                       |

### 响应成功JSON示例：

```json
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 1,
        "pageNumber": 1,
        "totalItems": 129,
        "contents": [
            {
                "channelId": 128457,
                "name": "普通暖场视频",
                "startTime": "2020-08-06 18:20:00.0"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "prePageNumber": 1,
        "limit": 1,
        "endRow": 1,
        "nextPageNumber": 2,
        "totalPages": 129,
        "offset": 0
    }
}
```

### 响应失败JSON示例：

未输入appId

```json
{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}
```

appId不正确

```json
{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}
```

时间戳错误

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

签名错误

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

### 字段说明

| 参数名            | 类型      | 说明                                  |
| -------------- | ------- | ----------------------------------- |
| code           | int     | 响应代码，成功为200，失败为400，签名错误为401，异常错误500 |
| status         | string  | 成功为success，失败为error                 |
| message        | string  | 错误时为错误提示消息                          |
| data           | object  | 响应结果集                               |
| pageNumber     | int     | 当前的页数                               |
| totalItems     | int     | 总的条数                                |
| contents       | array   | 查询的结果列表                             |
| channelId      | int     | 频道号                                 |
| name           | string  | 频道名称                                |
| startTime      | string  | 直播开始时间                              |
| firstPage      | boolean | 是否为第一页，值为：true/false                |
| lastPage       | boolean | 是否为最后一页，值为：true/false               |
| nextPageNumber | int     | 下一页编号                               |
| prePageNumber  | int     | 上一页编号                               |
| totalPages     | int     | 总页数                                 |
| startRow       | int     | 当前页第一个数量的位置                         |
| endRow         | int     | 当前页最后一个数量的位置                        |
| limit          | int     | 每页数量大小                              |

### Java请求示例

```java
public static void main(String[] args) {
        String url = "http://api.polyv.net/live/v3/channel/management/query-list-sample";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
		params.put("channelIds", "0000000");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
    }
```