查询红包派发数据统计
更新时间: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
}
