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=GetActivityEmbeddedUrls&Version=2023-08-01

请求参数

Query

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

返回参数

参数类型示例值描述
EmbeddedUrlConfigsArray of EmbeddedUrlConfigs-内嵌链接菜单的配置信息列表。
VerticalIconUrlStringhttps//p.byted.org/tos-6ed59yyum2.png竖屏直播中内嵌链接菜单图标的 URL。

EmbeddedUrlConfigs

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

IsEnable

Boolean

true

是否启用内嵌链接菜单。支持以下取值：

  • true：启用
  • false：不启用
MenuNameString内嵌链接内嵌链接菜单的名称。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230825132142C80BB67AA2AA8B9B558E",
    "Action": "GetActivityEmbeddedUrls",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1692940902
  },
  "Result": {
    "EmbeddedUrlConfigs": [
      {
        "Id": 6837,
        "MobileUrl": "https://console.volcengine.com/livesaas",
        "PCUrl": "https://console.volcengine.com/livesaas",
        "IsEnable": true,
        "MenuName": "内嵌链接"
      }
    ],
    "VerticalIconUrl": "https://p.byted.org/tos-6ed59yyum2.png"
  }
}