You need to enable JavaScript to run this app.
导航
EnableActivityMultiProductExplain - 开启或关闭多商品讲解功能
最近更新时间:2025.07.03 10:40:31首次发布时间:2025.07.03 10:40:31
我的收藏
有用
有用
无用
无用

调用 EnableActivityMultiProductExplain 接口,开启或关闭指定直播间的多商品讲解功能。

使用说明

接口行为

如需同时讲解多个商品,即将多个商品卡片高优展示在控制台和观看页的商品卡片菜单下,并以浮窗形式展示在观看页,请完成以下操作:

  1. 调用该接口,将 IsMultiProductExplainEnable 取值设置为 1,开启直播间的多商品讲解功能。
  2. 调用 ExplainProduct 接口,将商品卡片的 FloatingStatus 取值设置为 1,浮窗展示商品卡片。

直播间内最多支持同时讲解 3 个商品。如果当前已有 3 个商品卡片处于浮窗展示状态,则通过以上操作浮窗展示商品卡片后,最早处于浮窗展示状态的商品卡片将被取消浮窗展示状态。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播控制可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

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

调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ActivityId

Long

1776****89138

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

IsMultiProductExplainEnable

Integer

1

是否开启多商品讲解功能。取值如下:

  • 0:关闭
  • 1:开启

说明

开启直播时移功能或商品脚本录制期间,无法开启多商品讲解功能。

返回参数

参数类型示例值描述
StatusBooleantrue是否成功开启或关闭多商品讲解功能。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=EnableActivityMultiProductExplain&Version=2023-08-01
{
    "ActivityId": 1776****89138,
    "IsMultiProductExplainEnable": 1
}

返回示例

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

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
403OperationDenied.DeniedByStreamTimeShiftOperation is denied because stream time shift is opened.开启直播时移功能期间,无法开启多商品讲解功能。请在关闭直播时移功能后重试。有关如何关闭直播时移功能,详见直播时移
403OperationDenied.DeniedByRecordProductScriptOperation is denied because record product script is opened.开启商品脚本录制期间,无法开启多商品讲解功能。请在调用 UpdateInteractionScriptRecordConfig 接口将 EnableProductCard 的参数值设置为 false 后重试。