查詢紅包派發數據統計
更新時間:2022-09-02 18:08:07
介面描述
1、分页查询频道红包派发数据统计
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/red-pack/statistics/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
| sessionId | false | String | 場次ID |
| startTime | false | Long | 開始時間,13位毫秒級時間戳 |
| endTime | false | Long | 結束時間,13位毫秒級時間戳 |
| pageNumber | false | Integer | 當前頁數 |
| pageSize | false | Integer | 每頁資料大小,預設10筆資料,最大1000筆 |
範例
http://api.polyv.net/live/v4/channel/red-pack/statistics/list?appId=frlr1zazn3&sign=DB56D548F941C73F5A1335D255FE7697&sessionId=g8h352spmc&channelId=2812610×tamp=1649381825368
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與http狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Object | 【詳見data欄位說明】 |
Error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與error.code對應 |
data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageNumber | Integer | 當前頁碼 |
| pageSize | Integer | 每頁資料量 |
| totalPages | Long | 頁面總數 |
| totalItems | Long | 總資料量 |
| contents | Array | 當前頁內容【詳見contents欄位說明】 |
contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| redPackId | String | 紅包ID |
| userId | String | 用戶微信OPENID |
| channelId | String | 頻道號 |
| nickName | String | 暱稱 |
| amount | Float | 紅包金額 |
| balance | Float | 紅包餘額 |
| allotType | String | 分配方式名稱: 隨機分配紅包 平均分配紅包 |
| createdTime | Long | 建立時間,13位毫秒級時間戳 |
| status | String | 狀態名稱: 進行中 已結束 退款中 已退款 |
| redPackType | String | 紅包類型名稱: 紅包雨 口令紅包 普通紅包 |
| redPackReceiveList | Array | 領取用戶列表【詳見receive欄位說明】 |
receive參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| redPackId | String | 紅包ID |
| userId | String | 用戶微信OPENID |
| nickName | String | 暱稱 |
| avatar | String | 頭像 |
| amount | Float | 領取金額(小數點後兩位) |
| createdTime | Long | 領取時間,13位毫秒級時間戳 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼,點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询红包派发数据统计
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getRedPackStatsTest() 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/red-pack/statistics/list";
String channelId = "2812610";
String sessionId = "g8h352spmc";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sessionId", sessionId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询红包派发数据统计成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "15c37b3457b14f2894af4e7dd6d5ea77.62.16493818293256929",
"data":
{
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"redPackId": "500e6f9f47bd42369aac8a9fc259f6d4",
"userId": "ovtl9t44bqXDfubCAAAAAB5ImaeQ",
"channelId": 2812610,
"nickName": "讲师",
"amount": 0.98,
"balance": 0.00,
"allotType": "随机分配红包",
"createdTime": 1648867234000,
"channelSessionId": "g8h352spmc",
"status": "已结束",
"redPackType": "普通红包",
"redPackReceiveList": [
{
"redPackId": "500e6f9f47bd42369aac8a9fc259f6d4",
"userId": "ovtl9tAAAAAHBBA8QUNVjjM4WIs",
"nickName": "神经蛙",
"avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM48yCrkV6bNEauNqC60hZJ38eZkVt5YBiasWbq4MA9I5kgs6Oodicc5vpXSICosTibybCT5mgibhIwCNA/132",
"amount": 0.41,
"createdTime": 1648867252000
},
{
"redPackId": "500e6f9f47bd42369aac8a9fc259f6d4",
"userId": "ovtl9t44bqXDfubCAAAAAB5ImaeQ",
"nickName": "xxx",
"avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/9ZbIC7NmVzhwIIJq18UJd8ph0vXuPnJaAaCX3tbW8IKeWyf1QmoycWPeg4OhiaVOZ6xNy2xK4jVWKSibhgTnmicUA/132",
"amount": 0.57,
"createdTime": 1648867267000
}]
}]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
