获取内嵌链接配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取内嵌链接配置信息

最近更新时间：2023.09.22 10:49:48首次发布时间：2022.09.16 15:19:09

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

说明

本接口已升级至 2023-08-01 版本，推荐您调用新版本的 GetActivityEmbeddedUrls 接口获取内嵌链接配置。
仅支持获取已启用状态下的内嵌链接菜单配置信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称
Version	String	是	接口版本。直播当前 API 的版本为 2020-06-01
ActivityId	Int64	是	直播间 ID。您可通过 ListActivityAPI 接口查询 ID

返回参数

参数类型描述

参数	类型	描述
-	JSON Map	内嵌链接菜单的序号和内嵌链接的配置。格式为 `"Key":"Value"`，其中， `"Key"` 为内嵌链接菜单的序号，即 GetActivityMenuAPI 接口中的 `Location`。例如，内嵌链接菜单的序号 `Location` 为 2，则 `"Key"` 为 2； `"Value"` 为内嵌链接的配置，配置信息参见 EmbeddedWebUrlAPIItem。

JSON Map

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

"Key" 为内嵌链接菜单的序号，即 GetActivityMenuAPI 接口中的 Location。例如，内嵌链接菜单的序号 Location 为 2，则 "Key" 为 2；
"Value" 为内嵌链接的配置，配置信息参见 EmbeddedWebUrlAPIItem。

EmbeddedWebUrlAPIItem

参数	类型	描述
Id	Int	配置项 ID，内嵌链接菜单的唯一标识。
MobileUrl	String	移动端内嵌链接
PCUrl	String	PC 端内嵌链接

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetActivityEmbeddedWebUrlAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
				"Action":"GetActivityProductAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"1":{
						"Id":	1234,
						"MobileUrl":	"http://xxx",
						"PCUrl":	"http://yyy"
				}
		}
}

异常返回示例

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

错误码

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