Paginated Query of Channel Tip Records

Updated: 2025-11-28 16:12:11

Interface Description

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

Interface URL

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

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details
If parameters are incorrect, a 400 exception will be returned.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining secret key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-digit uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	Integer	Channel ID
pageNumber	false	Integer	Page number for pagination
pageSize	false	Integer	Page size (maximum 300)
start	true	Long	Query start time, 13-digit timestamp
end	true	Long	Query end time, 13-digit timestamp

Example

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

Response Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 See Error field description
data	Object	Detailed response information See data field description

Error Response Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

data Response Description

Parameter	Type	Description
pageNumber	String	Page number
pageSize	Integer	Page size
totalPages	String	Total number of pages
totalItems	String	Total number of records
contents	Array	Statistics list information [See contents response description]

contents Response Description

Parameter	Type	Description
userId	Long	User ID
nickName	String	User nickname
timeStamp	Long	Tip time, timestamp
name	String	Name of the tip
type	String	Tip type (Cash: 2, Props/Points: 1)
amount	BigDecimal	Tip amount
sessionId	String	Corresponding live session ID

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "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
}

Error Example

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

Live Streaming Server API