You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取菜单栏列表

最近更新时间：2023.09.22 10:49:47

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

我的收藏

获取直播间菜单栏列表。

说明

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

请求说明

  • 接口名称：GetActivityMenuAPI
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=GetActivityMenuAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64是直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID

返回参数

参数类型描述
MenuArray of Menu菜单栏信息
参数类型描述
NameString菜单名称

Type

Int

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

  • 1：图文
  • 2：商品卡片
  • 3：聊天互动
  • 4：互动工具
  • 5：聚合直播
  • 6：互动问答
  • 7：内嵌链接
  • 8：私聊互动
LocationInt菜单序号，作为该菜单的标识。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetActivityMenuAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

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

异常返回示例

{
		"ResponseMetadata":{
				"RequestId":"201806041104200100100232280022D30",
				"Action":"GetActivityMenuAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132,
				"Error":{
						"Code":"200000",
						"Message":"参数异常"			
				}
		}
}

错误码

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