# 查询分组列表

### 接口描述

```
1、查询分组列表
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/list
```

### 请求方式

```
GET
```

### 接口约束

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

### 请求参数描述

| 参数名        | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ---------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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)】 |
| channelId  | true  | Integer | 频道号                                                                                                                                                                                                       |
| pageNumber | false | Integer | 分页页码                                                                                                                                                                                                      |
| pageSize   | false | Integer | 分页大小                                                                                                                                                                                                      |

### 示例

```requestUrl
http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/list?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342&pageNumber=1
```

### 响应描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| 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 | String  | 分页页码                                        |
| pageSize   | Integer | 分页大小                                        |
| totalPages | String  | 总页数                                         |
| totalItems | String  | 总记录数                                        |
| contents   | Array   | 分组列表信息【详见[Group字段说明](#LotteryActivity响应描述)】 |

#### Group响应描述

| 参数名   | 类型     | 说明   |
| ----- | ------ | ---- |
| id    | Long   | 分组ID |
| title | 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 final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 分组列表查询
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupPage() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        Integer channelId = 4990862;
        Integer pageSize = 10;
        Integer pageNumber = 1;
        //业务参数
        String url = "http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/list";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", channelId);
        requestMap.put("pageSize", pageSize);
        requestMap.put("pageNumber", pageNumber);
        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": "d4343c87-4e31-4813-9b2b-894123dda0ab",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "id": 677,
                "title": "测试测试"
            },
            {
                "id": 678,
                "title": "测试2"
            }
        ]
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```
