本接口用于获取当前账号下直播列表中所有直播间的基础信息。
说明
本接口最多支持返回开播时间距离当前时间最近的前 10,000 条查询结果。您可以通过配置直播间状态 Status
、开播时间 LiveTime
等查询条件,进行精准查询。
请求频率:单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListActivityAPI | 接口名称。当前 API 的名称为 ListActivityAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PageNo | Integer | 否 |
| 分页查询页码,默认取值为 |
PageItemCount | Integer | 否 |
| 分页查询数量,默认取值为 |
Name | String | 否 |
| 直播间名称。支持模糊查询。 |
Status | Integer | 否 |
| 直播状态。支持以下取值,默认取值为
说明 已结束指直播结束但未上架回放的状态。 |
LiveTime | Long | 否 | 1642070520 | 查询该开播时间及以后的直播。Unix 时间戳,单位为秒。 |
IsLockPreview | Integer | 否 |
| 是否查询已锁定预告的直播间。支持以下取值,默认取值为
|
SiteTagNews | Array of SiteTagNews | 否 | 无 | 根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口获取分类标签信息。 |
HostAccountId | Integer | 否 | 4582125 | 直播间关联的主播/品牌方账号 ID。您可以通过 GetBusinessAccountInfoAPI 接口获取 ID。 |
HostAccountName | String | 否 | zhubo | 直播间关联的主播/品牌方名称。您可以通过 GetBusinessAccountInfoAPI 接口获取名称。 |
LiveReviewStatus | Integer | 否 |
| 根据审核状态进行筛选。支持以下取值,默认取值为
|
LiveMode | Integer | 否 |
| 根据直播延时类型进行筛选。支持以下取值,默认取值为
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Value | Array of String | 是 | ["标签1","标签2"] | 分类标签的可选标签值。筛选时满足其中一项即可。 |
Name | String | 否 |
| 分类标签名称。 说明
|
Index | Integer | 否 |
| 分类标签的索引值,用于标识分类标签在控制台展示的位置,取值范围为 [0,19]。 说明
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNo | Integer | 1 | 分页查询页码。 |
PageItemCount | Integer | 10 | 分页查询数量。 |
TotalItemCount | Integer | 1 | 直播间总数量。 |
Activities | Array of Activities | 无 | 直播间数据列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | Long | 1772286780853 | 直播间 ID。 |
Name | String | 直播间 A | 直播间名称。 |
Status | Integer |
| 直播状态。支持以下取值:
|
CoverImage | String | https://p1-live.xxxx.image | 横屏直播的封面图 URL,包含协议头。 |
CreateTime | Integer | 1642070520 | 直播间的创建时间。Unix 时间戳,单位为秒。 |
ViewUrl | String | https://live.xxx.com/xxx | 直播间的观看地址。 |
LiveTime | Integer | 1642070525 | 直播间的开播时间。Unix 时间戳,单位为秒。 |
StreamStartTime | Integer | 0 | 直播推流时间。Unix 时间戳,单位为秒。 |
IsLockPreview | Integer |
| 是否锁定预告。支持以下取值:
|
SiteTags | Array of SiteTags | 无 | 直播间分类标签信息列表。 |
TextSiteTags | Array of TextSiteTags | 无 | 直播间文本标签信息列表。 |
HostAccountId | Integer | 4582125 | 直播间关联的主播/品牌方账号 ID。 |
HostAccountName | String | zhubo | 直播间关联的主播/品牌方名称。 |
LiveReviewStatus | Integer |
| 审核状态。支持以下取值:
|
LiveMode | Integer |
| 直播延时类型。支持以下取值:
|
VerticalCoverImage | String | https://p2-live.xxxx.image | 竖屏直播的封面图 URL,包含协议头。 |
OnlineStatus | Integer | - | 已废弃。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | 分类标签 | 分类标签名称。 |
Value | String | ["标签1","标签2"] | 分类标签的标签值。 |
Index | Integer | 0 | 分类标签的索引值,用于标识分类标签在控制台展示的位置。 |
DbIndex | Integer | - | 已废弃。 |
Show | Integer | - | 已废弃。 |
Id | Integer | - | 已废弃。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | 文本标签 | 文本标签名称。 |
Value | String | 标签3 | 文本标签值。 |
Index | Integer | 0 | 文本标签的索引值,用于标识文本标签在控制台展示的位置。 |
DbIndex | Integer | - | 已废弃。 |
Show | Integer | - | 已废弃。 |
Id | Integer | - | 已废弃。 |
POST https://livesaas.volcengineapi.com/?Action=ListActivityAPI&Version=2020-06-01 { "PageNo": 1, "PageItemCount": 10, "SiteTagNews": [ { "Index": 0, "Value": [ "标签1", "标签2" ] } ] }
{ "ResponseMetadata": { "RequestId": "202201201826170101501312091D1C09D2", "Action": "ListActivityAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1656067132 }, "Result": { "PageNo": 1, "PageItemCount": 10, "TotalItemCount": 1, "Activities": [ { "Id": 1772286780853, "Name": "直播间 A", "Status": 2, "CoverImage": "https://p1-live.xxxx.image", "CreateTime": 1642070520, "ViewUrl": "https://live.xxx.com/xxx", "LiveTime": 1642070525, "StreamStartTime": 0, "IsLockPreview": 0, "SiteTags": [ { "Index": 0, "Name": "分类标签", "Value": ["标签1","标签2"], "DbIndex": 1, "Show": 0, "Id": 0 } ], "TextSiteTags": [ { "Index": 0, "Name": "文本标签", "Value": "标签3", "DbIndex": 1, "Show": 0, "Id": 0 } ], "HostAccountId": 4582125, "HostAccountName": "zhubo", "LiveReviewStatus": 2, "LiveMode": 2, "VerticalCoverImage": "https://p2-live.xxxx.image", "OnlineStatus": 0 } ] } }