查询多个频道抽奖记录
更新时间:2022-09-27 11:32:05
接口描述
1、获取一段时间内的多个直播频道发起抽奖记录列表
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/lottery/list-channels-lottery
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelIds | true | String | 频道号,多个频道使用“,”进行分割 |
| startTime | true | Long | 查询的开始日期的13位时间戳 |
| endTime | true | Long | 查询的结束日期的13位时间戳 |
| sessionId | false | String | 要查询的直播场次ID,默认查询该频道中所有场次 |
| page | false | Integer | 查询的页数,默认为1 |
| limit | false | Integer | 查询的每页大小,默认为10 |
示例
http://api.polyv.net/live/v3/channel/lottery/list-lottery?appId=frlr1zazn3&sign=CFD9DDABAD30A5F2CFA1E1FCD26E2FC7&startTime=1615772426000&endTime=1615773566000&channelId=2191532,2383918×tamp=1621844928632
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 抽奖记录的分页结果 【详见data字段说明】 |
data字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageSize | Integer | 总页数 |
| pageNumber | Integer | 当前的页数 |
| totalItems | Integer | 总记录数 |
| contents | List<LotteryListModel> | 抽奖记录列表 【详见contents字段说明】 |
| offset | Integer | 分页起始记录 |
| limit | Integer | 当前页记录个数 |
| nextPageNumber | Integer | 下一页编号 |
| startRow | Integer | 当前页第一条记录在总记录中的位置 |
| lastPage | Boolean | 是否为最后一页,值为:true/false |
| prePageNumber | Integer | 上一页编号 |
| firstPage | Boolean | 是否为第一页,值为:true/false |
| totalPages | Integer | 总页数 |
| endRow | Integer | 当前页最后一个记录在总记录中的位置 |
contents字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| lotteryId | String | 抽奖场次ID |
| channelId | String | 频道号 |
| sessionId | String | 抽奖时的直播场次ID |
| userId | String | 账号userId |
| lotteryRange | String | 抽奖范围 all:所有观众 notWinning:当场直播未中奖用户 signed:已签到用户 actor:头衔 questionnaire:已填问卷用户 |
| actor | String | 抽奖范围为按头衔抽奖时的头衔 |
| prize | String | 奖品名称 |
| amount | Integer | 预设中奖人数 |
| preset | String | 预设中奖观众ID,多个ID 用英文逗号分开 |
| createdTime | Long | 抽奖时间 |
| lastModified | Long | 最后修改时间 |
| winnerCount | String | 实际中奖人数 |
| ext | String | json 格式的字符串,表示抽奖的额外拓展信息,对应模型类:LotteryListModelExt字段说明 |
LotteryListModelExt字段说明
说明:抽奖记录的拓展信息
| 字段 | 类型 | 说明 |
|---|---|---|
| collectInfo | Array | 领奖人需要填写的兑奖信息,对应模型类:CollectInfoFieldModel字段说明 |
CollectInfoFieldModel字段说明
说明:领奖人需要填写的领奖信息
| 字段 | 类型及范围 | 说明 |
|---|---|---|
| field | String | 填写的字段名 |
| tips | String | 填写的字段提示 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
* 查询频道中奖记录
* @throws IOException
*/
@Test
public void testListLottery() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId=super.appId;
String appSecret=super.appSecret;
String userId = super.userId;
String timestamp=String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/lottery/list-channels-lottery";
String channelId = "1965681,2383918";
String startTime = "1601481600000";
String endTime = "1615357743000";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("startTime",startTime);
requestMap.put("endTime",endTime);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url,requestMap);
log.info("测试查询频道中奖记录接口返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalItems": 2,
"contents": [{
"lotteryId": "fv3mao43u6",
"channelId": 1965681,
"userId": "1b448be323",
"sessionId": "fv3ma84e63",
"lotteryRange": "all",
"actor": null,
"prize": "特等奖",
"amount": 1,
"preset": "",
"createdTime": 1611137383000,
"lastModified": 1611137383000,
"ext": "{\"collectInfo\":[{\"field\":\"姓名:\",\"tips\":\"请输入您的真实姓名\"},{\"field\":\"手机:\",\"tips\":\"请输入您的手机号码\"}]}",
"winnerCount": "0"
}, {
"lotteryId": "fv3hogjmh3",
"channelId": 1965681,
"userId": "1b448be323",
"sessionId": "fv3hmq3qml",
"lotteryRange": "all",
"actor": null,
"prize": "10元现金红包",
"amount": 1,
"preset": "",
"createdTime": 1611127333000,
"lastModified": 1611127333000,
"ext": "{\"collectInfo\":[{\"field\":\"姓名:\",\"tips\":\"请输入您的真实姓名\"},{\"field\":\"手机:\",\"tips\":\"请输入您的手机号码\"}]}",
"winnerCount": "1"
}],
"startRow": 1,
"firstPage": true,
"lastPage": true,
"prePageNumber": 1,
"limit": 2,
"nextPageNumber": 1,
"totalPages": 1,
"endRow": 2,
"offset": 0
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
