# 查询观众中奖记录

### 接口描述

```
1、查询观众中奖记录
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/channel/lottery/query-winner-viewer
```

### 请求方式

```
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 | String | 频道号                                                                                                                                                                                                       |
| lotteryId | true | String | 抽奖ID                                                                                                                                                                                                      |
| viewerId  | true | String | 观众ID                                                                                                                                                                                                      |

### 示例

```requestUrl
http://api.polyv.net/live//v4/channel/lottery/query-winner-viewer?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342&lotteryId=g9pf1atsa3&viewerId=ovtl9twa7JHyHBBA8QUNVjjM4WIs
```

### 响应参数描述

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

| 参数名          | 类型      | 说明                                 |
| ------------ | ------- | ---------------------------------- |
| recordId     | String  | 中奖记录ID                             |
| channelId    | Integer | 频道号                                |
| lotteryId    | String  | 抽奖ID                               |
| sessionId    | String  | 抽奖时的直播场次ID                         |
| viewerId     | String  | 观众ID                               |
| viewerName   | String  | 观众昵称                               |
| winnerCode   | String  | 中奖码                                |
| prize        | String  | 奖品名称                               |
| name         | String  | 中奖人姓名                              |
| telephone    | String  | 中奖人联系方式                            |
| createdTime  | Long    | 创建时间，可表示中奖时间，13位毫秒级时间戳             |
| lastModified | Long    | 更新时间，13位毫秒级时间戳                     |
| address      | String  | 中奖人地址                              |
| ext          | Object  | 中奖记录的额外拓展信息【详见[ext字段说明](#ext参数描述)】 |
| param4       | String  | 用户自定义参数，在直接授权观看条件或独立授权时可能带过来的参数    |
| param5       | String  | 用户自定义参数，在直接授权观看条件或独立授权时可能带过来的参数    |
| userId       | String  | 账号ID                               |
| avatar       | String  | 头像                                 |
| totalUsers   | Integer | 参与抽奖的总人数                           |

#### ext参数描述

| 参数名         | 类型    | 说明                                                 |
| ----------- | ----- | -------------------------------------------------- |
| receiveInfo | Array | 中奖记录的额外拓展信息【详见[receiveInfo字段说明](#receiveInfo参数描述)】 |

#### receiveInfo参数描述

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

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "code": 200,
    "status": "success",
    "requestId": "fc0894ce-08df-4376-92e2-fd0531cbe8ba",
    "data": {
        "recordId": "22ad8e0518",
        "channelId": 2974342,
        "lotteryId": "g9pf1atsa3",
        "sessionId": "g9pf13d8bo",
        "viewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
        "viewerName": "神经蛙",
        "winnerCode": "OOf6jo74",
        "prize": "百万   大礼包",
        "name": null,
        "telephone": null,
        "createdTime": 1652341190000,
        "lastModified": 1652341226000,
        "address": null,
        "ext": {
            "receiveInfo": [
                {
                    "field": "姓名：",
                    "value": "我"
                },
                {
                    "field": "手机：",
                    "value": "18888888888"
                }
            ]
        },
        "param4": "oi_ubsz8bujEA8TXdMzPpAxbC0ZI",
        "param5": null,
        "userId": "1b448be323",
        "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM48yCrkV6bNEauNqC60hZJ38eZkVt5YBiasWbq4MA9I5kgs6Oodicc5vpXSICosTibybCT5mgibhIwCNA/132",
        "totalUsers": 2
    },
    "success": true
}
```

异常示例

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

中奖记录不存在

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d29944cb-66ac-4694-a844-5ec619e17abd",
    "error": {
        "code": 40031,
        "desc": "中奖记录不存在"
    },
    "data": null,
    "success": false
}
```
