获取网页直播一键开播地址--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取网页直播一键开播地址

最近更新时间：2024.11.27 10:48:37首次发布时间：2022.06.30 10:59:06

您可通过此接口获取指定直播间的永久和临时网页直播一键开播地址。通过浏览器访问该地址，即可免登录进入直播间的网页开播页面。

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

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

请求示例

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

返回示例

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

错误码

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