You need to enable JavaScript to run this app.
导航
更新内嵌链接配置信息
最近更新时间:2023.10.09 15:34:31首次发布时间:2022.09.16 15:19:09

更新菜单栏下自定义的内嵌链接的配置信息。

说明

  • 本接口已升级至 2023-08-01 版本,推荐您调用新版本的 UpdateActivityEmbeddedUrl 接口更新内嵌链接配置。
  • 在调用本接口前,您必须先完成以下操作:
    • 通过 API 接口或者控制台新增内嵌链接菜单,详见更新菜单栏列表接口和内嵌链接菜单
    • 先调用 获取内嵌链接配置信息 接口。在调用本接口时,按需修改 GetActivityEmbeddedUrlAPI 接口的返回参数值并传入本接口,即使某些配置信息无需修改,也必须将未修改的返回参数值传入本接口。

请求说明

  • 接口名称:UpdateActivityEmbeddedUrlAPI
  • 请求方式:POST
  • 接口地址:http://livesaas.volcengineapi.com/?Action=UpdateActivityEmbeddedUrlAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01

Body

参数类型是否必选描述
ActivityIdInt64直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID

EmbeddedWebAPIUrls

JSON Map

直播间内嵌链接菜单的序号和内嵌链接的配置。格式为 "Key":"Value",其中,

  • "Key" 为内嵌链接菜单的序号,可通过 GetActivityMenuAPI 接口获取。例如,内嵌链接菜单的序号 Location 为 2,则 "Key" 为 2;
  • "Value" 为内嵌链接的配置,配置信息参见 EmbeddedWebUrlAPIItem

EmbeddedWebUrlAPIItem

参数类型是否必选描述
IdInt配置项 ID,内嵌链接菜单的唯一标识。您可通过 GetActivityEmbeddedUrlAPI 接口查询 ID。Id 取值为 0 表示新增内嵌链接菜单配置项

MobileUrl

String

移动端内嵌链接。

说明

MobileUrlPCUrl 至少配置一个。

PCUrl

String

PC 端内嵌链接。

说明

MobileUrlPCUrl 至少配置一个。

返回参数

参数类型描述

success

Boolean

更新内嵌链接菜单操作状态。支持以下两种取值。

  • true:操作成功;
  • false:操作失败。

示例

请求示例

POST http://livesaas.volcengineapi.com/?Action=UpdateActivityEmbeddedUrlAPI&Version=2020-06-01
{
		"ActivityId":732412312,
		"EmbeddedWebAPIUrls":	{
				"1"	:	{
						"Id":	1234,
						"MobileUrl":	"http://123.com",
						"PCUrl":	"http://456.com"
				},
				"2"	:	{
						"Id":	0,
						"MobileUrl":	"http://777.com",
						"PCUrl":	"http://888.com"
				}
		}
}

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"201806041104200100100232280022D30",
				"Action":"UpdateActivityProductAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"success":true
		}
}

异常返回示例

{
		"ResponseMetadata":{
				"RequestId":"201806041104200100100232280022D30",
				"Action":"UpdateActivityProductAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132,
				"Error":{
						"Code":"200000",
						"Message:参数异常"
				}
		}
}

错误码

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