查询红包派发数据统计
接口描述
接口URL
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
appId
true
String
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
channelId
true
String
频道号
sessionId
false
String
场次ID
startTime
false
Long
开始时间,13位毫秒级时间戳
endTime
false
Long
结束时间,13位毫秒级时间戳
pageNumber
false
Integer
当前页数
pageSize
false
Integer
每页数据大小,默认10条数据,最大1000条
示例
响应参数描述
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
error
Object
data
Object
Error参数描述
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
data参数描述
pageNumber
Integer
当前页码
pageSize
Integer
每页数据量
totalPages
Long
页面总数
totalItems
Long
总数据量
contents
Array
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参数描述
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请求线程池进行了统一封装和优化。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
Last updated
Was this helpful?