商品

商品
注意：本 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_url	string	CDN地址
goods_id	number	商品ID
goods_name	string	商品名称
push_status	number	推送状态
pusher_nickname	string	推送者昵称
role_name	number	角色名称
room_id	string	房间ID
type	string	类型（商品推送变更）

在线活动商品列表

接口传参

参数名称	是否必须	示例	备注
status	否	1	是否上架
callback	是	xxxx	VHGoodsListCallback

代码使用示例

商品详情信息

VHGoodsInfo 成员	类型	描述
enable_multi_config	number	是否启用多配置（0-否，1-是）
buy_type	number	购买类型(1.平台购买 2.外链购买 3.自定义购买(APP嵌入) 4.自定义购买(小程序嵌入))
price	number	原价
discount_price	number	折扣价
covered_status	number	覆盖状态（0-不覆盖，1-覆盖原有价格/配置）
covered_price	number	覆盖价格（特殊场景下的自定义价格展示，如"免费"、"议价"）
description	string	商品描述信息
webinar_goods_id	number	webinar关联商品ID（用于关联直播场次的商品）
order_num	number	已售订单数量
status	number	商品状态（1-正常，0-下架，2-待上架等）
push_status	number	推送状态（0-未推送，1-推送中，2-已推送）用于控制商品是否在直播中推送展示
cover_img	string	商品封面图URL（主图）
url	string	商品跳转链接（如电商详情页、购买页）
ext_data	string	扩展数据（存储额外的业务配置，JSON格式字符串）
shop_show	number	店铺展示状态（0-不在店铺展示，1-在店铺展示）
shop_url	number	店铺跳转链接
images	VHGoodsImages[]	商品图片列表（包含封面图和详情图）
auto_pop	number	自动弹窗状态（0-不自动弹窗，1-进入页面自动弹窗展示商品）
push_time	number	推送时间（时间戳，单位：毫秒）
goods_detail_url	string	商品详情信息url。查看详情可使用此页面进行跳转
goods_order_url	string	支付页面url。支付可使用此页面跳转
sale_status	number	销售状态（1-在售，2-售罄）
goods_id	number	商品ID（唯一标识）
third_goods_id	string	第三方商品ID（对接外部电商平台的商品ID）
name	string	商品名称

VHGoodsImages 成员	类型	描述
img_url	string	图片地址
is_cover	number	是否是封面图片(0.否 1.是)

获取上架商品详情

接口API

  public getGoodsInfo(webinar_id:number,goods_id: string, callback: VHGoodsInfoCallback)

接口参数

参数名称	是否必须	示例	备注
webinar_id	是	xxx	活动id
goods_id	是	xxx	商品id
callback	是	xxxx	VHGoodsInfoCallback

代码示例

    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	是	xxxx	VHGoodsInfoCallback

用户获取活动商品设置

接口传参

参数名称	是否必须	示例	备注
webinar_id	是	966397514	活动 ID
business_uid	否	xxx	b端用户ID
callback	是	xxxx	VHGoodsActivitySettingsCallback

代码使用示例

获取活动商品设置

VHGoodsActivitySettings 成员	类型	描述
webinar_id	number	活动ID
enable_username	number	开启姓名;0.否 1.是
enable_phone	number	开启手机号;0.否 1.是
enable_remark	number	开启留言;0.否 1.是
enable_coupon	number	开启优惠券入口;0.否 1.是
username	string	姓名
phone	string	手机号
btn_description	string	自定义按钮文案
push_show_num	number	推送显示商品数量
enable_buy_notice	number	是否开启观看端购买特效消息(0=不开启，1=开启)
enable_direct_view	number	是否开启详情页直接跳转: 0=不开启(默认），1=开启
enable_hot_sale	number	是否开启热卖提示(默认0=不开启,1=开启)

创建订单

接口传参

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

代码使用示例

创建商品订单回调数据

VHCreateOrderInfo 成员	类型	描述
order_no	string	订单号
order_status	string	订单状态
ext	ESObject	订单支付扩展属性
referer	string	引用

查询商户号绑定列表

 public getGoodsPartnerList(webinar_id: string, callback: VHGoodsPartnerListCallback)

接口传参

参数名称	是否必须	示例	备注
webinar_id	是	966397514	活动 ID
callback	是		VHGoodsPartnerListCallback

查询商户号绑定列表详情

VHGoodsPartnerList 成员	类型	描述
total	number	总数
list	VHGoodsPartnerDetails[]	列表数据

VHGoodsPartnerDetails 成员	类型	描述
id	number	id
business_uid	number	租户ID
vh_app_id	string	微吼的APPID
channel	string	支付渠道, 微信(WEIXIN)、支付宝(ALIPAY)
srv_type	number	商户号对接模式: 0=服务商模式(partner),1=直连模式(direct)
auth_type	number	用户授权方式(sp=使用服务商公众号对用户授权,sub=使用特约商户公众号对用户授权)
mch_id	string	商户号
mch_app_id	string	商户号应用载体的app_id，可以是公众号，小程序或App

互动-商品

商品#

关键方法#

事件监听#

关键事件#

接收消息状态#

商品推送变更相关数据#

在线活动商品列表#

商品详情信息#

获取上架商品详情#

获取上架商品更新详情#

用户获取活动商品设置#

获取活动商品设置#

创建订单#

创建商品订单回调数据#

查询商户号绑定列表#

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

商品

关键方法

事件监听

关键事件

接收消息状态

商品推送变更相关数据

在线活动商品列表

商品详情信息

获取上架商品详情

获取上架商品更新详情

用户获取活动商品设置

获取活动商品设置

创建订单

创建商品订单回调数据

查询商户号绑定列表

查询商户号绑定列表详情