取得觀眾列表
更新時間:2024-04-22 19:18:32
介面描述
1、分页获取观众列表
2、接口支持https协议
介面URL
https://api.polyv.net/live/v4/user/viewer-record/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| source | false | String | 來源(IMPORT:匯入,WX:微信;MOBILE:手機) |
| mobile | false | String | 手機號碼 |
| false | String | 電子郵件 | |
| area | false | String | 地址 |
| pageSize | false | String | 頁面大小(預設10,最大1000) |
| pageNumber | false | Integer | 頁碼(目前限制最大值1000頁) |
請求範例
https://api.polyv.net/v4/user/viewer-record/list?appId=frlr1zazn3×tamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&mobile=demoData
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗 |
| status | String | 回應結果,由業務決定,成功返回success,失敗返回error |
| success | Boolean | 回應結果,由業務決定,成功返回true,失敗返回false |
| data | Object | 分頁使用者資訊【詳見Data欄位說明】 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位說明】 |
| requestId | String | 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應與業務掛鉤 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 頁面大小 |
| totalPages | String | 剩餘頁碼 |
| totalItems | Boolean | 剩餘記錄數 |
| contents | Array | 觀眾資訊列表【詳見contents欄位說明】 |
| requestId | String | 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應與業務掛鉤 |
Contents參數描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| 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 | 使用者來源(IMPORT:匯入) |
| name | false | String | 採集姓名 |
| lastCollectMobile | false | String | 採集手機號碼 |
| false | String | 電子郵件 | |
| area | false | String | 地址 |
| latestAccessIp | false | String | 最後訪問IP |
| device | false | String | 裝置 |
| watchDuration | false | Integer | 觀看時長 |
| watchChannelCount | false | Integer | 觀看頻道數 |
| latestAuthTime | true | timestamp | 最後授權時間 |
| createTime | true | timestamp | 建立時間 |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
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 mobile = "demoData";
//业务参数
String url = "https://api.polyv.net/v4/user/viewer-record/list";
//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
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "5b33d00b-d284-4a3d-adcd-38210f8681c8",
"data": {
"pageSize": 5,
"totalPages": 2,
"totalItems": 10,
"contents": [
{
"name": "demoData",
"lastCollectMobile": "demoData",
"email": "demoData",
"area": "demoData",
"latestAccessIp": "demoData",
"device": "demoData",
"watchDuration": 0,
"watchChannelCount": 0,
"viewerUnionId": "2_2v0u6u75hw013ja684ba9co7lnppq4j9",
"mobile": "demoData9",
"source": "IMPORT",
"createTime": 1712114619000
},
{
"name": "demoData",
"lastCollectMobile": "demoData",
"email": "demoData",
"area": "demoData",
"latestAccessIp": "demoData",
"device": "demoData",
"watchDuration": 0,
"watchChannelCount": 0,
"viewerUnionId": "2_x4r3er86b6h539o4clna3ss39xg3c169",
"mobile": "demoData8",
"source": "IMPORT",
"createTime": 1712114608000
},
{
"name": "demoData",
"lastCollectMobile": "demoData",
"email": "demoData",
"area": "demoData",
"latestAccessIp": "demoData",
"device": "demoData",
"watchDuration": 0,
"watchChannelCount": 0,
"viewerUnionId": "2_9965885141of3ec157yq69yf75xrt108",
"mobile": "demoData7",
"source": "IMPORT",
"createTime": 1712114586000
},
{
"name": "demoData",
"lastCollectMobile": "demoData",
"email": "demoData",
"area": "demoData",
"latestAccessIp": "demoData",
"device": "demoData",
"watchDuration": 0,
"watchChannelCount": 0,
"viewerUnionId": "2_2g0be0h9p6cd0777zq022yvze4a968bk",
"mobile": "demoData6",
"source": "IMPORT",
"createTime": 1712114565000
},
{
"name": "demoData",
"lastCollectMobile": "demoData",
"email": "demoData",
"area": "demoData",
"latestAccessIp": "demoData",
"device": "demoData",
"watchDuration": 0,
"watchChannelCount": 0,
"viewerUnionId": "2_y5t681288v0316n8z932el5d28w1ka2n",
"mobile": "demoData5",
"source": "IMPORT",
"createTime": 1712114550000
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
