互动-抽奖

抽奖功能是直播间活跃气氛的一大利器，SDK 观看端提供参与抽奖功能，接入此模块后 SDK 观众可以完整参与直播抽奖、领奖环节。

关键方法

方法	方法描述
VhallSDK.getHistoryLotteryList	获取历史抽奖记录
VhallSDK.getPrizeInfo	获取领奖页中奖信息列表
VhallSDK.submitLotteryInfo	提交中奖信息
VhallSDK.getLotteryWinner	获取中奖用户列表
VhallSDK.joinCodeLottery	参加口令抽奖
VhallSDK.lotteryCheck	判断自己是否中奖

关键事件

方法	方法描述
MessageServer.EVENT_START_LOTTERY	抽奖消息

获取历史抽奖记录

接口 API

接口入参

参数名称	是否必须	示例	备注
show_all	是	false	是否需要展示所有抽奖 0-否(默认：仅展示进行中、已中奖抽奖) 1-全部抽奖 2 已中奖抽奖
ArrayList#LotteryCheckData			返回数据类

LotteryCheckData-抽奖列表

参数名称	备注
lottery_type	参与抽奖人员范围： 1 参会用户 2 填写问卷用户 3 签到用户 8-口令抽奖
id	抽奖 ID
title	标题
icon	图片
remark	本次抽奖说明
command	口令
extension	扩展字段
submit_command	是否已提交过口令 0-否，1-是
publish_winner	是否公布中奖名单，0-否(默认)， 1-是
permission	是否有权限结束抽奖 1-有 0-无
created_at	时间
lottery_status	抽奖状态：0 开始抽奖 1 抽奖完成（结束）
win	是否已中奖 0-否 1-是
take_award	是否已领奖 0-否 1-是
need_take_award	是否需要领奖 0-否 1-是
AwardSnapshootBean	奖品快照

LotteryCheckData#AwardSnapshootBean-抽奖列表

参数名称	备注
id	ID
award_name	昵称
link_url	链接
award_desc	详情
created_at	时间
image_url	图片

代码示例

获取领奖页中奖信息列表

接口 API

接口入参

参数名称	是否必须	示例	备注
webinarId	是	123456789	活动 id
lottery_id	是	123456789	抽奖消息中的抽奖 id
LotteryPrizeInfo			返回数据类

LotteryPrizeInfo-领奖信息

参数名称	备注
receive_award_way	领奖方式 1 寄送奖品 2 私信兑奖 3 无需领奖
list	领奖信息列表 List#LotteryPrizeListInfo

LotteryPrizeListInfo-领奖信息列表

参数名称	备注
field	字段的中文名字
is_required	1:必填 0:非必填
remark	标记
rank	显示顺序
field_value	字段的 value
field_key	字段的 key，name、phone、address 等
placeholder	提示信息
is_system

代码示例

提交中奖信息

接口 API 1

接口入参

参数名称	是否必须	示例	备注
lottery_id	是	11111	抽奖 id
infoList	是	nn	LotteryPrizeListInfo 为 VhallSDK.getPrizeInfo 接口返回数据，补充用户填写信息到 field_value

代码示例

接口 API 2

接口入参

参数名称	是否必须	示例	备注
join_id	是		用户 id
lottery_id	是	11111	抽奖 id
name	是	nn	名字
phone	是	1223333333333	手机号
remark	否	false	扩展字段

remark 字段拼接

提交中奖信息的 remark 字段

代码示例

获取中奖用户列表

接口 API

接口入参

参数名称	是否必须	示例	备注
room_id	是	lss22222	房间 id vss_room_id 来源
lottery_id	是	11111	抽奖 id
LotteryWinnerData			返回数据类

LotteryWinnerData-中奖用户

参数名称	备注
id	抽奖 ID
AwardSnapshootBean	奖品快照
List#MessageServer.Lottery	抽奖信息

代码示例

参加口令抽奖

接口 API

接口入参

参数名称	是否必须	示例	备注
room_id	是	lss22222	房间 id vss_room_id 来源
lottery_id	是	11111	抽奖 id
command	是	111	口令

代码示例

判断自己是否中奖

一般用不上这个接口，除了断网等消息丢失时候使用

接口 API

LotteryCheckData-抽奖列表

参数名称	备注
lottery_type	参与抽奖人员范围： 1 参会用户 2 填写问卷用户 3 签到用户 8-口令抽奖
id	抽奖 ID
title	标题
icon	图片
remark	本次抽奖说明
command	口令
extension	扩展字段
submit_command	是否已提交过口令 0-否，1-是
publish_winner	是否公布中奖名单，0-否(默认)， 1-是
permission	是否有权限结束抽奖 1-有 0-无
created_at	时间
lottery_status	抽奖状态：0 开始抽奖 1 抽奖完成（结束）
win	是否已中奖 0-否 1-是
take_award	是否已领奖 0-否 1-是
need_take_award	是否需要领奖 0-否 1-是
AwardSnapshootBean	奖品快照

LotteryCheckData#AwardSnapshootBean-抽奖列表

参数名称	备注
id	ID
award_name	昵称
link_url	链接
award_desc	详情
created_at	时间
image_url	图片

代码示例

抽奖消息

观看直播时播主可以发起抽奖，而在移动端观看时可以接受抽奖消息

开始抽奖

参数说明

字段	描述
MessageServer.Lottery	抽奖信息

结束抽奖

参数说明

字段	描述
id	抽奖 ID
winnerLottery	是否中奖
MessageServer.Lottery	抽奖信息

代码示例

互动-抽奖

互动-抽奖#

关键方法#

关键事件#

获取历史抽奖记录#

LotteryCheckData-抽奖列表#

LotteryCheckData#AwardSnapshootBean-抽奖列表#

获取领奖页中奖信息列表#

LotteryPrizeInfo-领奖信息#

LotteryPrizeListInfo-领奖信息列表#

提交中奖信息#

remark 字段拼接#

获取中奖用户列表#

LotteryWinnerData-中奖用户#

参加口令抽奖#

判断自己是否中奖#

LotteryCheckData-抽奖列表#

LotteryCheckData#AwardSnapshootBean-抽奖列表#

抽奖消息#

开始抽奖#

结束抽奖#

互动-抽奖

关键方法

关键事件

获取历史抽奖记录

LotteryCheckData-抽奖列表

LotteryCheckData#AwardSnapshootBean-抽奖列表

获取领奖页中奖信息列表

LotteryPrizeInfo-领奖信息

LotteryPrizeListInfo-领奖信息列表

提交中奖信息

remark 字段拼接

获取中奖用户列表

LotteryWinnerData-中奖用户

参加口令抽奖

判断自己是否中奖

LotteryCheckData-抽奖列表

LotteryCheckData#AwardSnapshootBean-抽奖列表

抽奖消息

开始抽奖

结束抽奖