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

文档中心

立即注册

导航

企业直播

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

最近更新时间：2025.03.24 16:50:54首次发布时间：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
    }
}

错误码

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