开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. 互动工具
  • demo
  • JS SDK
    • 产品介绍
    • 快速接入
    • SDK 对接示例
    • 观看直播
    • 暖场视频
    • 房间消息说明
    • 互动连麦
    • 文档白板
    • 全局事件
    • 全局错误码
    • 版本更新记录
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-聊天
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展功能
      • 资料下载
      • 观看限制验证
      • 观看协议
      • 回放章节
  • 点播SDK
    • 点播上传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
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. 互动工具

互动-商品

商品
注意:本 SDK 商品支付能力直接集成微信、支付宝 H5 支付,IOS APP 集成后提交审核可能被拒,遇到该问题咨询售后或技术支持

核心类#

类名类描述
VHGoodsObject推屏卡片类

VHGoodsObject 关键方法#

方法方法描述
goodsGetOnlineListWithStatus在线活动商品列表
goodsWebinarSettingInfoWithWebinarId获取商品活动设置
goodsWebinarOnlineGoodsInfoWithGoodsId获取商品详情
goodsCreateOtherWithSwitchId创建订单
goodsOrderInfoWithOrderNo获取我的订单信息
platformPaymentToPayWithOrderUrl三方平台支付

VHPushScreenCardObjectDelegate 代理方法#

方法方法描述
pushGoodsCardModel商品推屏
addGoodsInfo商品添加
deleteGoods商品删除
updateGoodsInfo商品更新
updateGoodsListWithCdnUrl商品列表快速刷新
goodsOrderItem支付状态
paySkipIsComplete跳转支付是否完成
errorDetail跳转支付失败详情

在线活动商品列表#

方法 API
+ (void)goodsGetListComplete:(void (^)(NSArray <VHGoodsListItem *> *list, NSError *error))complete;
方法入参
参数名称是否必须示例备注
status是1状态(1. 上架 2.上架及推送上架)

VHGoodsListItem 商品类详情#

参数名称备注
IDID
goods_id商品 ID
price原价
discount_price优惠价
info商品描述
cover_img封面图片
url商品链接
qr_code_url二维码链接
name商品名称
shop_url店铺链接
third_goods_id三方商品 ID
buy_type购买类型;1.平台购买 2.外链购买 3.自定义购买
webinar_goods_id活动商品 ID
order_num排序
status上架状态;(0.下架 1.上架 2.推送上架)
push_status推送状态;(0.未推送 1. 推送中 2.已推送)
shop_show显示店铺
images图片集合
方法示例
[VHGoodsObject goodsGetOnlineListWithStatus:1 complete:^(NSArray<VHGoodsListItem *> *list, NSError *error) {
    if (list) {
        // 获取成功,返回商品列表
    }
    if (error) {
        // 获取失败,返回失败详情
    }
    // 刷新列表
    [self.tableView reloadData];
}];

获取商品活动设置#

在提交订单前需要通过此接口获取订单必填项有哪些,以及平台支付的开通项有哪些
方法 API
+ (void)goodsWebinarSettingInfoWithWebinarId:(NSString *)webinar_id complete:(void (^)(VHGoodsSettingItem *settingItem, NSError *error))complete;
方法入参
参数名称是否必须示例备注
webinar_id是123456活动 ID
complete返回数据完成返回详情,失败错误详情

VHGoodsSettingItem 商品设置参数#

参数名称备注
webinar_id活动 id
enable_username开启姓名;0.否 1.是
enable_phone开启手机号;0.否 1.是
enable_remark开启留言;0.否 1.是
enable_wx开启微信;NO.否 YES.是
enable_ali开启支付宝;NO.否 YES.是
方法示例
[VHGoodsObject goodsWebinarSettingInfoWithWebinarId:self.webinarInfo.webinarId complete:^(VHGoodsSettingItem *settingItem, NSError *error) {
    __strong __typeof(weakSelf)self = weakSelf;
    if (list) {
        // 获取成功,返回设置详情
    }
    if (error) {
        // 获取失败,返回失败详情
    }
}];

获取商品详情#

方法 API
+ (void)goodsWebinarOnlineGoodsInfoWithGoodsId:(NSString *)goods_id complete:(void (^)(VHGoodsListItem *goodsItem, NSError *error))complete;
方法入参
参数名称是否必须示例备注
goods_id是123456商品 ID
complete返回数据完成返回详情,失败错误详情
方法示例
[VHGoodsObject goodsWebinarOnlineGoodsInfoWithGoodsId:item.goods_id complete:^(VHGoodsListItem *goodsItem, NSError *error) {
    __strong __typeof(weakSelf)self = weakSelf;
    if (goodsItem) {
    }
    if (error) {
    }
}];

创建订单#

方法 API
+ (void)goodsCreateOtherWithSwitchId:(NSString *)switch_id third_user_id:(NSString *)third_user_id username:(NSString *)username phone:(NSString *)phone remark:(NSString *)remark goods_id:(NSString *)goods_id quantity:(NSInteger)quantity pay_channel:(NSString *)pay_channel channel_source:(NSString *)channel_source pay_amount:(CGFloat)pay_amount complete:(void (^)(VHGoodsCreateOtherItem *createOtherItem, NSError *error))complete;
方法入参
参数名称是否必须示例备注
switch_id是74932748场次 ID
third_user_id是213798三方用户 ID
username否 (根据活动设置为准)阿超姓名,不能超过 30 个字符
phone否(根据活动设置为准)13261699658手机号(是国内手机号)
remark否不要香菜留言备注,不能超过 50 个字符
goods_id是8197231商品 ID
quantity是10数量,不能超过 100 个
pay_channel是WEIXIN支付渠道(取值范围:WEIXIN,ALIPAY)
channel_source是main渠道来源(main)
pay_amount是100实付金额
complete完成返回详情,失败错误详情

