获取图文介绍菜单的配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取图文介绍菜单的配置信息

最近更新时间：2024.07.19 10:43:04首次发布时间：2023.09.22 10:49:48

您可通过此接口获取指定直播间中图文介绍菜单的配置信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetActivityBands&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityBands`	接口名称。当前 API 的名称为 `GetActivityBands`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1772285976256`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数	类型	示例值	描述
GraphicIntroduction	Array of GraphicIntroduction	`-`	图文介绍菜单的配置信息列表。
VerticalIconUrl	String	`https://p6-live.com/tplv-gjr78lqtd0-image.png`	竖屏直播中图文介绍菜单图标的 URL。包含协议头。

GraphicIntroduction

参数	类型	示例值	描述
Id	Long	`789`	图文介绍菜单 ID。
IsEnable	Boolean	`true`	是否启用图文介绍菜单。支持以下取值： `true`：启用 `false`：不启用
MenuName	String	`图文介绍`	图文介绍菜单的名称。
Text	String	`图文内容`	图文介绍菜单的内容。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityBands&Version=2023-08-01&ActivityId=1772285976256

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetActivityBands",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1692940902
  },
  "Result": {
    "GraphicIntroduction": [
      {
        "Id": 789,
        "IsEnable": true,
        "MenuName": "图文介绍",
        "Text": "图文内容"        
      }
    ],
    "VerticalIconUrl": "https://p6-live.com/tplv-gjr78lqtd0-image.png"
  }
}