You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

修改卡片浮窗展示状态

最近更新时间2023.06.09 18:21:44

首次发布时间2022.04.12 16:05:53

修改指定卡片的浮窗展示状态,设置是否在观众端以浮窗形式显示目标卡片。

请求说明

  • 接口名称:ExplainProductAPI
  • 请求方式:POST
  • 接口地址:http://livesaas.volcengineapi.com/?Action=ExplainProductAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数

类型

是否必选

描述

Action

String

接口名称

Version

String

接口版本。直播当前 API 的版本为 2020-06-01

Body

参数

类型

是否必选

描述

ActivityId

Int64

直播间 ID

ProductId

Int64

卡片 ID

ExplainStatus

Int32

讲解状态。开启直播时移功能才会显示本字段,详见商品卡片

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

FloatingStatus

Int32

该卡片是否浮窗展示。支持以下两种取值。

  • 1:开启浮窗;
  • 2:关闭浮窗。

返回参数

参数

类型

描述

Status

Bool

更新菜单操作状态。支持以下两种取值。

  • true:操作成功;
  • false:操作失败。

示例

请求示例

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":"参数异常" 
        }
    }
}

错误码

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