互动有礼

互动有礼通过与问卷进行关联，参与问卷后如果绑定了互动有礼，当用户提交后可参与领奖。

关键方法

方法	方法描述
VHSaaSDK.getInstance().getInteractAwardList	问卷关联的礼品列表
VHSaaSDK.getInstance().getReceiveAwardSetting	获取领奖页信息
VHSaaSDK.getInstance().saveInteractAward	保存中奖人领奖信息
VHSaaSDK.getInstance().getInteractAwardWinnerInfo	获取中奖人信息

事件监听

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

关键事件

方法	方法描述
VHRoomEventType.PUSH_INTERACT_REWARD_WINNING_NOTICE	互动有礼中奖推送消息

互动有礼中奖推送消息

VHInteractRewardWinning	类型	描述
room_id	string	房间id
compulsory_award	number	1强制领奖，强制领奖开关。开启后，中奖用户在未完成领奖时将无法关闭中奖页面及提交领奖页
receive_award_way	number	领奖方式。 1：寄送礼品，2：私信兑奖 3：无需领奖
interact_reward_id	number	互动有礼id
winner_avatar	string	中奖用户头像
winner_id	string	中奖用户id
display_of_results	number	展示效果 0 全屏展示，1 半屏展示
title	string	奖品标题
type	string	消息类型
winner_nickname	string	中奖用户昵称
award_snapshot	VHAwardSnapshot	奖品快照

VHAwardSnapshot	类型	描述
award_name	string	奖品名称
award_img_url	string	奖品图片地址
award_id	number	中奖id

问卷关联的礼品列表

接口 API

  public getInteractAwardList(pos: number, limit: number, callback: VHInteractMyAwardListCallback)

接口参数

参数名称	是否必须	示例	备注
pos	是	0	起始位置
limit	是	50	请求个数
callback	是		VHInteractMyAwardListCallback

代码示例

VHSaaSDK.getInstance().getInteractAwardList(0,200,{
      onSuccess: (data: VHInteractMyAward) => {
        const params= new MyAwardParams(data,this.webinar);
         //展示列表
        PromptActionClass.openDialog();
      },
      onFailure: (errorCode: number, errorMsg: string) => {
        ToastUtil.showToast(errorMsg);
}});

奖品信息VHInteractMyAward

VHInteractMyAward	类型	描述
number	number	description奖品数量
list	VHInteractMyAwardDetails[]	礼物详情
pos	number	请求起始位置
limit	number	请求个数

VHInteractMyAwardDetails	类型	描述
id	number	记录id
receive_award_way	number	领奖方式， 1-寄送奖品 2-私信兑奖 3-无需领奖
display_of_results	number	展示效果，0-全屏（默认） 1-半屏
award_name	string	奖品名称
award_img_url	string	奖品图片地址
winning_time	string	中奖时间
status	number	领取状态，0-未领取 1-已领取 2-已中奖
winner_award_remark	string	中奖者领奖备注，即：用户提交的领奖信息
interact_reward_id	number	互动有礼id
compulsory_award	number	强制领奖：0否 1是

获取领奖页信息

接口 API

  public getReceiveAwardSetting(webinarId: number, interact_reward_id: number,
    callback: VHInteractAwardSettingCallback)

接口参数

参数名称	是否必须	示例	备注
webinarId	是	987262736	活动id
interact_reward_id	是	231	互动有礼id
callback	是		VHInteractAwardSettingCallback

代码示例

VHSaaSDK.getInstance().getReceiveAwardSetting(this.webinar_info?.webinar?.id!,this.interactReward.interact_reward_id,{
    onSucceed: (data: VHInteractAwardSetting) =>{
      if(data.receive_award_way == 1){
        this.settting = data;
        this.settingDataSource = data.json_data;
        this.showSetting = true;
      }else if(data.receive_award_way == 2){
        this.settting = data;
        this.settingDataSource = data.json_data;
        this.showQRGift = true;
      }
    },
    onFailure: (errorCode: number, errorMsg: string) => {
      ToastUtil.showToast(errorMsg);
    }
  })

领奖设置

VHInteractAwardSetting	类型	描述
receive_award_way	number	领奖方式，1-寄送奖品 2-私信兑奖 3-无需领奖
json_data	VHGiftAwardFiled[]	填写信息地址手机号等
compulsory_award	number	强制领奖，0-否（默认） 1-是
statement_status	number	状态，是否使用自定义隐私协议 0否 1是
statement_content	number	隐私协议文本内容
statement_info	VHStatementInfo[]	隐私协议

中奖提交信息详情

VHGiftAwardFiled	类型	描述
field_value	string	填写内容
field	string	field名称
field_key	string	field_key 名字
is_required	boolean	是否必填 true 必填，false 非必填
is_system	number	是否系统自带选项。1 是 0否（自定义填写内容）
placeholder	string	提示语
rank	number	排列顺序
is_check	number	是否需要校验 1：需要校验

保存中奖人领奖信息

接口 API

  public saveInteractAward(room_id: string, lottery_user_name: string, lottery_user_phone: string,
    lottery_user_remark: string, interact_reward_id: number, callback: VHCallBack)

接口参数

参数名称	是否必须	示例	备注
room_id	是	987262736	房间id
interact_reward_id	是	231	互动有礼id
lottery_user_name	是	231	中奖人姓名
lottery_user_phone	是		中奖人手机号
lottery_user_remark	是		备注
callback	是		VHCallBack回调

代码示例

将填写内容转为json字符串
const listenerJsonStr = JSON.stringify(this.settingDataSource);
              let lottery_user_name:string = "";
              let lottery_user_phone:string = "";
              this.settingDataSource.forEach((value:VHGiftAwardFiled,index:number,array:VHGiftAwardFiled[])=>{
  if(value.field_key == "name"){
    lottery_user_name = value.field_value;
  }else if(value.field_key == "phone"){
    lottery_user_phone = value.field_value;
  }

})

VHSaaSDK.getInstance().saveInteractAward(this.webinar_info.interact?.room_id!,
                this.interactReward.interact_reward_id != 0 ? this.interactReward.interact_reward_id : this.interact_reward_id,
                lottery_user_name,lottery_user_phone,listenerJsonStr,{
                // 成功
                onSuccess: (data: string | object) => {
                  ToastUtil.showToast("提交成功");
                  PromptActionClass.closeDialog();
                },

                // 失败
                onFailure: (errorCode: number, errorMsg: string) => {
                  ToastUtil.showToast(errorMsg);
                }
              })

获取中奖人信息

接口 API

public getInteractAwardWinnerInfo(room_id: string, callback: VHInteractWinnerInfoCallback)

接口参数

参数名称	是否必须	示例	备注
room_id	是	987262736	房间id
callback	是		VHInteractWinnerInfoCallback回调

中奖人信息

VHInteractWinnerInfo	类型	描述
lottery_user_name	string	中奖用户名称
lottery_user_phone	string	中奖用户手机号
lottery_user_address	string	中奖用户地址

互动-互动有礼

互动有礼#

关键方法#

事件监听#

关键事件#

互动有礼中奖推送消息#

问卷关联的礼品列表#

奖品信息VHInteractMyAward#

获取领奖页信息#

领奖设置#

中奖提交信息详情#

保存中奖人领奖信息#

获取中奖人信息#

中奖人信息#

互动有礼

关键方法

事件监听

关键事件

互动有礼中奖推送消息

问卷关联的礼品列表

奖品信息VHInteractMyAward

获取领奖页信息

领奖设置

中奖提交信息详情

保存中奖人领奖信息

获取中奖人信息

中奖人信息