# 查询观众详情

### 接口描述

```
1、查询观众详情
2、接口支持https协议
```

### 接口URL

```
https://api.polyv.net/live/v4/user/viewer-record/get
```

### 请求方式

```
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)】 |
| viewerUnionId | true | String | 观众id                                                                                                                                                                                                      |

### 示例

```requestUrl
https://api.polyv.net/v4/user/viewer-record/get?appId=frlr1zazn3&timestamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&viewerUnionId=2_v378gn997yovtl3p8h77db9e224t6hg9
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 响应状态码，200为成功返回，非200为失败                   |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 响应结果，由业务决定，成功返回true，失败返回false            |
| data      | Object  | 观众详细数据【详见[data字段说明](#data参数描述)】          |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段说明](#error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

#### Data参数描述

| 参数名               | 必选    | 类型        | 说明        |
| ----------------- | ----- | --------- | --------- |
| viewerUnionId     | true  | String    | 观众id      |
| wxOpenId          | false | String    | 微信openId  |
| wxUnionId         | false | String    | 微信UnionId |
| wxNickName        | false | String    | 微信昵称      |
| wxAvatar          | false | String    | 微信头像      |
| wxAppId           | false | String    | 微信AppId   |
| mobile            | false | String    | 手机号码      |
| source            | true  | String    | 用户来源      |
| name              | false | String    | 采集姓名      |
| lastCollectMobile | false | String    | 采集手机号码    |
| email             | false | String    | 邮箱        |
| area              | false | String    | 地址        |
| latestAccessIp    | false | String    | 最后访问IP    |
| device            | false | String    | 设备        |
| watchDuration     | false | Integer   | 观看时长      |
| watchChannelCount | false | Integer   | 观看频道数     |
| latestAuthTime    | true  | timestamp | 最后授权时间    |
| createTime        | true  | timestamp | 创建时间      |

### 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 getViewerTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    String viewerUnionId = "2_v378gn997yovtl3p8h77db9e224t6hg9";
    //业务参数
    String url = "https://api.polyv.net/v4/user/viewer-record/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("viewerUnionId", viewerUnionId);
    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": "7bd56e99-3705-4bb0-9834-a0201eebcc4a",
    "data": {
        "name": "demoData",
        "lastCollectMobile": "demoData",
        "email": "demoData",
        "area": "demoData",
        "latestAccessIp": "demoData",
        "device": "demoData",
        "watchDuration": 0,
        "watchChannelCount": 0,
        "viewerUnionId": "2_v378gn997yovtl3p8h77db9e224t6hg9",
        "nickname": "2222",
        "mobile": "3333",
        "wxOpenId": "demoData",
        "wxUnionId": "demoData",
        "wxNickName": "demoData",
        "wxAvatar": "demoData",
        "wxAppId": "demoData",
        "source": "IMPORT",
        "latestAuthTime": 1712054271000,
        "createTime": 1712054270000
    },
    "success": true
}
```

异常示例

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