分頁查詢頻道打賞記錄

更新時間：2025-11-28 16:12:11

介面描述

1、分页查询频道打赏记录
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/reward/gift-list

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看 2、若參數不正確則會回應400異常

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	Integer	頻道號
pageNumber	false	Integer	分頁頁碼
pageSize	false	Integer	分頁大小(最大不超過300)
start	true	Long	查詢的開始時間，13位時間戳
end	true	Long	查詢的結束時間，13位時間戳

範例

http://api.polyv.net/live/v4/channel/reward/gift-list?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342&pageNumber=1&start=1676274217000&end=1740107338672

回應描述

參數名	類型	說明
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	String	分頁頁碼
pageSize	Integer	分頁大小
totalPages	String	總頁數
totalItems	String	總記錄數
contents	Array	統計列表資訊【詳見contents回應描述】

contents回應描述

參數名	類型	說明
userId	Long	使用者ID
nickName	String	使用者暱稱
timeStamp	Long	打賞時間，時間戳
name	String	打賞的名稱
type	String	打賞類型（現金：2，道具/積分：1）
amount	BigDecimal	打賞數額
sessionId	String	對應的直播場次號

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 getChannelRewardListTest() 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/reward/gift-list";
    Integer channelId = 3385357;
    Long start = 1676274217000;
    Long end = 1740107338672;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "" + channelId);
    requestMap.put("start", "" + start);
    requestMap.put("end", "" + end);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试分页查询频道打赏记录成功：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "f46e79d6c5a94dcc9a40de76a8ffa777.74.17306917836670585",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 3,
    "contents": [
      {
        "userId": "aaaaaa",
        "nickName": "昵称",
        "timestamp": 1740107338672,
        "name": "道具名称",
        "type": "1",
        "sessionId": "9iusjds9is",
        "amount": 6.66
      },
      {
        "userId": "nnnnnn",
        "nickName": "昵称2",
        "timestamp": 1740107338672,
        "name": "现金",
        "type": "2",
        "sessionId": "9iusjds9is",
        "amount": 8.66
      }
    ]
  },
  "success": true
}

異常範例

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