# 查询直播分类

### 接口描述

```
1、查询直播分类信息
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/user/category/list
```

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

### 请求方式

```
POST
```

### 接口约束

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)】 |

### 示例

```requestUrl
http://api.polyv.net/live/v3/user/category/list
```

表单参数：

```requestUrl
appId=frlr1zazn3&sign=1ECD804DCC62E9CB011FA9477F4075DC&timestamp=1621841365623
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                              |
| ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| 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    | Array   | 响应成功时返回直播分类信息的数组【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/account/get_category_list.md?id=polyv1)】 |

**Data参数描述**

| 参数名          | 类型      | 说明                                       |
| ------------ | ------- | ---------------------------------------- |
| categoryId   | String  | 频道分类id                                   |
| categoryName | String  | 分类名称                                     |
| userId       | String  | POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置） |
| rank         | Integer | 分类排序号，rank=0表示为默认排序                      |

### 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(AccountTest.class);
/**
 * 查询直播分类
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetCategoryList() 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/user/category/list";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(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":[
        {
            "categoryId":340019,
            "categoryName":"默认分类",
            "userId":"1b448be323",
            "rank":0
        },
        {
            "categoryId":345134,
            "categoryName":"分类234",
            "userId":"1b448be323",
            "rank":2
        },
        {
            "categoryId":345111,
            "categoryName":"测试分类",
            "userId":"1b448be323",
            "rank":3
        },
        {
            "categoryId":360879,
            "categoryName":"分类23411",
            "userId":"1b448be323",
            "rank":4
        }
    ]
}
```

异常示例

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