Query Red Packet Distribution Statistics

Updated: 2022-09-02 18:08:07

API Description

1、分页查询频道红包派发数据统计
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/red-pack/statistics/list

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be saved or used directly on the client side. 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	String	Channel ID
sessionId	false	String	Session ID
startTime	false	Long	Start time, 13-digit millisecond timestamp
endTime	false	Long	End time, 13-digit millisecond timestamp
pageNumber	false	Integer	Current page number
pageSize	false	Integer	Number of items per page, default 10, maximum 1000

Example

http://api.polyv.net/live/v4/channel/red-pack/statistics/list?appId=frlr1zazn3&sign=DB56D548F941C73F5A1335D255FE7697&sessionId=g8h352spmc&channelId=2812610&timestamp=1649381825368

Response Parameter 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 the business. 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	See data field description

Error Parameter Description

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

data Parameter Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Number of items per page
totalPages	Long	Total number of pages
totalItems	Long	Total number of items
contents	Array	Content of the current page See contents field description

contents Parameter Description

Parameter	Type	Description
redPackId	String	Red packet ID
userId	String	User WeChat OPENID
channelId	String	Channel ID
nickName	String	Nickname
amount	Float	Red packet amount
balance	Float	Red packet balance
allotType	String	Allocation method name: Random allocation red packet Equal allocation red packet
createdTime	Long	Creation time, 13-digit millisecond timestamp
status	String	Status name: In progress Ended Refunding Refunded
redPackType	String	Red packet type name: Red packet rain Password red packet Normal red packet
redPackReceiveList	Array	List of users who received See receive field description

receive Parameter Description

Parameter	Type	Description
redPackId	String	Red packet ID
userId	String	User WeChat OPENID
nickName	String	Nickname
avatar	String	Avatar
amount	Float	Amount received (two decimal places)
createdTime	Long	Time received, 13-digit millisecond timestamp

Java Request Example

For quick integration of the base 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. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API 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 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
        
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API