UpdateActivityBand - 新增或更新图文介绍菜单配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateActivityBand - 新增或更新图文介绍菜单配置信息

最近更新时间：2025.03.24 16:50:56首次发布时间：2023.09.22 10:49:48

调用 UpdateActivityBand 接口，新增图文介绍菜单，或更新已有图文介绍菜单的图文内容和菜单名称。

使用说明

接口行为

新增图文介绍菜单：在请求参数中不传 Id（图文介绍菜单 ID）或传入 Id 且参数取值为 0 ，即可新增图文介绍菜单。
更新图文介绍菜单信息：在请求参数中传入待更新信息的图文介绍菜单的 ID 作为 Id 参数值，即可更新该菜单。您可以通过 GetActivityBand 接口查询 ID。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1772285976256759`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
GraphicIntroduction	Object of GraphicIntroduction	否	`-`	图文介绍菜单的配置信息列表。
VerticalIconUrl	String	否	`https://p6-live.example.com/tplv-gjr78lqtd0-image.png`	竖屏直播中图文介绍菜单图标的 URL，需要包含协议头。不传则为默认图标。支持上传大小不超过 2 MB 的 PNG 格式的图片。建议尺寸 100*100px。

GraphicIntroduction

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

参数	类型	是否必选	示例值	描述
Id	Long	否	`789`	图文介绍菜单 ID。新增图文介绍菜单：不传该参数或传入该参数且取值为 `0`。更新图文介绍菜单信息：传入待更新信息的图文介绍菜单 ID。您可以通过 GetActivityBand 接口查询 ID。
Text	String	否	`图文内容`	图文介绍菜单的内容。说明新增图文介绍菜单时，该参数必传。支持输入 HTML（HyperText Markup Language，即超文本标记语言）。例如，内容“登录企业直播控制台，配置图文介绍菜单”，对应的 HTML 为`<p>登录<a href="https://console.volcengine.com/livesaas/liveManagement" target="_blank">企业直播控制台</a>，配置<strong>图文介绍</strong>菜单</p>`。
MenuName	String	否	`图文介绍`	图文介绍菜单的名称。最多支持输入 20 个字符。说明新增图文介绍菜单时，该参数必传。

Long

否

789

图文介绍菜单 ID。

新增图文介绍菜单：不传该参数或传入该参数且取值为 0。
更新图文介绍菜单信息：传入待更新信息的图文介绍菜单 ID。您可以通过 GetActivityBand 接口查询 ID。

Text

String

否

图文内容

图文介绍菜单的内容。

说明

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

MenuName

String

否

图文介绍

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

说明

新增图文介绍菜单时，该参数必传。

返回参数

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

GraphicIntroduction

参数	类型	示例值	描述
Text	String	`图文内容`	图文介绍菜单的内容。
MenuName	String	`图文介绍`	图文介绍菜单的名称。
Id	Long	`789`	图文介绍菜单 ID。

请求示例

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

返回示例

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

错误码

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