You need to enable JavaScript to run this app.
导航
UpdateActivityEmbeddedUrl - 新增或更新内嵌链接菜单配置信息
最近更新时间:2025.03.24 16:50:56首次发布时间:2023.09.22 10:49:48
我的收藏
有用
有用
无用
无用

您可通过此接口新增内嵌链接菜单,或更新已有内嵌链接菜单的菜单名称、移动或 PC 端内嵌链接等配置信息。

使用说明

接口行为

  • 新增内嵌链接菜单:在请求参数中不传 Id(内嵌链接 ID)或传入 Id 且参数取值为 0 ,即可新增内嵌链接菜单。
  • 更新内嵌链接菜单信息:在请求参数中传入待更新信息的内嵌链接菜单的 ID 作为 Id 参数值,即可更新该菜单。您可以通过 GetActivityEmbeddedUrls 接口查询 ID。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

ActivityId

Long

1772285976256759

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

说明

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

EmbeddedUrlConfigObject of EmbeddedUrlConfig-内嵌链接菜单的配置信息列表。
VerticalIconUrlStringhttps://p6-live.example.com/tos-cn-i-gjr78lqtd0.png竖屏直播中内嵌链接菜单图标的 URL,需要包含协议头。不传则为默认图标。支持上传大小不超过 2 MB 的 PNG 格式的图片。建议尺寸 100*100px。

EmbeddedUrlConfig

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

Id

Long

771

内嵌链接菜单 ID。

  • 新增内嵌链接菜单:不传该参数或传入该参数且取值为 0
  • 更新内嵌链接菜单信息:传入待更新信息的内嵌链接菜单 ID。您可以通过 GetActivityEmbeddedUrls 接口查询 ID。

MobileUrl

String

https://console.volcengine.com/livesaas

移动端内嵌链接。需要包含协议头。

说明

MobileUrlPCUrl 至少配置一个。

PCUrl

String

https://console.volcengine.com/livesaas

PC 端内嵌链接。需要包含协议头。

说明

MobileUrlPCUrl 至少配置一个。

MenuName

String

内嵌链接

内嵌链接菜单的名称。最多支持输入 20 个字符。

说明

新增内嵌链接菜单时,该参数必传。

返回参数

参数类型示例值描述
EmbeddedUrlConfigObject of EmbeddedUrlConfig-内嵌链接菜单的配置信息列表。
VerticalIconUrlStringhttps://p6-live.example.com/tos-cn-i-gjr78lqtd0.png竖屏直播中内嵌链接菜单图标的 URL。包含协议头。

EmbeddedUrlConfig

参数类型示例值描述
IdLong771内嵌链接菜单 ID。
PCUrlStringhttps://console.volcengine.com/livesaasPC 端内嵌链接。包含协议头。
MenuNameString内嵌链接内嵌链接菜单的名称。
MobileUrlStringhttps://console.volcengine.com/livesaas移动端内嵌链接。包含协议头。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityEmbeddedUrl&Version=2023-08-01
{
    "ActivityId": 1772285976256759,
    "EmbeddedUrlConfig": {
        "Id": 771,
        "MenuName": "内嵌链接",
        "MobileUrl": "https://console.volcengine.com/livesaas",
        "PCUrl": "https://console.volcengine.com/livesaas"
    },
    "VerticalIconUrl": "https://p6-live.byteimg.com/tos-cn-i-gjr78lqtd0.png"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateActivityEmbeddedUrl",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1692933161
    },
    "Result": {
        "EmbeddedUrlConfig": {
            "Id": 771,
            "PCUrl": "https://console.volcengine.com/livesaas",
            "MenuName": "内嵌链接",
            "MobileUrl": "https://console.volcengine.com/livesaas"
        },
        "VerticalIconUrl": "https://p6-live.byteimg.com/tos-cn-i-gjr78lqtd0.png"
    }
}

错误码

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