获取直播间链接信息--企业直播-火山引擎

文档中心

立即注册

导航

获取直播间链接信息

最近更新时间：2024.11.27 10:48:37首次发布时间：2024.04.23 11:50:18

您可通过此接口获取指定直播间的以下链接信息：PC 端和移动端的横竖屏观看页地址、直播伴侣一键开播地址、网页直播一键开播链接、直播助教平台的登录信息和连麦嘉宾的网页登录信息。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityLinks`	接口名称。当前 API 的名称为 `GetActivityLinks`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Integer	是	`17798****87296`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数	类型	示例值	描述
WebPushHostLink	Object of WebPushHostLink	`-`	网页直播一键开播地址。
LiveClientLink	Object of LiveClientLink	`-`	直播伴侣一键开播地址。
TeachAssistantLoginLinks	Array of TeachAssistantLoginLinks	`-`	直播助教平台的登录信息。说明仅当已创建直播助教账号时，该参数生效。您可通过调用 UpdateTeachAssistantAccount 接口，创建直播助教账号。
WebPushGuestLoginLink	Object of WebPushGuestLoginLink	`-`	连麦嘉宾的网页登录信息。嘉宾可使用该信息通过浏览器访问连麦页面，详见嘉宾。
AudienceLink	Object of AudienceLink	`-`	PC 端和移动端的横竖屏观看页地址。说明如果主持人开始观众连麦，观众可在该地址申请连麦。

WebPushHostLink

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	永久的网页直播一键开播地址。通过浏览器访问该地址，即可免登录进入直播间的网页开播页面。
TmpUrl	String	`http://livesaas.example.com/***`	临时的网页直播一键开播地址。在过期时间（`ExpireTime`）之前，通过浏览器访问该地址，即可免登录进入直播间的网页开播页面。
ExpireTime	Long	`1730044683`	临时网页直播一键开播地址的过期时间。Unix 时间戳，单位为秒。

LiveClientLink

参数类型示例值描述

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	直播伴侣的永久一键开播地址。若已安装直播伴侣，您可通过该链接免登录进入对应直播间的直播伴侣开播界面。若未安装直播伴侣，您可通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。
TmpUrl	String	`http://livesaas.example.com/***`	直播伴侣的临时一键开播地址。若已安装直播伴侣，在过期时间（`ExpireTime`）之前，您可通过该链接免登录进入对应直播间的直播伴侣开播界面。若未安装直播伴侣，在过期时间（`ExpireTime`）之前，您可通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。
ExpireTime	String	`1730044683`	临时一键开播地址的过期时间。Unix 时间戳，单位为秒。

Url

String

http://livesaas.example.com/***

直播伴侣的永久一键开播地址。

若已安装直播伴侣，您可通过该链接免登录进入对应直播间的直播伴侣开播界面。
若未安装直播伴侣，您可通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。

TmpUrl

String

http://livesaas.example.com/***

直播伴侣的临时一键开播地址。

若已安装直播伴侣，在过期时间（ExpireTime）之前，您可通过该链接免登录进入对应直播间的直播伴侣开播界面。
若未安装直播伴侣，在过期时间（ExpireTime）之前，您可通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。

ExpireTime String 1730044683 临时一键开播地址的过期时间。Unix 时间戳，单位为秒。

TeachAssistantLoginLinks

参数	类型	示例值	描述
LoginUrl	String	`http://livesaas.example.com/***`	直播助教平台的登录链接。
Password	String	`1****3`	直播助教平台的登录密码。

WebPushGuestLoginLink

参数类型示例值描述

LoginUrl String http://livesaas.example.com/*** 连麦嘉宾的网页登录地址。

参数	类型	示例值	描述
LoginUrl	String	`http://livesaas.example.com/***`	连麦嘉宾的网页登录地址。
EnableKey	Integer	`1`	是否开启连麦密钥。取值如下： `1`：开启 `2`：关闭
LinkKey	String	`1****6`	连麦密钥。说明仅当 `EnableKey` 取值为 `1` 时，该参数生效。

EnableKey

Integer

1

是否开启连麦密钥。取值如下：

1：开启
2：关闭

LinkKey

String

1****6

连麦密钥。

说明

仅当 EnableKey 取值为 1 时，该参数生效。

AudienceLink

参数	类型	示例值	描述
LandscapeModeUrl	String	`http://livesaas.example.com/***`	PC 端和移动端横屏模式的观看页地址。
PortraitMoedeUrl	String	`http://livesaas.example.com/***`	移动端竖屏模式的观看页地址。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityLinks&Version=2023-08-01&ActivityId=17798****87296

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetActivityLinks",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1696067132
    },
    "Result": {
        "WebPushHostLink": {
            "Url": "http://livesaas.example.com/***",
            "TmpUrl": "http://livesaas.example.com/***",
            "ExpireTime": 1730044683
        },
        "LiveClientLink": {
            "Url": "http://livesaas.example.com/***",
            "TmpUrl": "http://livesaas.example.com/***",
            "ExpireTime": 1730044683
        },
        "TeachAssistantLoginLinks": [
            {
                "LoginUrl": "http://livesaas.example.com/***",
                "Password": "1****3"
            }
        ],
        "AudienceLink": {
            "LandscapeModeUrl": "http://livesaas.example.com/***",
            "PortraitMoedeUrl": "http://livesaas.example.com/***"
        },
        "WebPushGuestLoginLink": {
            "LoginUrl": "http://livesaas.example.com/***",
            "EnableKey": 1,
            "LinkKey": "1****6"
        }
    }
}

错误码

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