修改卡片浮窗展示状态--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

修改卡片浮窗展示状态

最近更新时间：2023.11.08 09:30:19首次发布时间：2022.04.12 16:05:53

修改指定卡片的浮窗展示状态，设置是否在观众端以浮窗形式显示目标卡片。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=ExplainProductAPI&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ExplainProductAPI`	接口名称。当前 API 的名称为 `ExplainProductAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`17791682871580`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
ProductId	Long	是	`492046`	卡片 ID。您可以通过调用 GetActivityProductAPI 接口查询 ID。
ExplainStatus	Integer	是	`1`	讲解状态。开启直播时移功能才会显示本字段，详见商品卡片。 `1`：开始讲解 `2`：讲解结束
FloatingStatus	Integer	是	`1`	该卡片是否浮窗展示。支持以下两种取值。 `1`：开启浮窗 `2`：关闭浮窗

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	更新菜单操作状态。支持以下两种取值。 `true`：操作成功 `false`：操作失败

Status

Boolean

true

更新菜单操作状态。支持以下两种取值。

true：操作成功
false：操作失败

示例

请求示例

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

返回示例

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

错误码

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