You need to enable JavaScript to run this app.
导航
更新商品卡片浮窗展示状态
最近更新时间:2025.01.16 14:49:58首次发布时间:2024.04.12 16:32:09

调用 ExplainProduct 接口更新指定商品卡片的浮窗展示状态。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong17791****71580直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

ExplainStatus

Integer

1

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

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

说明

仅在开启直播时移功能时,该参数才生效。有关如何开启直播时移功能,详见直播时移

FloatingStatus

Integer

1

是否浮窗展示商品卡片。取值如下:

  • 1:是
  • 2:否

说明

仅在不开启直播时移功能时,该参数才生效。

ProductIdLong49**46商品卡片 ID。您可调用 GetActivityProducts 接口,通过 Products 参数中的 Id 获取 ID。

返回参数

参数类型示例值描述

Status

Boolean

true

是否更新成功。取值如下:

  • true:成功
  • false:失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=ExplainProduct&Version=2023-08-01
{
    "ActivityId": 17791****71580,
    "ProductId": 49**46,
    "ExplainStatus": 1,
    "FloatingStatus": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ExplainProduct",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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