# 查询报名观看记录

### 接口描述

```
1、查询报名观看记录
2、接口支持https协议
```

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/enroll/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)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/enroll/list?appId=frlr1zazn3&sign=68A98C385C45853A5C273D2145575BC5&channelId=2453970&timestamp=1629969811503
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                   |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/watch_condition/enroll_list.md?id=data%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### data字段描述

| 参数名          | 类型     | 说明                                                                                                                                                                            |
| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| auditEnabled | String | <p>频道报名审核开关<br>Y：开启<br>N：关闭</p>                                                                                                                                               |
| list         | Array  | 报名观看记录【详见[list字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/watch_condition/enroll_list.md?id=list%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### list字段描述

| 参数名         | 类型     | 说明                                                                                                                                                                              |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| viewerId    | String | 观众ID                                                                                                                                                                            |
| mobile      | String | 手机号                                                                                                                                                                             |
| createTime  | Long   | 报名时间，13位毫秒级时间戳                                                                                                                                                                  |
| hasWatched  | String | <p>是否已观看<br>Y：是<br>N：否</p>                                                                                                                                                      |
| promoteId   | String | 推广渠道ID                                                                                                                                                                          |
| promoteName | String | 推广渠道名称                                                                                                                                                                          |
| auditStatus | String | <p>审核结果<br>W：未审核<br>P：已通过<br>F：已拒绝</p>                                                                                                                                          |
| fields      | Array  | 报名信息【详见[fields字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/watch_condition/enroll_list.md?id=fields%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### fields字段描述

| 参数名   | 类型     | 说明     |
| ----- | ------ | ------ |
| name  | String | 报名信息名称 |
| value | 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(ChannelOperateTestLive.class);
/**
 * 查询报名观看记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void enrollTest() 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/enroll/list";
    String channelId = "2453970";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    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": {
        "auditEnabled": "N",
        "list": [{
            "viewerId": "1628213504323",
            "mobile": "133",
            "createTime": 1628213514000,
            "hasWatched": "N",
            "promoteId": null,
            "promoteName": null,
            "auditStatus": "P",
            "fields": [{
                "name": "邮箱",
                "value": ""
            }, {
                "name": "1518406",
                "value": "ces"
            }, {
                "name": "姓名",
                "value": "liiii"
            }, {
                "name": "手机号码",
                "value": "133"
            }]
        }]
    }
}
```

异常示例

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