调用 EnableActivityMultiProductExplain 接口,开启或关闭指定直播间的多商品讲解功能。
如需同时讲解多个商品,即将多个商品卡片高优展示在控制台和观看页的商品卡片菜单下,并以浮窗形式展示在观看页,请完成以下操作:
IsMultiProductExplainEnable 取值设置为 1,开启直播间的多商品讲解功能。EnableStatus 取值设置为 1,上架商品卡片。FloatingStatus 取值设置为 1,浮窗展示商品卡片。FloatingStatus 取值设置为 1,再将第 4 个商品卡片的 FloatingStatus 取值设置为 1 时,最早将 FloatingStatus 取值设置为 1 的商品卡片,其 FloatingStatus 取值会自动变更为 0。IsMultiProductExplainEnable 取值设置为 0 时,除最近将 FloatingStatus 取值设置为 1 的商品卡片外,其他商品卡片的 FloatingStatus 取值会自动变更为 0。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | EnableActivityMultiProductExplain | 接口名称。当前 API 的名称为 EnableActivityMultiProductExplain。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
IsMultiProductExplainEnable | Integer | 是 |
| 是否开启多商品讲解功能。取值如下:
说明 开启直播时移功能或商品脚本录制期间,无法开启多商品讲解功能。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否成功开启或关闭多商品讲解功能。成功返回 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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 403 | OperationDenied.DeniedByStreamTimeShift | Operation is denied because stream time shift is opened. | 开启直播时移功能期间,无法开启多商品讲解功能。请在关闭直播时移功能后重试。有关如何关闭直播时移功能,详见直播时移。 |
| 403 | OperationDenied.DeniedByRecordProductScript | Operation is denied because record product script is opened. | 开启商品脚本录制期间,无法开启多商品讲解功能。请在调用 UpdateInteractionScriptRecordConfig 接口将 EnableProductCard 的参数值设置为 false 后重试。 |