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

文档中心

立即注册

导航

企业直播

GetActivityMenus - 获取菜单列表

最近更新时间：2025.03.24 16:50:56首次发布时间：2023.09.22 10:49:48

您可通过此接口获取指定直播间中启用状态菜单的列表。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的菜单管理 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityMenus`	接口名称。当前 API 的名称为 `GetActivityMenus`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1776085489138`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数	类型	示例值	描述
Menus	Array of Menus	`-`	启用状态菜单的信息列表。

Menus

参数	类型	示例值	描述
Name	String	`图文介绍`	菜单名称。
Type	Integer	`1`	菜单类型。支持以下取值： `1`：图文介绍 `2`：商品卡片 `3`：聊天互动 `4`：互动工具 `5`：聚合直播 `6`：互动问答 `7`：内嵌链接 `8`：私聊互动
ToolId	Long	`915`	图文介绍菜单、商品卡片菜单和内嵌链接菜单的唯一标识。说明仅当 `Type` 取值为 `1`、`2` 和 `7` 时，该参数有意义。
Location	Integer	`-`	已废弃。

请求示例

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": 1
            },
            {
                "Name": "图文介绍A",
                "Type": 1,
                "ToolId": 688,
                "Location": 11
            },
            {
                "Name": "互动问答",
                "Type": 6,
                "ToolId": 0,
                "Location": 1
            }
        ]
    }
}

错误码

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