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

获取图文介绍配置

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

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

我的收藏

获取直播间图文介绍菜单的配置信息。

注意事项

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

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetActivityBands接口名称。当前 API 的名称为 GetActivityBands。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1772285976256直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

返回参数

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

GraphicIntroduction

参数类型示例值描述
IdLong789图文介绍菜单 ID。
TextString图文内容图文介绍菜单的内容。
MenuNameString图文介绍图文介绍菜单的名称。

IsEnable

Boolean

true

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

  • true：启用
  • false：不启用

示例

请求示例

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

返回示例

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