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

文档中心

立即注册

导航

企业直播

获取直播间链接信息

最近更新时间：2024.06.25 12:10:43首次发布时间：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	是	`17798539487296`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数	类型	示例值	描述
WebPushHostLink	Object of WebPushHostLink	`-`	网页开播链接。
LiveClientLink	Object of LiveClientLink	`-`	直播伴侣启动链接。
TeachAssistantLoginLinks	Array of TeachAssistantLoginLinks	`-`	直播助教平台的登录信息。如需获取直播助教平台的登录信息，确保已创建直播助教账号。详见直播助教。
WebPushGuestLoginLink	Object of WebPushGuestLoginLink	`-`	连麦嘉宾的网页登录信息。更多有关嘉宾连麦的功能介绍，详见嘉宾连麦。
AudienceLink	Object of AudienceLink	`-`	PC 端和移动端横竖屏的观看页地址。说明若主持人开启观众连麦，您可以在观看页申请加入连麦。详见观众连麦。

WebPushHostLink

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	网页开播链接。您可以通过该地址，免登录进入对应直播间的网页开播界面。

LiveClientLink

参数类型示例值描述

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	直播伴侣启动链接。若已安装直播伴侣，您可以通过该链接免登录进入对应直播间的直播伴侣开播界面。若未安装直播伴侣，您可以通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。

Url

String

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

直播伴侣启动链接。

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

TeachAssistantLoginLinks

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

WebPushGuestLoginLink

参数类型示例值描述

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

参数	类型	示例值	描述
LoginUrl	String	`http://livesaas.example.com/***`	连麦嘉宾的网页登录地址。
EnableKey	Integer	`1`	是否开启连麦密钥。支持以下取值： `1`：开启 `2`：关闭
LinkKey	String	`123456`	连麦密钥。

EnableKey

Integer

1

是否开启连麦密钥。支持以下取值：

1：开启
2：关闭

LinkKey String 123456 连麦密钥。

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=17798539487296

返回示例

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

错误码

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