查詢帳號收入詳情
更新時間:2022-09-23 10:07:04
介面描述
1、接口URL中的{userId}为直播账号ID
2、根据是否提交channelId来查询账号收入详细信息
3、接口支持https协议
介面URL
http://api.polyv.net/live/v2/user/{userId}/get-income-detail
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| startDate | true | String | 查詢的開始日期 格式為yyyy-MM-dd |
| endDate | true | String | 查詢的結束日期 格式為yyyy-MM-dd |
| channelId | false | String | 要查詢的頻道號,不提交或傳0則查詢所有頻道 |
| page | false | Integer | 頁碼,不提交預設為1 |
| pageSize | false | Integer | 每頁資料大小,不提交預設為12 |
範例
http://api.polyv.net/live/v2/user/{userId}/get-income-detail
表單參數:
endDate=2021-12-11&appId=frlr1zazn3&sign=4EFC44F3108FA3DAF0DF1578E9DE49A4&pageSize=20&page=1&startDate=2019-11-24&channelId=1965681×tamp=1621844561516
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 回應成功時返回收入詳情資訊【詳見data欄位說明】 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁顯示的記錄數,不提交預設為12 |
| pageNumber | Integer | 目前頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表,收入詳情【詳見Contents參數描述】 |
| startRow | Integer | 目前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false,預設為false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false,預設為false |
| prePageNumber | Integer | 上一頁編號 |
| limit | Integer | 每頁數量大小 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 目前頁最後一筆記錄在總結果集中的位置 |
| nextPageNumber | Integer | 下一頁編號 |
| offset | Integer | 分頁起始記錄 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| userId | String | POLYV使用者ID,和保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| amount | Float | 金額,單位元 |
| goodNum | Integer | 道具打賞數量 |
| channelId | String | 頻道號 |
| payType | String | 收入類型 cash:現金打賞 pay:付費觀看 good:道具打賞(現金禮物) point:積分打賞(積分禮物) |
| payTypeName | String | 收入類型的名稱:道具打賞(現金禮物)、現金打賞、付費觀看、積分打賞(積分禮物) |
| viewerName | String | 付費觀眾暱稱 |
| payTime | Long | 付費時間,13位毫秒級時間戳記 |
| weixinAppId | String | 微信公眾號AppId |
| outTradeNo | String | 保利威視系統內部訂單號 |
| openId | String | 公眾號下使用者唯一識別碼openId |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
* 查询账号收入详情
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetIncomeDetail() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url=String.format("http://api.polyv.net/live/v2/user/%s/get-income-detail",userId);
String startDate="2019-11-24";
String endDate="2021-12-11";
String channelId="1965681";
String page=String.valueOf(1);
String pageSize=String.valueOf(20);
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("startDate", startDate);
requestMap.put("endDate", endDate);
requestMap.put("channelId", channelId);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试查询账号收入详情,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":{
"pageSize":20,
"pageNumber":1,
"totalItems":2,
"contents":[
{
"userId":"1b448be323",
"amount":0.01,
"goodNum":1,
"channelId":1965681,
"payType":"good",
"payTypeName":"道具打赏",
"viewerName":"王勋",
"payTime":1616749953000,
"weixinAppId":"视频直播平台",
"outTradeNo":"4200000986202103266004002654",
"openId":"ovtl9twa7JHyHBBA8QUNVjjM4WIs"
},
{
"userId":"1b448be323",
"amount":0.02,
"goodNum":null,
"channelId":1965681,
"payType":"cash",
"payTypeName":"现金打赏",
"viewerName":"长沙观众/95916",
"payTime":1604911816000,
"weixinAppId":"视频直播平台",
"outTradeNo":"4200000848202011099220088137",
"openId":"ovtl9t5XNOfIGQ5q-MQ5thHRhGjc"
}
],
"startRow":1,
"firstPage":true,
"lastPage":true,
"prePageNumber":1,
"limit":2,
"totalPages":1,
"nextPageNumber":1,
"endRow":2,
"offset":0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
