# 查询频道中奖记录

### 接口描述

```
1、通过抽奖ID获取频道的单场抽奖的中奖用户列表
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/lottery/get-winner-detail
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/lottery/get-winner-detail/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  | 频道号                                                                                                                                                                                                       |
| lotteryId | true  | String  | 抽奖ID，该参数获取自【[查询频道抽奖记录](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/v4/channel/statistics/lottery_list/README.md)】                                                            |
| page      | false | Integer | 查询的页数，默认为1                                                                                                                                                                                                |
| limit     | false | Integer | 查询的每页大小，默认为10                                                                                                                                                                                             |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/lottery/get-winner-detail?appId=frlr1zazn3&sign=A53A9A7DB3B88442E3F433F8219C1029&channelId=2191532&timestamp=1621844963404&lotteryId=fwqs12puef
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                         |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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/live_interaction/get_winner_detail.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名            | 类型      | 说明                                                                                                                                                                                               |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| pageSize       | Integer | 当前数据页数                                                                                                                                                                                           |
| pageNumber     | Integer | 当前的页数                                                                                                                                                                                            |
| totalItems     | Integer | 总记录数                                                                                                                                                                                             |
| contents       | Array   | 中间记录列表 抽奖记录列表 【详见[contents字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/get_winner_detail.md?id=contents%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |
| firstPage      | Boolean | 是否为第一页，值为：true/false                                                                                                                                                                             |
| lastPage       | Boolean | 是否为最后一页，值为：true/false                                                                                                                                                                            |
| nextPageNumber | Integer | 下一页编号                                                                                                                                                                                            |
| prePageNumber  | Integer | 上一页编号                                                                                                                                                                                            |
| totalPages     | Integer | 总页数                                                                                                                                                                                              |
| startRow       | Integer | 当前页第一条记录在总记录中的位置                                                                                                                                                                                 |
| endRow         | Integer | 当前页最后一个记录在总记录中的位置                                                                                                                                                                                |
| limit          | Integer | 当前页记录个数                                                                                                                                                                                          |
| offset         | Integer | 分页数据游标                                                                                                                                                                                           |

#### contents字段说明

| 参数名          | 类型     | 说明                                                                                                                                                                                                                                     |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| recordId     | String | 中奖记录ID                                                                                                                                                                                                                                 |
| channelId    | String | 频道号                                                                                                                                                                                                                                    |
| sessionId    | String | 抽奖时的直播场次ID                                                                                                                                                                                                                             |
| lotteryId    | String | 抽奖ID                                                                                                                                                                                                                                   |
| viewerId     | String | 中奖用户ID                                                                                                                                                                                                                                 |
| viewerName   | String | 中奖用户昵称                                                                                                                                                                                                                                 |
| winnerCode   | String | 中奖码                                                                                                                                                                                                                                    |
| prize        | String | 奖品名称                                                                                                                                                                                                                                   |
| name         | String | 中奖人姓名                                                                                                                                                                                                                                  |
| telephone    | String | 手机号                                                                                                                                                                                                                                    |
| createdTime  | Long   | 中奖时间                                                                                                                                                                                                                                   |
| lastModified | Long   | 更新时间                                                                                                                                                                                                                                   |
| address      | String | 中奖人地址                                                                                                                                                                                                                                  |
| param4       | String | 自定义参数                                                                                                                                                                                                                                  |
| param5       | String | 自定义参数                                                                                                                                                                                                                                  |
| userId       | String | 账号Id                                                                                                                                                                                                                                   |
| ext          | String | json 格式的字符串,表示中奖记录的额外拓展信息，对应模型类：[WinnerRecordModelExt字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/get_winner_detail.md?id=WinnerRecordModelExt%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E) |

#### WinnerRecordModelExt字段说明

说明：中奖记录的拓展信息

| 字段          | 类型及范围 | 说明                                                                                                                                                                                                                          |
| ----------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| receiveInfo | Array | 领奖人需要填写的兑奖信息，对应模型类：[ReceiveInfoFieldModel字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/get_winner_detail.md?id=ReceiveInfoFieldModel%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E) |

#### ReceiveInfoFieldModel字段说明

说明：中奖记录填写的领奖信息

| 字段    | 类型     | 说明     |
| ----- | ------ | ------ |
| field | 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(LiveInteractionTest.class);

/**
 * 依查询频道场次中奖记录
 * @throws IOException
 */
@Test
public void testGetWinnerDetail() 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/lottery/get-winner-detail";
    String channelId = "1965681";
    String lotteryId = "fv3hogjmh3";

    //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("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": {
		"pageSize": 10,
		"pageNumber": 1,
		"totalItems": 1,
		"contents": [{
			"recordId": "b20c0e091d",
			"channelId": 1965681,
			"lotteryId": "fv3hogjmh3",
			"sessionId": "fv3hmq3qml",
			"viewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
			"viewerName": "王勋",
			"winnerCode": "wMpUjVSi",
			"prize": "10元现金红包",
			"name": null,
			"telephone": null,
			"createdTime": 1611127338000,
			"lastModified": 1611127338000,
			"address": null,
			"param4": "oi_ubsz8bujEA8TXdMzPpAxbC0ZI",
			"param5": null,
			"userId": "1b448be323",
			"ext": null
		}],
		"startRow": 1,
		"firstPage": true,
		"lastPage": true,
		"prePageNumber": 1,
		"limit": 1,
		"totalPages": 1,
		"nextPageNumber": 1,
		"endRow": 1,
		"offset": 0
	}
}
```

异常示例

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