获取频道抽奖记录列表(通过直播端发起抽奖)
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/lottery/list-lottery
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
@Test
public void testListLottery() throws Exception, NoSuchAlgorithmException {
LiveListLotteryRequest liveListLotteryRequest = new LiveListLotteryRequest();
LiveListLotteryResponse liveListLotteryResponse;
try {
liveListLotteryRequest.setChannelId(super.createChannel())
.setStartTime(super.getDate(1601481600000l))
.setEndTime(super.getDate(2021,1,21))
.setPageSize(1);
liveListLotteryResponse = new LiveLotteryServiceImpl().listLottery(liveListLotteryRequest);
Assert.assertNotNull(liveListLotteryResponse);
if (liveListLotteryResponse != null) {
//to do something ......
log.debug("测试获取频道抽奖记录列表成功,{}", JSON.toJSONString(liveListLotteryResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
1、请求正确,返回LiveListLotteryResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
每页显示的数据条数,默认每页显示20条数据【对应api文档的limit字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
LotteryListModel参数描述
抽奖范围,取值:所有观众:all;当场直播未中奖用户:notWinning;已签到用户:signed;头衔:actor;已填问卷用户:questionnaire
表示抽奖的额外拓展信息,例:{"collectInfo":[{"field":"姓名:","tips":"请输入您的真实姓名"}]},field表示要填写的字段名,tips表示要填写的字段提示
2、获取频道单场抽奖的中奖记录
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回LiveLotteryWinnerDetailResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
每页显示的数据条数,默认每页显示20条数据【对应api文档的limit字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
LotteryWinnerDetail参数描述
表示抽奖的额外拓展信息,例:{"collectInfo":[{"field":"姓名:","value":"钻石王老五"}]},field表示要填写的字段名,value表示要填写的字段提示
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
2、只能成功保存一次观众中奖信息
3、中奖信息需在7天内提交保存,否则会失效
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
中奖者姓名,如果传姓名,必须传中奖者手机号码,receiveInfo字段不需要传(无效)
中奖者手机号码,如果传手机号,必须传中奖者姓名,receiveInfo字段不需要传(无效)
自定义字段数据,数据类型为数组JSON[{"field":"姓名","value":"测试"},{"field":"手机","value":"13412345678"}] field:字段名称,value:字段值,如果传这个参数,name和telephone字段不需要传(无效)
true为设置成功,false为设置失败
4、导出频道单场抽奖的中奖记录
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回byte[]对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
返回的byte[]可以按照单元测试示例进行保存,也可以自行处理。
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
2、接口内部进行了判断,每个观众的点赞间隔1s的限制,根据提交的观众ID来区分
3、如果有需求支持同时点多个赞,可提交非必填参数times,times最大不能超过30。*如果提交次数为n,则需n-1秒才能继续点赞
4、viewerId由调用端去进行区分用户即可
1、请求正确,返回Integer对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
点赞的数目,不能超过30,提交后在(times-1)秒后才能再点赞
点赞数
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看 viewerId需要是在线的viewerId
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
打赏者ID,通过外部授权等观看方式对接,由B端系统产生,通过百名单进入的,此处可使用会员码
打赏类型,(cash:现金打赏;good:道具打赏)
是否socket消息需要用户图片(是:Y,否:N。不传默认为N)
true为发送成功,false为发送失败
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
2、不传lotteryId抽奖Id时,startTime、endTime必传
3、传入lotteryId抽奖Id时,startTime、endTime可不传,即使传了也不生效
4、startTime、endTime查询时间跨度最大为365天
1、请求正确,返回LiveGetLotteryListResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
页数,默认为1【对应api文档的pageNumber字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
LotteryListContents参数描述
LotteryListExt参数描述
LotteryListExtCollectInfo参数描述
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回LiveListChannelsLotteryResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
每页显示的数据条数,默认每页显示20条数据【对应api文档的limit字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
LotteryListModel参数描述
抽奖范围 all:所有观众 notWinning:当场直播未中奖用户 signed:已签到用户 actor:头衔 questionnaire:已填问卷用户
json 格式的字符串,表示抽奖的额外拓展信息,对应模型类:LotteryListModelExt字段说明