您可通过此接口获取直播间的直播状态、直播延时类型等直播间基础信息。
请求频率：单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetActivityAPI | 接口名称。当前 API 的名称为 GetActivityAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| ActivityId | Long | 是 | 17218460671 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 17218460671 | 直播间 ID。 |
| Name | String | 新年直播间 | 直播间名称。 |
| LiveTime | Long | 1642070520 | 直播开始时间。Unix 时间戳，单位为秒。 |
IsAutoEndEnable | Integer |
| 是否开启自动关播功能。支持以下取值：
|
| EndTime | Long | 1718078834 | 直播结束时间。Unix 时间戳，单位为秒。 |
CoverImage | String |
| 横屏直播的封面图 URL。
|
VerticalCoverImage | String |
| 竖屏直播的封面图 URL。若未设置该参数值，则默认读取
|
Status | Integer |
| 直播状态。支持以下取值：
|
| ViewUrl | String | https://live.xxx.com/xxx | 直播间的观看地址。 |
| IsPageViewEnable | Integer | - | 已废弃。 |
IsLockPreview | Integer |
| 是否锁定预告。支持以下取值：
|
| OwnerSubAccount | String | admin@bytedance.com | 创建直播间的账号信息。 返回 admin@bytedance.com 表示当前直播间由主账号创建。 |
LiveReviewStatus | Integer |
| 审核状态。支持以下取值：
|
LiveMode | Integer |
| 直播延时类型。支持以下取值：
|
GET https://livesaas.volcengineapi.com/?Action=GetActivityAPI&Version=2020-06-01&ActivityId=17218460671
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1" }, "Result": { "Id": 17218460671, "Name": "新年直播间", "LiveTime": 1642070520, "CoverImage": "https://image.xxx", "VerticalCoverImage": "https://image.xxx", "Status": 2, "ViewUrl": "https://live.xxx.com/xxx", "IsLockPreview": 1, "OwnerSubAccount": "admin@bytedance.com", "LiveReviewStatus": 6, "LiveMode": 1, "IsAutoEndEnable": 1, "EndTime": 1718078834 } }