获取菜单栏列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取菜单栏列表

最近更新时间：2023.11.08 09:30:19首次发布时间：2022.03.29 22:10:12

获取直播间菜单栏列表。

说明

仅支持获取已启用状态下的菜单。
本接口已升级至 2023-08-01 版本，推荐您调用新版本的 GetActivityMenus 接口获取菜单列表。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetActivityMenuAPI&Version=2020-06-01

请求参数

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

Query

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

返回参数

参数	类型	示例值	描述
Menu	Array of Menu	`-`	菜单栏信息

参数类型示例值描述

Name String 聊天互动 菜单名称

参数	类型	示例值	描述
Name	String	`聊天互动`	菜单名称
Type	Integer	`3`	菜单类别。支持以下取值。 1：图文 2：商品卡片 3：聊天互动 4：互动工具 5：聚合直播 6：互动问答 7：内嵌链接 8：私聊互动
Location	Integer	`1`	菜单序号，作为该菜单的标识。

Type

Integer

3

菜单类别。支持以下取值。

1：图文
2：商品卡片
3：聊天互动
4：互动工具
5：聚合直播
6：互动问答
7：内嵌链接
8：私聊互动

Location Integer 1 菜单序号，作为该菜单的标识。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityMenuAPI&Version=2020-06-01&ActivityId=1779168287158

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202310121024074243421F924E61FA0009",
    "Action": "GetActivityMenuAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1697077447
  },
  "Result": {
    "Menus": [
      {
      "Name": "聊天互动",
      "Type": 3,
      "Location": 1
      },
      {
        "Name": "互动工具",
        "Type": 4,
        "Location": 2
      }
    ]
  }
}

错误码

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