You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

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

最近更新时间2022.12.05 19:06:31

首次发布时间2022.06.30 10:59:06

使用网页开播时,您可能会需要免登录进入某直播间的开播界面。您可以调用该接口,获取指定直播间ActivityId的一键开播跳转地址 Url

当您获取跳转地址 Url 后,通过浏览器访问该地址,进入网页开播页面,您可免登录进入指定直播间ActivityId的开播界面。

请求说明

  • 接口名称:GetWebPushLiveClientAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=GetWebPushLiveClientAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64直播间 ID

返回参数

参数类型描述
UrlString跳转地址。您可通过该地址,免登录地进入对应直播间的网页开播界面

示例

请求示例

GET http://livesaas.volcengineapi.com/?Action=GetWebPushLiveClientAPI&Version=2020-06-01&ActivityId=17354589593406

正常返回示例

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

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"GetWebPushLiveClientAPI",
        "Version":"2020-06-01", 
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"invalid param"
        }
    }
}

错误码

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