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

更新卡片浮窗展示状态

最近更新时间：2024.04.12 16:32:09

首次发布时间：2024.04.12 16:32:09

我的收藏

通过本接口，您可以修改指定卡片的浮窗展示状态，设置是否在观众页以浮窗形式显示目标卡片。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=ExplainProduct&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是ExplainProduct接口名称。当前 API 的名称为 ExplainProduct。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是17791682871580直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

ExplainStatus

Integer

是

1

讲解状态。支持以下取值。

  • 1：开始讲解
  • 2：讲解结束

说明

仅在开启直播时移功能时，该参数才生效。详见商品卡片。

FloatingStatus

Integer

是

1

卡片是否浮窗展示。支持以下两种取值：

  • 1：是
  • 2：否
ProductIdLong是492046卡片 ID。您可以通过 GetActivityProducts 接口查询 ID，即 Products 参数中的 id。

返回参数

参数类型示例值描述

Status

Boolean

true

是否更新成功。支持以下取值：

  • true：成功
  • false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=ExplainProduct&Version=2023-08-01
{
  "ActivityId": 17791682871580,
  "ExplainStatus": 1,
  "FloatingStatus": 1,
  "ProductId": 492046
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ExplainProduct",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Status": true
  }
}

错误码

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