抽奖

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

关键方法

方法	方法描述
VHSaaSDK.getInstance().lotteryCheck	检查抽奖进行中
VHSaaSDK.getInstance().lotteryCommit	中奖人领奖信息接口
VHSaaSDK.getInstance().lotteryGetWinner	获取中奖用户列表
VHSaaSDK.getInstance().getHistoryLotteryList	检查抽奖列表接口
VHSaaSDK.getInstance().lotteryJoin	抽奖-立即参与
VHSaaSDK.getInstance().checkLotteryCondition	抽奖检测中奖条件

事件监听

方法	方法描述
imReceiveRoomMessage	消息回调监听

关键事件

方法	方法描述
VHRoomEventType.LOTTERY_PUSH	发起抽奖消息
VHRoomEventType.LOTTERY_RESULT_NOTICE	抽奖结果通知消息

检查抽奖进行中

接口 API

接口入参

参数名称	是否必须	示例	备注
callback	是	xxx	VHLotteryCarryOutCallback 成功回调数据

接口使用示例

VHLotteryCarryOut响应数据

通过接口回调获取到的抽奖进行中的详细信息

VHLotteryCarryOut 成员	类型	描述
lottery_type	number	抽奖类型,1 全体参会用户，2 参与问卷的参会者，3 参与签到的参会者，7.参与签到的观众，8.口令抽奖，21参与快问快答的参会者
title	string	抽奖标题
award_snapshoot	string	奖品快照
id	number	抽奖ID
extension	string	扩展字段
icon	string	图标地址
img_order	string	抽奖动图下标
remark	string	本次抽奖说明
command	string	中奖口令
submit_command	number	是否已提交过口令 0 - 否 1 - 是
publish_winner	number	是否公布中奖名单 0 - 否（默认） 1 - 是
created_at	string	抽奖创建时间
permission	number	是否有权限结束抽奖 1 - 有 0 - 无
lottery_status	number	抽奖状态 0 - 开始抽奖 1 - 抽奖完成（结束）
win	number	是否已中奖 0 - 否 1 - 是
take_award	number	是否已领奖 0 - 否 1 - 是
need_take_award	number	是否需要领奖 0 - 否 1 - 是
can_look_award_pool	number	是否允许查看奖品池 0 不允许 1允许
display_of_results	number	展示效果 0:全屏 1:半屏
compulsory_award	number	是否强制领奖 0:否 1:是

中奖人领奖信息接口

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	lss123345	房间id
lottery_id	是	1773072	抽奖活动ID
lottery_user_name	是	张三	中奖人姓名
lottery_user_phone	是	13123456789	中奖人手机号
callback	是	xxx	VHCallBack

接口使用示例

获取中奖用户列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	lss123345	房间id
lottery_id	是	1773072	抽奖活动ID
callback	是	xxx	VHWinnerInformationCallback 成功回调数据

接口使用示例

VHWinnerInformation中奖人信息

通过接口回调获取中奖人信息

VHWinnerInformation 成员	类型	描述
lottery_id	number	抽奖ID
total	number	总消息个数
user_win	boolean	当前用户是否中奖，true：中奖，false未中奖-新增字段
list	VHWinnerInformationItem[]	查询条件返回的结果集

VHWinnerInformationItem响应数据

通过接口回调获取中奖用户列表的详细信息

VHWinnerInformationItem 成员	类型	描述
lottery_user_id	string	抽奖中奖者ID
lottery_user_nickname	string	抽奖中奖者昵称
lottery_user_avatar	string	中奖者头像
lottery_award_id	string	奖品id
lottery_award_name	string	奖品名称
win	boolean	当前用户是否中奖，true：中奖，false未中奖

检查抽奖列表接口

接口 API

接口入参

参数名称	是否必须	示例	备注
show_all	否	0	房间id
callback	是	xxx	VHLotteryListCallback 成功回调数据

接口使用示例

VHLotteryList响应数据

通过接口获取观看端检查抽奖列表信息

VHLotteryList 成员	类型	描述
award_snapshoot	VHAwardSnapShoot	奖品信息
id	number	抽奖id
surplus	number	剩余数量
sort	number	排序
bus_award_snapshot_pool	number	奖品快照
command	string	私信号码
compulsory_award	number	是否强制领奖 0:否 1:是
created_at	string	创建时间
display_of_results	number	展示效果 0:全屏 1:半屏
extension	string	扩展信息
icon	string	动态图片
img_order	number	图片顺序
lottery_status	number	抽奖状态 0=正在抽奖 1=抽奖结束
lottery_type	number	抽奖类型,1 全体参会用户，2 参与问卷的参会者，3 参与签到的参会者，7.参与签到的观众，8.口令抽奖，21参与快问快答的参会者
need_take_award	number	是否需要领奖 0-否 1-是
permission	number	权限
publish_winner	number	公布获奖者
receive_award_way	number	领取奖励天数
remark	string	备注
submit_award	number	提交奖励
take_award	number	领取奖励
title	string	标题
win	number	是否中奖

