You need to enable JavaScript to run this app.
导航

更新菜单栏列表

最近更新时间2023.11.08 09:30:19

首次发布时间2022.03.29 22:10:12

更新菜单栏列表。

说明

  • 通过该接口最多支持创建 5 个菜单。
  • 本接口已升级至 2023-08-01 版本,推荐您调用新版本的 ModifyActivityMenus 接口更新菜单排序及启用状态。

注意事项

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

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateActivityMenuAPI&Version=2020-06-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringUpdateActivityMenuAPI接口名称。当前 API 的名称为 UpdateActivityMenuAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01

Body

参数类型是否必选示例值描述
ActivityIdLong732412312直播间 ID
MenusArray of Menus-直播间菜单配置
参数类型是否必选示例值描述
NameString菜单名称2菜单名称

Type

Integer

2

菜单类型。支持以下两种取值。

  • 2:卡片菜单;
  • 7:内嵌链接菜单。
LocationInteger2菜单序号,作为该菜单的标识。

返回参数

参数类型示例值描述

Status

Boolean

true

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

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

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityMenuAPI&Version=2020-06-01
{
  "ActivityId": 732412312,
  "Menus": [
    {
      "Name": "菜单名称1",
      "Type": 2,
      "Location": 1
    },
    {
      "Name": "菜单名称2",
      "Type": 2,
      "Location": 2
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateActivityMenuAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Status": true
  }
}

错误码

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