You need to enable JavaScript to run this app.
导航
GetActivityBands - 获取图文介绍菜单的配置信息
最近更新时间:2025.03.24 16:50:56首次发布时间:2023.09.22 10:49:48
我的收藏
有用
有用
无用
无用

您可通过此接口获取指定直播间中图文介绍菜单的配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

ActivityId

Long

1772285976256

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

返回参数

参数类型示例值描述
GraphicIntroductionArray of GraphicIntroduction-图文介绍菜单的配置信息列表。
VerticalIconUrlStringhttps://p6-live.com/tplv-gjr78lqtd0-image.png竖屏直播中图文介绍菜单图标的 URL。包含协议头。

GraphicIntroduction

参数类型示例值描述
IdLong789图文介绍菜单 ID。

IsEnable

Boolean

true

是否启用图文介绍菜单。支持以下取值:

  • true:启用
  • false:不启用
MenuNameString图文介绍图文介绍菜单的名称。
TextString图文内容图文介绍菜单的内容。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityBands",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "GraphicIntroduction": [
            {
                "IsEnable": true,
                "Id": 789,
                "MenuName": "图文介绍",
                "Text": "图文内容"
            }
        ],
        "VerticalIconUrl": "https://p6-live.com/tplv-gjr78lqtd0-image.png"
    }
}

错误码

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