VHAwardSnapShoot响应数据

VHAwardSnapShoot 成员	类型	描述
app_id	string	应用id
award_desc	string	奖励描述
award_name	string	奖励名称
business_id	string	业务id
created_at	string	创建时间
image_id	number	图片id
image_url	string	图片url
link_url	string	链接url
lottery_id	number	抽奖id
quantity	number	数量
sort	number	排序
source_id	string	来源id
surplus	number	剩余数量

抽奖-立即参与

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	lss123345	房间id
lottery_id	是	1773072	抽奖活动ID
callback	是	xxx	VHCallBack

接口使用示例

抽奖检测中奖条件

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	lss123345	房间id
callback	是	xxx	VHLotteryConditionCallback 成功回调数据

接口使用示例

VHLotteryCondition数据

VHLotteryCondition	类型	备注
tip	boolean	是否强提醒，true为强提醒，false为无感知
operate	boolean	是否能操作，true为可继续操作，false为不可操作
condition	number	参与抽奖人员范围：* 1 全体参会用户* 2 参与问卷的参会者* 3 参与签到的参会者 * 4.全体观众* 5.已登录观众* 6.参与问卷的观众 * 7.参与签到的观众* 8.口令参与* 9.分享参与* 10.邀请人数参与 * 20.批量上传用户* 21.参与快问快答
status	number	条件满足状态： 0已满足 1未签到， 2单个问卷未填写， 3多个问卷未填写， 4单个快问快答未填写， 5多个快问快答未填写， 6快问快答分数未满足
question_ids	string	问卷id集合，多个时用英文逗号分隔
fqa_ids	string	快问快答id集合，多个时，用英文逗号分隔
sign_id	string	快问快答id集合，多个时，用英文逗号分隔

VHLotteryResultNoticeModel抽奖消息

抽奖消息事件类型

VHLotteryResultNoticeModel 成员	类型	描述
room_id	string	房间ID
award_snapshoot	VHLotteryAwardModel	奖品快照
lottery_method	number	开奖方式：0：手动开奖 1：倒计时开奖
compulsory_award	number	是否强制领奖：0：否 1：是
receive_award_way	number	领奖方式 1:寄送奖品 2:私信兑奖 3:无需领奖,4:自定义领奖
icon	string	抽奖图标URL
lottery_winners_award	VHAwardUserModel[]	中奖用户和奖品
remark	string	备注信息
lottery_id	number	中奖id
type	string	消息类型
title	string	抽奖标题
lottery_creator_avatar	string	抽奖创建者头像
can_look_award_pool	number	是否可查看中奖名单1:可查看0:不可查看
lottery_creator_nickname	string	抽奖创建者昵称
img_order	number	图片排序
command	string	抽奖命令
lottery_number	number	奖品数量
publish_winner	number	是否公布中奖名单1:公布0:不公布
lottery_creator_id	number	抽奖创建者ID
lottery_publisher_id	string	抽奖发布者ID
lottery_type	number	抽奖类型,1 全体参会用户，2 参与问卷的参会者，3 参与签到的参会者，7.参与签到的观众，8.口令抽奖，21参与快问快答的参会者
is_new	number	是否新消息
lottery_status	number	抽奖状态,0 开始抽奖 1 抽奖完成（结束）
actual_lottery_number	number	实际中奖人数
lottery_winners	string	中奖者信息
is_last_batch	number	中奖用户过多，分批推送，标记是否是做后一批推送记录
display_of_results	number	是否公布中奖名单 1是 0否
need_take_award	number	是否需要领奖, 0:否 1:是

互动-抽奖

抽奖#

关键方法#

事件监听#

关键事件#

检查抽奖进行中#

VHLotteryCarryOut响应数据#

中奖人领奖信息接口#

获取中奖用户列表#

VHWinnerInformation中奖人信息#

VHWinnerInformationItem响应数据#

检查抽奖列表接口#

VHLotteryList响应数据#

抽奖-立即参与#

抽奖检测中奖条件#

VHLotteryCondition数据#

VHLotteryResultNoticeModel抽奖消息#

抽奖

关键方法

事件监听

关键事件

检查抽奖进行中

VHLotteryCarryOut响应数据

中奖人领奖信息接口

获取中奖用户列表

VHWinnerInformation中奖人信息

VHWinnerInformationItem响应数据

检查抽奖列表接口

VHLotteryList响应数据

抽奖-立即参与

抽奖检测中奖条件

VHLotteryCondition数据

VHLotteryResultNoticeModel抽奖消息