You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取直播间基础信息

最近更新时间：2023.12.01 10:08:49

首次发布时间：2022.03.29 22:10:12

我的收藏

获取直播状态、直播延时类型等直播间基础信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetActivityAPI接口名称。当前 API 的名称为 GetActivityAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是17218460671直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
IdLong17218460671直播间 ID。
NameString新年直播间直播间名称。
LiveTimeLong1642070520直播间的开播时间。Unix 时间戳，单位为秒。

CoverImage

String

https://image.xxx

横屏直播的封面图 URL。

  • 若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。
  • 若通过调用 API 接口配置横屏直播封面，则封面图的 URL 有协议头。

VerticalCoverImage

String

https://image.xxx

竖屏直播的封面图 URL。若未设置该参数值，则默认读取 CoverImage 的值。

  • 若通过控制台配置竖屏直播封面图且配置成功，则封面图的 URL 无协议头。
  • 若通过调用 API 接口配置竖屏直播封面，则封面图的 URL 有协议头。

Status

Integer

2

直播状态。支持以下取值：

  • 1：直播中
  • 2：预告
  • 3：回放
  • 4：已结束
ViewUrlStringhttps://live.xxx.com/xxx直播间的观看地址。
IsPageViewEnableInteger-已废弃。

IsLockPreview

Integer

1

是否锁定预告。支持以下取值：

  • 0：否
  • 1：是
OwnerSubAccountStringadmin@bytedance.com创建直播间的账号信息。 返回 admin@bytedance.com 表示当前直播间由主账号创建。

LiveReviewStatus

Integer

6

审核状态。支持以下取值：

  • 1：审核中
  • 2：审核通过
  • 3：审核驳回
  • 4：审核归档
  • 5：草稿
  • 6：无需审核

LiveMode

Integer

1

直播延时类型。支持以下取值：

  • 1：超低延时直播
  • 2：普通延时直播

示例

请求示例

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

返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
				"Action":"GetActivityAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"Id":17218460671,      
				"Name":"新年直播间",
				"LiveTime":1642070520,
				"CoverImage":	"https://image.xxx",
				"VerticalCoverImage":"https://image.xxx",
				"Status":2,
				"ViewUrl":"https://live.xxx.com/xxx",           
				"IsPageViewEnable": 1,
				"IsLockPreview":1,				
				"OwnerSubAccount":"admin@bytedance.com",
				"LiveReviewStatus": 6,
				"LiveMode":1	
		}
}

错误码

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