开放平台
平台概述
开发者文档
  • 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. 互动工具

互动-商品

商品#

商品
注意:本 SDK 商品支付能力直接集成微信、支付宝 H5 支付

关键方法#

方法方法描述
VHSaaSDK.getInstance().getGoodsList在线活动商品列表
VHSaaSDK.getInstance().getGoodsInfo获取上架商品详情
VHSaaSDK.getInstance().getGoodsInfoFromUrl获取上架商品更新详情
VHSaaSDK.getInstance().getGoodsOrderSetting用户获取活动商品设置
VHSaaSDK.getInstance().goodsOrderCreate创建订单
VHSaaSDK.getInstance().getGoodsPartnerList查询商户号绑定列表

事件监听#

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

关键事件#

方法方法描述
VHRoomEventType.GOODS_UPDATE_INFO商品更新
VHRoomEventType.PUSH_GOODS_CHANGE推送商品状态

接收消息状态#

当主播在直播过程中,可以添加、删除商品,改变商品的数据
VHRoomEventType.GOODS_UPDATE_INFO
当主播在直播过程中,更改商品状态,如推送当前商品
VHRoomEventType.PUSH_GOODS_CHANGE
接收房间消息

商品推送变更相关数据#

VHPushGoodsChangeData 类定义
VHPushGoodsChangeData 成员类型描述
cdn_urlstringCDN地址
goods_idnumber商品ID
goods_namestring商品名称
push_statusnumber推送状态
pusher_nicknamestring推送者昵称
role_namenumber角色名称
room_idstring房间ID
typestring类型(商品推送变更)

在线活动商品列表#

接口传参
参数名称是否必须示例备注
status否1是否上架
callback是xxxxVHGoodsListCallback
代码使用示例

商品详情信息#

VHGoodsInfo 成员类型描述
enable_multi_confignumber是否启用多配置(0-否,1-是)
buy_typenumber购买类型(1.平台购买 2.外链购买 3.自定义购买(APP嵌入) 4.自定义购买(小程序嵌入))
pricenumber原价
discount_pricenumber折扣价
covered_statusnumber覆盖状态(0-不覆盖,1-覆盖原有价格/配置)
covered_pricenumber覆盖价格(特殊场景下的自定义价格展示,如"免费"、"议价")
descriptionstring商品描述信息
webinar_goods_idnumberwebinar关联商品ID(用于关联直播场次的商品)
order_numnumber已售订单数量
statusnumber商品状态(1-正常,0-下架,2-待上架等)
push_statusnumber推送状态(0-未推送,1-推送中,2-已推送)用于控制商品是否在直播中推送展示
cover_imgstring商品封面图URL(主图)
urlstring商品跳转链接(如电商详情页、购买页)
ext_datastring扩展数据(存储额外的业务配置,JSON格式字符串)
shop_shownumber店铺展示状态(0-不在店铺展示,1-在店铺展示)
shop_urlnumber店铺跳转链接
imagesVHGoodsImages[]商品图片列表(包含封面图和详情图)
auto_popnumber自动弹窗状态(0-不自动弹窗,1-进入页面自动弹窗展示商品)
push_timenumber推送时间(时间戳,单位:毫秒)
goods_detail_urlstring商品详情信息url。查看详情可使用此页面进行跳转
goods_order_urlstring支付页面url。 支付可使用此页面跳转
sale_statusnumber销售状态(1-在售,2-售罄)
goods_idnumber商品ID(唯一标识)
third_goods_idstring第三方商品ID(对接外部电商平台的商品ID)
namestring商品名称
VHGoodsImages 成员类型描述
img_urlstring图片地址
is_covernumber是否是封面图片(0.否 1.是)

获取上架商品详情#

接口API
  public getGoodsInfo(webinar_id:number,goods_id: string, callback: VHGoodsInfoCallback)
接口参数
参数名称是否必须示例备注
webinar_id是xxx活动id
goods_id是xxx商品id
callback是xxxxVHGoodsInfoCallback
代码示例
    VHSaaSDK.getInstance().getGoodsInfo(this.webinar_info?.webinar?.id!,"10169",{
      onSuccess: (data: VHGoodsInfo[]) => {
        let count = data.length;
        if(count > 0){

        }
      },
      onFailure: (errorCode: number, errorMsg: string) => {}
    });

获取上架商品更新详情#

接口API
 public getGoodsInfoFromUrl(url: string, callback: VHGoodsInfoCallback) 
接口参数
参数名称是否必须示例备注
url是xxx商品信息cdn url
callback是xxxxVHGoodsInfoCallback

用户获取活动商品设置#

接口传参
参数名称是否必须示例备注
webinar_id是966397514活动 ID
business_uid否xxxb端用户ID
callback是xxxxVHGoodsActivitySettingsCallback
代码使用示例

获取活动商品设置#

VHGoodsActivitySettings 成员类型描述
webinar_idnumber活动ID
enable_usernamenumber开启姓名;0.否 1.是
enable_phonenumber开启手机号;0.否 1.是
enable_remarknumber开启留言;0.否 1.是
enable_couponnumber开启优惠券入口;0.否 1.是
usernamestring姓名
phonestring手机号
btn_descriptionstring自定义按钮文案
push_show_numnumber推送显示商品数量
enable_buy_noticenumber是否开启观看端购买特效消息(0=不开启,1=开启)
enable_direct_viewnumber是否开启详情页直接跳转: 0=不开启(默认),1=开启
enable_hot_salenumber是否开启热卖提示(默认0=不开启,1=开启)

创建订单#

接口传参
参数名称是否必须示例备注
pay_amount否xxx支付金额
pay_channel否xxx支付渠道
goods是xxx商品信息
coupon_user_ids否xxx优惠券ID
username否xxx用户名
phone否xxx手机号
remark否xxx备注
callback是xxxxVHCreateOrderCallback
代码使用示例

创建商品订单回调数据#

VHCreateOrderInfo 成员类型描述
order_nostring订单号
order_statusstring订单状态
extESObject订单支付扩展属性
refererstring引用

查询商户号绑定列表#

 public getGoodsPartnerList(webinar_id: string, callback: VHGoodsPartnerListCallback) 
接口传参
参数名称是否必须示例备注
webinar_id是966397514活动 ID
callback是VHGoodsPartnerListCallback

查询商户号绑定列表详情#

VHGoodsPartnerList 成员类型描述
totalnumber总数
listVHGoodsPartnerDetails[]列表数据
VHGoodsPartnerDetails 成员类型描述
idnumberid
business_uidnumber租户ID
vh_app_idstring微吼的APPID
channelstring支付渠道, 微信(WEIXIN)、支付宝(ALIPAY)
srv_typenumber商户号对接模式: 0=服务商模式(partner),1=直连模式(direct)
auth_typenumber用户授权方式(sp=使用服务商公众号对用户授权,sub=使用特约商户公众号对用户授权)
mch_idstring商户号
mch_app_idstring商户号应用载体的app_id,可以是公众号,小程序或App
修改于 2025-12-04 02:53:39
上一页
互动-推屏卡片
下一页
互动-优惠卷
Built with