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

更新图文介绍配置

最近更新时间：2023.11.08 09:30:21

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

我的收藏

更新直播间图文介绍菜单的配置信息。

注意事项

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

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong是1772285976256759直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
GraphicIntroductionObject of GraphicIntroduction否图文介绍菜单的配置信息列表。
VerticalIconUrlString否https://p6-live.byteimg.com/tplv-gjr78lqtd0-image.png竖屏直播中图文介绍菜单图标的 URL，需要包含协议头。支持上传大小不超过 2 MB 的 PNG 格式的图片。建议尺寸 100*100px。

GraphicIntroduction

参数类型是否必选示例值描述

Id

Long

否

789

图文介绍菜单 ID。您可以通过调用 GetActivityBand 接口查询 ID。

说明

不传该参数或取值为 0 时，表示新增图文介绍菜单。

Text

String

否

图文内容

图文介绍菜单的内容。

说明

支持输入 HTML（HyperText Markup Language，即超文本标记语言）。例如，内容“登录企业直播控制台，配置图文介绍菜单”，对应的 HTML 为<p>登录<a href="https://console.volcengine.com/livesaas/liveManagement" target="_blank">企业直播控制台</a>，配置<strong>图文介绍</strong>菜单</p>。

MenuNameString否图文菜单图文介绍菜单的名称。最多支持输入 20 个字符。

返回参数

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

GraphicIntroductionResponse

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

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityBand&Version=2023-08-01
{
  "ActivityId": 1772285976256759,
  "GraphicIntroduction": {
    "Id": 789,
    "Text": "图文内容",
    "MenuName": "图文菜单"
  },
  "VerticalIconUrl": "https://p6-live.byteimg.com/tplv-gjr78lqtd0-image.png"
}

返回示例

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