开放平台
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
平台概述
开发者文档
  • API文档
  • SDK文档
  • 接入指南
  • 集成方案
产品功能
  • 新手入门
  • 产品功能
常见问题首页
  1. 互动工具
  • DEMO示例
  • JS SDK
    • web 点播 sdk
      • 更新记录
      • 点播上传SDK
    • web 观播 sdk
      • 产品介绍
      • 快速接入
      • 对接示例
      • 观看直播
      • 文档白板
      • 互动连麦
      • 暖场视频
      • 全局事件
      • 全局错误码
      • 房间消息说明
      • 版本更新记录
      • 互动工具
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-问答
        • 互动-推屏卡片
        • 互动-快问快答
        • 互动-聊天
        • 互动-优惠券
        • 互动-点赞
      • 直播间拓展功能
        • 资料下载
        • 观看限制验证
        • 观看协议
        • 回放章节
  • iOS SDK
    • 整体介绍
    • 快速接入
    • SDK 登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • v2.3.0 到 v2.4.0 升级说明
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v6.3.0
      • v6.2.1
      • v3.2.0 到 v4.0.1
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • 6.5.0
      • v5.0.x 到 v6.0.0
      • v6.4.0
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 信息采集说明
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 观看回放
      • 观看回放/点播
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 更新记录
      • 更新记录
    • 版本更新说明
      • v6.4.0
      • v6.3.0
      • v6.2.3
      • v6.2.1
      • v6.2.0
      • v6.1.0
      • v6.0.0
      • v5.0.0
      • v4.1.0
      • v4.0.0
      • v3.3.0
  • Harmony SDK
    • 整体介绍
    • 快速接入
    • SDK初始化
    • 登录&登出
    • 活动基础信息
    • 观看协议
    • 观看权限校验&预约
    • 开屏海报
    • 暖场视频
    • 观看直播
    • 观看回放/点播
    • 聊天
    • 房间消息
    • 在线人数&热度
    • 文档/白板
    • 版本更新
    • 私聊
    • 播放器错误码
    • 互动工具
      • 互动-问答
      • 互动-问卷
      • 互动-公告
      • 互动-抽奖
      • 互动-签到
      • 互动-计时器
      • 互动-礼物
      • 互动-互动有礼
      • 互动-快问快答
      • 互动-口令红包
      • 互动-推屏卡片
      • 互动-商品
      • 互动-优惠卷
      • 互动-观看有礼
      • 互动-点赞
    • 防录屏
      • 播放器水印&跑马灯
    • 菜单
      • 自定义菜单
      • 文件下载
      • 概要总结
      • 回放列表
      • 邀请卡
  • 微信小程序 SDK
  • 相关协议
    • 微吼直播 SDK 隐私政策
    • 微吼直播 SDK 开发者使用规范
  1. 互动工具

互动-口令红包

口令红包#

口令红包功能适用于与观众进行互动炒热气氛使用,可以复制口令到支付宝的口令红包功能进行联动。

关键方法#

方法方法描述
VHSaaSDK.getInstance().openPasswordRedEnvelope打开口令红包
VHSaaSDK.getInstance().getRedPacketStatus获取红包状态
VHSaaSDK.getInstance().getRedEnvelopeUserList获取口令红包的用户详情

事件监听#

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

关键事件#

方法方法描述
VHRoomEventType.PUSH_PWD_RED_ENVELOPE_OK口令红包消息

口令红包消息#

当主播正在直播,可以发布口令红包,与观众进行互动,观众可以复制口令在支付宝的口令红包中进行红包领取
VHRoomEventType.PUSH_PWD_RED_ENVELOPE_OK
接收房间消息
private handlePasswordPack(message: VHIMMessageModel) {
    this.VHEnvelopeDialog.close()
    const RedEnvelope = message.data as VHPwdRedEnvelopeData;
    this.RedEnvelopeData = RedEnvelope
    this.VHEnvelopeDialog.open()
}
if (type == VHRoomEventType.PUSH_PWD_RED_ENVELOPE_OK) {
  this.handlePasswordPack(message)
}

