最近更新时间:2023.06.09 18:21:44
首次发布时间:2022.04.12 16:05:53
修改指定卡片的浮窗展示状态,设置是否在观众端以浮窗形式显示目标卡片。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
ActivityId | Int64 | 是 | 直播间 ID |
ProductId | Int64 | 是 | 卡片 ID |
ExplainStatus | Int32 | 是 | 讲解状态。开启直播时移功能才会显示本字段,详见商品卡片。
|
FloatingStatus | Int32 | 是 | 该卡片是否浮窗展示。支持以下两种取值。
|
参数 | 类型 | 描述 |
---|---|---|
Status | Bool | 更新菜单操作状态。支持以下两种取值。
|
POST http://livesaas.volcengineapi.com/?Action=ExplainProductAPI&Version=2020-06-01 { "ActivityId":123, "ProductId":123, "ExplainStatus":1, "FloatingStatus":1 }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"ExplainProductAPI", "Version":"2020-06-01", "Service":"livesaas", "Region":"cn-north-1", "SystemTime":1656067132 }, "Result":{ "Status":true } }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"ExplainProductAPI", "Version":"2020-06-01", "Service":"livesaas", "Region":"cn-north-1", "SystemTime":1656067132, "Error":{ "Code":"200000", "Message":"参数异常" } } }
访问公共错误码获取详细信息。