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

互动-商品

互动-商品#

关键方法#

方法方法描述
GoodsServer商品推屏总服务
GoodsServer.getGoodsList获取推屏商品列表
GoodsServer.getGoodsInfo获取商品信息
GoodsServer.getGoodsOrderSetting获取活动下商品订单提交信息设置项
GoodsServer.createOrder创建订单
GoodsServer.payOrder支付订单,只支持平台支付商品, 根据订单信息唤起微信或支付宝进行支付
GoodsServer.getGoodsOrderInfo获取订单信息

关键事件#

方法方法描述
MessageServer.EVENT_PUSH_GOODS_CARD商品推屏消息
MessageServer.EVENT_GOOD_UPDATE_INFO商品信息修改消息

消息回调#

新增推屏卡片消息回调
方法方法描述
GoodsMessageCallBack商品推屏消息回调
GoodsMessageCallBack.pushGoodsCard发送商品推屏卡片
GoodsMessageCallBack.addGoodsInfo新增商品
GoodsMessageCallBack.deleteGoods删除商品
GoodsMessageCallBack.updateGoodsInfo更新商品信息
GoodsMessageCallBack.updateGoodsList更新商品列表
GoodsMessageCallBack.orderStatusChange订单状态改变

商品推屏服务#

接口API
接口入参
参数名称是否必须示例备注
webinarInfo是活动信息
context是上下文
goodsMessageCallBack否消息回调 GoodsMessageCallBack
代码示例

获取推送的推屏商品列表#

接口API
接口入参
参数名称是否必须示例备注
successGoodsInfoData

接口返回值#

信息字段说明#
字段名称说明
GoodsInfoData信息字段说明
total商品总数
List#GoodsInfo商品列表
GoodsInfoData#GoodsInfo
字段名称说明
goods_id商品ID
name商品名称
description商品描述
price两位有效数字的浮点数
discount_price优惠后价格
buy_type购买类型;1.平台购买 2.外链购买 3.自定义购买
third_goods_id三方商品ID 用于打通客户商品体系
url商品链接
shop_show显示店铺
shop_url店铺链接
cover_img封面图片地址
cover_img_scale_typeImageView.ScaleType 封面图片填充模式 图片填充模式:ImageView.ScaleType
images图片集合 GoodsInfoData#ImageInfo
tao_password淘口令
scheme_template自定义购买链接
qr_code_url二维码链接
status上架状态;(0.下架 1.上架 2.推送上架)
push_status推送状态;(0.未推送 1. 推送中 2.已推送)
order_num排序
webinar_goods_id活动下商品ID 暂时只有发起端使用
cdn_url商品列表cdn地址用于加速使用
action1 添加商品信息 2 修改商品信息 3 删除商品 4列表商品变更
del_goods_idsList#String 消息中删除的商品id列表
代码示例

获取商品信息#

接口API
接口入参
字段名称说明
goods_id是商品id
success是GoodsInfoData.GoodsInfo

接口返回值#

信息字段说明#
GoodsInfoData
代码示例

获取活动下商品订单提交信息设置项#

获取活动下商品订单提交信息设置项, 用于控制创建订单页,是否收集名称、手机、备注、支持的支付方式等
接口API
接口入参
参数名称是否必须示例备注
successGoodsOrderSetting
GoodsOrderSetting#
字段名称说明
webinar_id活动ID
enable_username是否需要填写用户名
enable_phone是否需要填写手机号
enable_remark是否需要填写备注
enable_weixin是否支持微信支付
enable_alipay是否支持支付宝支付
代码示例

创建订单#

接口API
接口入参
参数名称是否必须示例备注
goods_id是商品ID
quantity是购买数量
pay_amount是总金额
pay_channel是支付渠道 微信 GoodsServer.PAY_TYPE_WEIXIN 支付宝 GoodsServer.PAY_TYPE_ALIPAY
username否姓名 用户姓名不能超过30个字符
phone否手机号 手机号不能超过11个字符 并且必须是1开头数字
remark否留言备注不能超过50个字符
channel_source否下单渠道 默认main
coupon_user_ids否使用优惠券列表,优惠卷信息CouponInfoData 中的 coupon_user_id
successOrderInfoData
OrderInfoData#
字段名称说明
order_no订单号
order_status订单状态 SUCCESS
order_url订单跳转url, 自定义购买时跳转scheme
trade_no交易流水号
pay_time支付时间
total_amount订单总金额
pay_amount实付金额
webinar_id活动ID
webinar_subject活动名称
created_at下单时间
username用户姓名
phone用户手机号
remark用户留言
channel_source渠道来源
pay_channel支付渠道
service_code支付方式
buy_type购买类型(1.平台购买 2.外链购买 3.自定义购买)
order_items
代码示例

支付订单#

只支持平台支付
接口API
接口入参
参数名称是否必须示例备注
contextContext
orderInfo创建的订单信息
callBack调用结果回调
代码示例

获取订单信息#

获取我的订单信息
接口API
接口入参
参数名称是否必须示例备注
order_no订单号
successOrderInfoData
代码示例

商品推屏消息#

商品推屏消息回调#

新商品推屏消息回调 GoodsMessageCallBack

发送商品推屏卡片#

方法API
/*
* 商品推屏消息 商品数据 msgInfo.goodsInfo 
* push_status: 推送状态;(0.未推送 1. 推送中 2.已推送)
*/
ExamMessageCallBack.pushGoodsCard(MessageServer.MsgInfo msgInfo, int push_status);

新增商品#

方法API
/*
* goodsInfo 填写商品信息 
* goods_list_cdn_url 商品列表 CDN 地址 用于快速更新列表
*/
ExamMessageCallBack.addGoodsInfo(GoodsInfoData.GoodsInfo goodsInfo, String goods_list_cdn_url);

删除商品#

方法API
/*
* del_goods_ids 删除或下架商品列表
* goods_list_cdn_url 商品列表 CDN 地址 用于快速更新列表
*/
ExamMessageCallBack.deleteGoods(List<String> del_goods_ids, String goods_list_cdn_url);

更新商品信息#

方法API
/*
* goodsInfo 填写商品信息 
* goods_list_cdn_url 商品列表 CDN 地址 用于快速更新列表
*/
ExamMessageCallBack.updateGoodsInfo(GoodsInfoData.GoodsInfo goodsInfo,String goods_list_cdn_url);

更新商品列表#

方法API
/*
* goods_list_cdn_url 商品列表 CDN 地址 用于快速更新列表
*/
ExamMessageCallBack.updateGoodsList(String goods_list_cdn_url);

订单状态改变#

方法API
/*
* orderInfo 订单信息
*/
GoodsMessageCallBack.orderStatusChange(OrderInfoData orderInfo);
修改于 2025-05-27 10:39:16
上一页
互动-公告
下一页
互动-计时器
Built with