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

更新菜单排序、名称及启用状态

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

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

我的收藏

更新直播间中菜单的展示顺序、名称及启用状态。

说明

只有已进行配置并保存的菜单可以通过本接口更新排序、名称和启用状态。

注意事项

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

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是ModifyActivityMenus接口名称。当前 API 的名称为 ModifyActivityMenus。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是1772285976256直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

Menus

Array of Menus

是

-

菜单展示列表。

  • 该列表中的菜单将被设置为启用状态，并按照配置的顺序展示在观看页。
  • 未在该列表中的菜单将被设置为非启用状态。
参数类型是否必选示例值描述

Type

Integer

是

1

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

  • 1：图文介绍
  • 2：商品卡片
  • 3：聊天互动
  • 4：互动工具
  • 5：聚合直播
  • 6：互动问答
  • 7：内嵌链接
  • 8：私聊互动
NameString是图文介绍菜单名称。最多支持输入 20 个字符。

ToolId

Long

否

915

图文介绍菜单、商品卡片菜单或内嵌链接菜单的唯一标识。
您可以通过以下方式查询对应菜单的 ID：

说明

仅当 Type 取值为 1、2 和 7 时，该参数必填。

LocationInteger否-已废弃。

返回参数

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

ToolId

Long

915

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

说明

当 Type 取值为 1、2 和 7 时，返回菜单的唯一标识，否则无需关注该参数。

Type

Integer

1

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

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

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=ModifyActivityMenus&Version=2023-08-01
{
  "ActivityId": 1772285976256,
  "Menus": [
    {
      "Type": 1,
      "Name": "图文介绍",
      "ToolId": 915
    },
    {
      "Type": 1,
      "Name": "图文介绍A",
      "ToolId": 688
    },
    {
      "Type": 3,
      "Name": "聊天互动"
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "ModifyActivityMenus",
    "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": 2
        
      },
      {
        "Name": "聊天互动",
        "Type": 3,
        "ToolId": 0,
        "Location": 4
      }
    ]
  }
}