You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/开播工具相关/Version：2020-06-01/获取直播伴侣一键开播地址
获取直播伴侣一键开播地址
最近更新时间：2024.11.27 10:48: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

参数类型是否必选示例值描述
ActionString是GetDownloadLiveClientAPI接口名称。当前 API 的名称为 GetDownloadLiveClientAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1776****89138直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数类型示例值描述

Url

String

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

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

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

TmpUrl

String

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

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

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

请求示例

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

返回示例

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

错误码

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