You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取商品卡片配置

最近更新时间：2023.10.09 15:34:31

首次发布时间：2022.03.29 22:10:12

我的收藏

获取菜单栏下商品卡片的配置信息。

说明

  • 仅支持获取已启用状态下的商品卡片菜单配置信息。
  • 本接口已升级至 2023-08-01 版本，推荐您调用新版本的 GetActivityProducts 接口获取商品卡片配置。

请求说明

  • 接口名称：GetActivityProductAPI
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=GetActivityProductAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数

类型

是否必选

描述

Action

String

是

接口名称

Version

String

是

接口版本。直播当前 API 的版本为 2020-06-01

ActivityId

Int64

是

直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID

返回参数

参数

类型

描述

-

JSON Map

商品卡片菜单的序号和卡片的配置。格式为 "Key":"Value"，其中，

  • "Key" 为商品卡片菜单的序号，即 GetActivityMenuAPI 接口中的 Location。例如，商品卡片菜单的序号 Location 为 2，则 "Key" 为 2；
  • "Value" 为商品卡片的配置，配置信息参见 ProductConfig。

ProductConfig

参数

类型

描述

EnableFloating

Bool

是否开启浮层。支持以下两种取值。

  • true：开启浮层
  • false：关闭浮层

EnableUA

Bool

是否开启直达链接。支持以下两种取值。

  • true：开启直达链接
  • false：关闭直达链接

UAAddress

String

开启直达链接后匹配的特点环境的 UA。

EnableMiniApp

Bool

是否开启微信小程序跳转。支持以下两种取值。

  • true：开启跳转
  • false：关闭跳转

MiniAppId

String

开启微信小程序跳转后，跳转的微信小程序的原始 ID。

ProductsPosition

Int

商品卡片在 PC 端观看页的展示位置。支持以下取值。

  • 0：右上角
  • 1：左上角
  • 2：左下角
  • 3：右下角

DefaultRedirectImage

String

商品卡片默认跳转图的 URL。默认为系统配置的跳转图，支持 JPG、GIF、PNG 和 BMP 格式的图片。

DisplayEnable

Int

是否显示商品卡片菜单。

  • 1：显示
  • 2：不显示

Product

Array of Product

商品卡片信息

Product

参数

类型

描述

Title

String

商品卡片名称

Highlight

String

商品卡片高亮文案

IntroduceImage

String

商品卡片介绍图的 URL

RedirectImage

String

商品卡片跳转图的 URL。
在控制台上添加商品卡片菜单时,有默认跳转图，且跳转图的 URL 有协议头。用户上传的跳转图的 URL 没有协议头。

RedirectUrl

String

商品卡片跳转地址的 URL

Index

Int

商品卡片的位置

Id

Int

商品卡片 ID

EnableStatus

Int

商品卡片是否上架。支持以下两种取值。

  • 0：不上架
  • 1：上架

Remark

String

商品的备注信息

Strikethrough

String

商品卡片上的灰色划线文字

DirectUrl

String

直达链接

ExplainStatus

Int32

讲解状态。开启直播时移功能才会显示本字段，详见商品卡片。

  • 0：未讲解；
  • 1：讲解中；
  • 2：讲解结束。

ExplainTime

Int64

最近一次修改讲解状态的时间。Unix 时间戳，单位秒。取值为 0 表示未修改过讲解状态。

FloatingStatus

Int32

是否浮窗展示商品卡片

  • 1：开启浮窗
  • 其他：关闭浮窗

MiniAppDirectUrl

String

微信小程序的跳转链接

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetActivityProductAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

{
      "ResponseMetadata":{
            "RequestId":"202201201826170101501312091D1C09D2",
            "Action":"GetActivityProductAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132
      },
      "Result":{
            "1":{
                  "EnableFloating":true,   
                  "EnableUA":true,
                  "UAAddress":"micromessenger",   
                  "EnableMiniApp":true,
                  "MiniAppId":"AppId",
                  "ProductsPosition":0,
                  "DefaultRedirectImage":"https://example.com",
                  "DisplayEnable": 1,
                  "Product":[
                        {
                              "Title":"1.2",   
                              "Highlight":"1.2",   
                              "IntroduceImage":"图片地址",   
                              "RedirectImage":"图片地址",   
                              "RedirectUrl":"重定向地址",   
                              "Index":0,
                              "Id":16014,   
                              "EnableStatus":1,
                              "Remark":"商品备注",
                              "Strikethrough":"划线文字",
                              "DirectUrl":"https://xxx",
                              "ExplainStatus":1,
                              "ExplainTime":0,
                              "FloatingStatus":1,
                              "MiniAppDirectUrl":"https://xxx.com"
                        }
                  ]
            }
      }
}

异常返回示例

{
      "ResponseMetadata":{
            "RequestId":"201806041104200100100232280022D30",
            "Action":"GetActivityProductAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132,
            "Error":{
                  "Code":"200000",
                  "Message":"参数异常"   
            }
      }
}

错误码

访问公共错误码获取详细信息。