# 查询所有频道的缩略信息
旧版接口地址[查询所有频道的缩略信息(旧版)](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/account/get_simple_channel_list/README.md)
### 接口描述
```
1、查询账号下所有的频道缩略信息列表，观看页状态与新版后台一致
2、列表信息仅包含频道缩略信息，如需频道具体信息，请使用【获取频道信息】接口
3、接口支持https协议
```
### 接口URL
```
http://api.polyv.net/live/v4/channel/simple/list
```
[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/channel/simple/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)】 |
| pageNumber | false | Integer | 页码，默认为1 |
| pageSize | false | Integer | 每页数据大小，默认每页显示10条数据，最大值不能超过1000 |
| categoryId | false | String | 所属分类id |
| watchStatus | false | String | 观看页状态筛选
live：直播中
playback：回放中
end：已结束
waiting：等待中
unStart：未开始
|
| keyword | false | String | 频道名称，模糊查询 |
| orderBy | false | String | 排序字段，默认按频道创建时间升序
startTimeDesc：开播时间降序
startTimeAsc：开播时间升序
channelCreatedTimeDesc：频道创建时间降序
|
### 示例
```requestUrl
http://api.polyv.net/live/v4/channel/simple/list?pageNumber=2&watchStatus=unStart&appId=frlr1zazn3&sign=A69559D6EBF130B9C0F60807459FC311&pageSize=3&categoryId=391352×tamp=1642733791590
```
### 响应参数描述
| 参数名 | 类型 | 说明 |
| --------- | ------- | ---------------------------------------- |
| code | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态 |
| status | String | 响应结果，由业务决定，成功返回success，失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见[Error字段描述](#error参数描述)】 |
| data | Object | 【详见[data字段说明](#data参数描述)】 |
### Error参数描述
| 参数名 | 类型 | 说明 |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因 |
| desc | String | 错误描述，与 error.code 对应 |
### Data参数描述
| 参数名 | 类型 | 说明 |
| ---------- | ------- | -------------------------------------- |
| pageNumber | Integer | 当前页码 |
| pageSize | Integer | 每页数据量 |
| totalPages | Long | 页面总数 |
| totalItems | Long | 总数据量 |
| contents | Array | 当前页内容【详见[contents字段说明](#contents参数描述)】 |
### Contents参数描述
| 参数名 | 类型 | 说明 |
| --------------- | ------ | ------------------------------------------------------------------------------------------------ |
| channelId | String | 频道号 |
| name | String | 频道名称 |
| channelPasswd | String | 频道密码 |
| categoryId | String | 直播分类id |
| scene | String | 场景
alone：活动直播
ppt：三分屏
topclass：大班课
seminar：研讨会
|
| watchStatus | String | 观看页状态描述
直播中
回放中
已结束
等待中
未开始
已禁播
|
| watchStatusText | String | 观看页状态
live：直播中
playback：回放中
end：已结束
waiting：等待中
unStart：未开始
banpush：已禁播
|
| sceneText | String | 场景描述 |
| watchUrl | String | 观看页链接 |
### 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 testChannelSimpleList() 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/v4/channel/simple/list";
String keyword = "测试";
String categoryId = "391352";
String watchStatus = "unStart";
String pageNumber = "2";
String pageSize = "3";
Map requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("categoryId", categoryId);
requestMap.put("watchStatus", watchStatus);
requestMap.put("pageNumber", pageNumber);
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",
"requestId": "92a918d76e7246599d1aad24a253a470.1842.16427336349010109",
"data": {
"pageNumber": 2,
"pageSize": 3,
"totalPages": 2,
"totalItems": 4,
"contents": [
{
"channelId": 2775591,
"name": "gateway 从入门到精通",
"channelPasswd": "ZM0h81",
"categoryId": 391352,
"scene": "seminar",
"newScene": "seminar",
"template": "seminar",
"watchStatus": "unStart",
"watchStatusText": "未开始",
"sceneText": "研讨会",
"watchUrl": "https://live.polyv.cn/watch/2775591"
}
]
},
"success": true
}
```
异常示例
```json
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://polyv.gitbook.io/document/docs/live/api/v-4/channel/operate/channel_simple_list.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.