VHGoodsCreateOtherItem 创建订单参数#

参数名称备注
order_no订单号
order_status订单状态
order_url支付 url
refererreferer
方法示例
[VHGoodsObject goodsCreateOtherWithSwitchId:self.webinarInfo.webinarInfoData.data_switch.switch_id third_user_id:self.webinarInfo.webinarInfoData.join_info.third_party_user_id username:@"阿超" phone:@"13261699658" remark:@"不要香菜" goods_id:self.item.goods_id quantity:10 pay_channel:@"WEIXIN" channel_source:@"main" pay_amount:999 complete:^(VHGoodsCreateOtherItem *createOtherItem, NSError *error) {
    if (createOtherItem) {
        NSURL * url = [NSURL URLWithString:createOtherItem.order_url];
        if (([createOtherItem.order_url containsString:@"wx"] || [createOtherItem.order_url containsString:@"ali"]) && self.skipWXOrALIPayBlock) {
            // 判断如果包含微信或者支付宝则跳转三方支付
            [self.goodsObject platformPaymentToPayWithOrderUrl:url scheme:@"demo.vhall.com" referer:referer];
        } else {
            // 打开url
            [[UIApplication sharedApplication]  openURL:url
                          options:@{}
                completionHandler:^(BOOL success) {
                NSLog(@"跳转%@", success ? @"完成" : @"失败");
            }];
        }
    }
    if (error) {
        // 错误详情
    }
}];

获取我的订单信息#

方法 API
+ (void)goodsOrderInfoWithOrderNo:(NSString *)order_no complete:(void (^)(VHGoodsOrderInfo *orderInfo, NSError *error))complete;
方法入参
参数名称是否必须示例备注
order_no是123456创建订单后返回的订单号
complete返回数据完成返回详情,失败错误详情

VHGoodsOrderInfo 订单详情参数#

参数名称备注
order_no订单号
total_amount订单总金额
pay_amount实付金额
webinar_subject活动名称
created_at下单时间
username用户姓名
phone用户手机号
remark用户留言
order_status订单状态
pay_channel支付渠道
pay_time支付时间
service_code支付方式
trade_no交易流水号
webinar_id活动 ID
buy_type购买类型(1.平台购买 2.外链购买 3.自定义购买)
order_items订单明细

VHGoodsOrderInfoItem 订单明细参数#

参数名称备注
goods_id商品 ID
cover_img商品封面图片
price商品原价
discount_price商品优惠价
info商品描述
name商品名称
quantity商品数量
方法示例
[VHGoodsObject goodsOrderInfoWithOrderNo:self.order_no complete:^(VHGoodsOrderInfo *orderInfo, NSError *error) {
    if (orderInfo) {
        [VHProgressHud showToast:[NSString stringWithFormat:@"支付状态 %@",orderInfo.order_status]];
    }
    if (error) {
        [VHProgressHud showToast:error.domain];
    }
}];

三方平台支付#

如果是三方平台支付,在创建订单完成后通过返回的 order_url 调用此方法唤起三方平台,上面已经给出使用示例
方法 API
- (void)platformPaymentToPayWithOrderUrl:(NSURL *)url scheme:(NSString *)scheme referer:(NSString *)referer;
方法入参
参数名称是否必须示例备注
url是http wx ali...使用创建订单接口返回的 ext 地址,创建 url 对象进行跳转
scheme是demo.vhall.comapp 配置的 scheme,用来支付完成后返回应用,必须使用微信配置的顶级域名或子域名,例如顶级域名是 vhall.com,则可以设置为 demo.vhall.com
referer是vhall.com用来配置微信支付授权的必传参数,最好使用微信配置的顶级域名

商品推屏#

方法 API
- (void)pushGoodsCardModel:(VHGoodsPushMessageItem *)model push_status:(NSInteger)push_status;

商品添加#

方法 API
- (void)addGoodsInfo:(VHGoodsListItem *)goods_info cdn_url:(NSString *)cdn_url;

商品删除#

方法 API
- (void)deleteGoods:(NSArray *)del_goods_ids cdn_url:(NSString *)cdn_url;

商品更新#

方法 API
- (void)updateGoodsInfo:(VHGoodsListItem *)goods_info cdn_url:(NSString *)cdn_url;

商品列表快速刷新#

方法 API
- (void)updateGoodsListWithCdnUrl:(NSString *)cdn_url;

支付状态#

方法 API
- (void)goodsOrderItem:(VHGoodsPayStatusItem *)item;

跳转支付是否完成#

方法 API
- (void)paySkipIsComplete:(BOOL)complete;

跳转支付失败详情#

方法 API
- (void)errorDetail:(NSError *)error;
修改于 2025-05-27 11:59:31
上一页
互动-公告
下一页
互动-计时器
Built with