互动-礼物
互动-礼物
关键方法
| 方法 | 方法描述 |
|---|---|
| VHSaaSDK.getInstance().getGiftList | 获取活动使用的礼物列表 |
| VHSaaSDK.getInstance().sendGift | 发送礼物给主持人 |
| VHSaaSDK.getInstance().permissionsCheck | 获取活动配置开关 |
事件监听
| 方法 | 方法描述 |
|---|---|
| imReceiveRoomMessage | 消息回调监听 |
关键事件
| 方法 | 方法描述 |
|---|---|
| VHRoomEventType.GIFT_MSG | 礼物消息 |
获取活动使用的礼物列表
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| room_id | 是 | lss123345 | 房间id |
| callback | 是 | VHGiftListCallback |
接口返回值
礼物信息字段说明
礼物列表
| VHGiftList 字段名称 | 类型 | 说明 |
|---|---|---|
| list | VHGiftItem[] | 礼物列表 |
| total | number | 总数 |
礼物列表信息
| VHGiftItem 字段名称 | 说明 |
|---|---|
| id | 礼物id |
| name | 礼物名成 |
| price | 礼物价格 |
| image_url | 礼物图片 |
| source_type | 来源类型：0 web 1 app |
| source_status | 0 系统礼物 1 自定义礼物 |
| is_show | 0 不显示 1 显示 |
发送礼物给主持人
| 字段名称 | 说明 |
|---|---|
| room_id | 是 |
| gift_id | 礼物ID |
| channel | 支付渠道 WEIXIN |
| service_code | 支付方式 QR_PAY |
| open_id | 当支付方式为JSAPI的时候必传 |
获取活动配置开关
| 字段名称 | 说明 |
|---|---|
| scene_id | 是 使用场景：1权限检测 |
| webinar_user_id | 有webinar_id时，必传 |
| webinar_id | 活动id |
礼物消息
礼物消息信息
| VHGiftMessageInfo礼物清单 | 类型 | 描述 |
|---|---|---|
| room_id | string | 房间ID |
| gift_user_nickname | string | 送礼用户昵称 |
| gift_id | number | 礼物ID |
| type | string | 事件类型 |
| gift_user_name | string | 头像 |
| gift_image_url | string | 礼物图片URL |
| gift_creator_id | string | 礼物创建者ID |
| gift_user_avatar | string | 送礼用户头像 |
| gift_name | string | 礼物名称 |
| gift_receiver_id | number | 收礼用户ID |
| gift_price | number | 礼物价格 |
| source_status | string | 来源状态 |
修改于 2025-11-19 08:22:07