您可通过本接口更新指定卡片的浮窗展示状态。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ExplainProduct | 接口名称。当前 API 的名称为 ExplainProduct。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ActivityId | Long | 是 | 17791682871580 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
ExplainStatus | Integer | 是 |
| 讲解状态。支持以下取值。
说明 仅在开启直播时移功能时，该参数才生效。有关如何开启直播时移功能，详见直播时移。 |
FloatingStatus | Integer | 是 |
| 是否浮窗展示卡片。支持以下取值：
说明 仅在不开启直播时移功能时，该参数才生效。 |
| ProductId | Long | 是 | 492046 | 卡片 ID。您可以通过 GetActivityProducts 接口查询 ID，即 Products 参数中的 id。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | Boolean |
| 是否更新成功。支持以下取值：
|
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 } }