You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取菜单列表

最近更新时间：2024.03.14 16:57:10

首次发布时间：2023.09.22 10:49:48

我的收藏

获取直播间的菜单列表。

说明

仅支持获取已启用状态下的菜单。

注意事项

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

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetActivityMenus接口名称。当前 API 的名称为 GetActivityMenus。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1776085489138直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
MenusArray of Menus-菜单信息列表。
参数类型示例值描述
NameString图文介绍菜单名称。

Type

Integer

1

菜单类型。支持以下取值：

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

ToolId

Long

915

图文介绍菜单、商品卡片菜单和内嵌链接菜单的唯一标识。

说明

仅当 Type 取值为 1、2 和 7 时，该参数有意义。

LocationInteger-已废弃。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230825133338FEB489E706667980BD63",
    "Action": "GetActivityMenus",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1692941618
  },
  "Result": {
    "Menus": [
      {
        "Name": "图文介绍",
        "Type": 1,
        "ToolId": 915,
        "Location": 0
      },
      {
        "Name": "图文介绍A",
        "Type": 1,
        "ToolId": 688,
        "Location": 0
      },
    ]
  }
}