最近更新时间:2023.12.01 10:08:49
首次发布时间:2022.03.29 22:10:12
获取直播状态、直播延时类型等直播间基础信息。
请求频率:单用户请求频率限制为 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 时间戳,单位为秒。 |
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":"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 } }