# 查询频道抽奖记录

旧版接口地址[查询频道抽奖记录(旧版)](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/list_lottery/README.md)

### 接口描述

```
1、查询频道发起抽奖记录
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/channel/lottery/list
```

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

### 请求方式

```
GET
```

### 接口约束

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

2、不传lotteryId抽奖Id时，startTime、endTime必传

3、传入lotteryId抽奖Id时，startTime、endTime可不传，即使传了也不生效

4、startTime、endTime查询时间跨度最大为365天

### 请求参数描述

| 参数名        | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ---------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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  | 频道号                                                                                                                                                                                                       |
| lotteryId  | false | String  | 抽奖ID                                                                                                                                                                                                      |
| sessionId  | false | String  | 场次ID                                                                                                                                                                                                      |
| startTime  | false | Long    | 开始时间，13位毫秒级时间戳                                                                                                                                                                                            |
| endTime    | false | Long    | 结束时间，13位毫秒级时间戳                                                                                                                                                                                            |
| pageNumber | false | Integer | 当前页数                                                                                                                                                                                                      |
| pageSize   | false | Integer | 每页数据大小，默认10条数据，最大1000条                                                                                                                                                                                    |

### 示例

```requestUrl
http://api.polyv.net/live/v4/channel/lottery/list?appId=frlr1zazn3&sign=CD02AC6E60EE047E7B491C8CB32D23AD&startTime=1629679376000&endTime=1661215376000&channelId=2974342&timestamp=1661480931047
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| 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参数描述

| 参数名          | 类型      | 说明                                             |
| ------------ | ------- | ---------------------------------------------- |
| winnerCount  | Integer | 实际中奖人数                                         |
| totalUsers   | Integer | 参与抽奖的人数                                        |
| lotteryId    | String  | 抽奖场次ID                                         |
| channelId    | Integer | 频道号                                            |
| userId       | String  | 账号userId                                       |
| sessionId    | String  | 抽奖时的直播场次ID                                     |
| lotteryRange | String  | 抽奖候选人范围                                        |
| actor        | String  | 按头衔抽奖时的头衔名称                                    |
| prize        | String  | 奖品名称                                           |
| amount       | Integer | 中奖人数                                           |
| preset       | String  | 预设中奖者，以英文逗号隔开                                  |
| lotteryExt   | Object  | 抽奖的额外拓展信息【详见[lotteryExt字段说明](#lotteryExt参数描述)】 |
| createdTime  | Long    | 抽奖时间，十三位时间戳                                    |

#### lotteryExt参数描述

| 参数名         | 类型    | 说明           |
| ----------- | ----- | ------------ |
| collectInfo | Array | 中奖用户领奖收集信息列表 |

#### collectInfo参数描述

| 参数名   | 类型     | 说明   |
| ----- | ------ | ---- |
| field | String | 字段名称 |
| tips  | 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(getClass());
/**
 * 查询频道中奖统计记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getLotteryListTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/lottery/list";
    String channelId = "2974342";
    String lotteryId = "gcfflpd4ex";
    String sessionId = "";
    String startTime = "";
    String endTime = "";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("lotteryId", lotteryId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    
    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": "c4a7fb9af5624cbabeb47a4d04c4e13b.72.16614809866840885",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "winnerCount": 2,
                "totalUsers": 11,
                "lotteryId": "gcfflpd4ex",
                "channelId": 2974342,
                "userId": "1b448be323",
                "sessionId": "gcfd814thr",
                "lotteryRange": "all",
                "actor": null,
                "prize": "一等奖",
                "amount": 3,
                "preset": "",
                "lotteryExt": {
                    "collectInfo": [
                        {
                            "field": "姓名：",
                            "tips": "请输入您的真实姓名"
                        },
                        {
                            "field": "手机：",
                            "tips": "请输入您的手机号码"
                        }
                    ]
                },
                "createdTime": 1660022052000
            }
        ]
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "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/statistics/lottery_list.md?ask=<question>
```

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.