口令红包消息信息#

VHPwdRedEnvelopeData 成员类型描述
event_typestring事件类型标识
red_packet_amountnumber红包金额
red_packet_numbernumber红包数量
red_packet_start_timestring红包开始时间
red_packet_typenumber红包类型标识
room_idstring房间ID
red_packet_uuidstring红包UUID
sender_avatarstring发送者头像
sender_idstring发送者的ID
sender_nicknamestring发送者的昵称
typestring类型标识

打开口令红包#


接口传参
参数名称是否必须示例备注
room_id是123456789活动id
red_packet_uuid是xxx口令红包id
callback是xxxxVHRedEnvelopeInfoCallback
代码使用示例
VHSaaSDK.getInstance().openPasswordRedEnvelope(this.RedEnvelopeData?.room_id!, this.RedEnvelopeData?.red_packet_uuid!,
    {
      onSuccess: (data: VHRedEnvelopeInfo) => {
        console.log("接收口令红包成功", data)
      },
      onFailure: (errorCode: number, errorMsg: string) => {
        console.log("接收口令红包失败", errorCode, errorMsg)
        ToastUtil.showToast(errorMsg);
      }
    });

打开口令红包回调信息#

VHRedEnvelopeInfo 成员类型描述
statusnumber是否抢到:0-未抢到,1-抢到了
red_codestring红包口令

获取红包状态#


接口传参
参数名称是否必须示例备注
room_id是123456789活动id
redPacketId是xxx口令红包id
callback是xxxxVHGetRedPacketCallback
代码示例
    // 红包状态
    if(this.commonConfig.pwd_red_packet?.status == 1){
      VHSaaSDK.getInstance().getRedPacketStatus(this.webinar_info?.interact?.room_id!,uuid,{
        onSucceed: (data: VHRedPacketStatus) => {
          if(data.is_luck == 2){
            this.RedEnvelope = new VHRedEnvelopeInfo;
            this.RedEnvelope.status = 1;
            this.RedEnvelope.red_code = data.red_code;
            this.RedEnvelopeData.room_id = this.webinar_info?.interact?.room_id!;
            this.RedEnvelopeData.red_packet_uuid = uuid;
            if (this.RedEnvelope != null) {
              this.VHEnvelopeDialog.open()
            }
          }
        },
        onFailure: (errorCode: number, errorMsg: string) => {

        }
      })
    }

获取红包状态回调信息#

VHRedPacketStatus 成员类型描述
is_lucknumber是否抢到:1:抢到 ;0:未抢到;2-没有抢
red_codestring红包口令
red_packetVHPacketStatus红包信息
VHPacketStatus 成员类型描述
numbernumber红包数量
red_packet_uuidstring红包唯一标识
nicknamestring昵称
avatarstring头像
join_typenumber橘色

获取口令红包的用户详情#


接口传参
参数名称是否必须示例备注
room_id是123456789活动id
red_packet_uuid是xxx口令红包id
pos是0页码
limit是10每页数量
callback是xxxxVHRedEnvelopeUserListInfoCallback
代码使用示例

获取口令红包的用户详情回调信息#

VHWinningUserListInfo 成员类型描述
amountnumber领取金额
amount_rankingnumber领取金额排名
app_idstring应用ID,用于标识所属应用
avatarstring用户头像URL地址
created_atstring记录创建时间
deletednumber删除标识
deleted_atnull删除时间
extensionstring扩展信息
get_red_packet_record_idnumber领取红包记录ID
gift_typestring礼物类型标识
nicknamestring用户昵称
percentnumber占比
red_packet_idnumber红包ID
source_idstring来源ID,标识红包来源相关
third_party_user_idstring第三方用户ID
updated_atstring记录更新时间
修改于 2025-11-19 08:22:07
上一页
互动-快问快答
下一页
互动-推屏卡片
Built with