获取直播伴侣一键开播跳转地址--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播伴侣一键开播跳转地址

最近更新时间：2024.06.28 10:58:15首次发布时间：2024.06.28 10:58:15

您可通过此接口获取指定直播间的一键开播跳转地址。在安装直播伴侣的系统中访问该地址，系统会自动打开直播伴侣，并免登录进入该直播间的开播界面。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetDownloadLiveClient`	接口名称。当前 API 的名称为 `GetDownloadLiveClient`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数类型是否必选示例值描述

ActivityId Long 是 1776085489138 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1776085489138`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
LoginType	Integer	否	`0`	用户类型。支持以下取值，默认取值为 `0`。 `0` ：主持人，即可获取直播伴侣的一键开播跳转地址。 `1`：嘉宾，即可获取嘉宾连麦的直播伴侣登录链接。
UserName	String	否	`主持人`	用户昵称。最多支持输入 15 个字符。说明 `LoginType` 取值为 `1` 时，该参数必传。

LoginType

Integer

否

0

用户类型。支持以下取值，默认取值为 0。

0 ：主持人，即可获取直播伴侣的一键开播跳转地址。
1：嘉宾，即可获取嘉宾连麦的直播伴侣登录链接。

UserName

String

否

主持人

用户昵称。最多支持输入 15 个字符。

说明

LoginType 取值为 1 时，该参数必传。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	直播伴侣一键开播跳转地址或嘉宾连麦的直播伴侣登录链接。当 `LoginType` 取值为 `0` 时，即为直播伴侣一键开播跳转地址。若已安装直播伴侣，您可以通过该链接免登录进入对应直播间的直播伴侣开播界面。若未安装直播伴侣，您可以通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。当 `LoginType` 取值为 `1` 时，即为嘉宾连麦的直播伴侣登录链接。若已安装直播伴侣，您可以通过该链接免登录进入对应直播间的嘉宾连麦界面。若未安装直播伴侣，您可以通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的嘉宾连麦界面。

Url

String

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

直播伴侣一键开播跳转地址或嘉宾连麦的直播伴侣登录链接。

当 LoginType 取值为 0 时，即为直播伴侣一键开播跳转地址。
- 若已安装直播伴侣，您可以通过该链接免登录进入对应直播间的直播伴侣开播界面。
- 若未安装直播伴侣，您可以通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的直播伴侣开播界面。
当 LoginType 取值为 1 时，即为嘉宾连麦的直播伴侣登录链接。
- 若已安装直播伴侣，您可以通过该链接免登录进入对应直播间的嘉宾连麦界面。
- 若未安装直播伴侣，您可以通过该地址下载安装直播伴侣。再次单击该地址，即可免登录进入对应直播间的嘉宾连麦界面。

请求示例

POST https://livesaas.volcengineapi.com/?Action=GetDownloadLiveClient&Version=2023-08-01
{
    "ActivityId": 1776085489138
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetDownloadLiveClient",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1696067132
    },
    "Result": {
        "Url": "http://livesaas.example.com/***"
    }
}

错误码

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