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

文档中心

立即注册

导航

企业直播

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

最近更新时间：2024.09.13 17:07:37首次发布时间：2022.05.17 21:23:21

外部业务系统内接入调起直播伴侣客户端能力时，企业侧可在系统内设置好入口位置，调用本接口获取直播伴侣的一键开播地址。对接完成后单击入口位置，即可在自有系统内调起直播伴侣客户端，免登录进入指定直播间的开播界面。
alt

说明

本接口已升级至 2023-08-01 版本，推荐您调用新版本的 GetDownloadLiveClient 接口获取直播伴侣一键开播跳转地址。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetDownloadLiveClientAPI&Version=2020-06-01

请求参数

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

Query

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

返回参数

参数	类型	示例值	描述
Url	String	`http://livesaas.example.com/***`	跳转地址。您可通过该地址开启直播伴侣，进入直播间的开播界面。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetDownloadLiveClientAPI&Version=2020-06-01&ActivityId=1776085489138

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "GetDownloadLiveClientAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "Url": "http://livesaas.example.com/***"
  }
}

错误码

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