You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/直播间管理/获取直播间列表信息（非实时）
获取直播间列表信息（非实时）
最近更新时间：2024.11.07 11:05:23首次发布时间：2022.09.15 14:09:14
我的收藏

您可通过此接口获取当前账号下直播列表中所有直播间的基础信息。相较于获取直播间列表信息 接口，提高了接口的请求频率（QPS）但获取的直播间信息存在一定的延时。

说明

本接口最多支持返回 10,000 条查询结果，您可以通过配置直播间状态 Status、开播时间 LiveTime 等查询条件，进行精准查询。

注意事项

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

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是ListActivityByCacheAPI接口名称。当前 API 的名称为 ListActivityByCacheAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。

Body

参数类型是否必选示例值描述

PageNo

Integer

否

1

分页查询页码，默认值为 1。
接口最多支持返回 10,000 条查询结果，即 PageNo × PageItemCount ≤ 10,000。

PageItemCount

Integer

否

10

分页查询数量，默认值为 10。
接口最多支持返回 10,000 条查询结果，即 PageNo × PageItemCount ≤ 10,000。

NameString否直播间 A直播间名称。支持模糊查询。

Status

Integer

否

0

直播状态。默认值为 0。取值如下：

  • 0：所有
  • 1：直播中
  • 2：预告
  • 3：回放
  • 4：已结束
LiveTimeLong否1642070520查询该开播时间及以后的直播。Unix 时间戳，单位为秒。

IsLockPreview

Integer

否

0

是否查询锁定预告数据。默认值为 0。取值如下：

  • -1：查询所有直播间
  • 0：查询非锁定预告的直播间
  • 1：查询锁定预告的直播间
SiteTagNewsArray of SiteTagNews否-分类标签信息。您可以通过 ListSiteTagAPIV2 接口获取分类标签信息。
HostAccountIdInteger否4582125直播间关联的主播/品牌方账号 ID。您可以通过 GetBusinessAccountInfoAPI 接口获取 ID。
HostAccountNameString否zhubo直播间关联的主播/品牌方名称。支持模糊查询。您可以通过 GetBusinessAccountInfoAPI 接口获取名称。

LiveReviewStatus

Integer

否

0

审核状态。默认值为 0。取值如下：

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

LiveMode

Integer

否

0

直播延时类型。默认值为 0。取值如下：

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

SortBy

String

否

Status

直播间排序规则。默认值为 Status。取值如下：

  • Status：先按照直播状态排序，再在每个状态下按照直播间的开播时间倒序排序
  • LiveTime：按照直播间的开播时间排序
  • CreateTime：按照直播间的创建时间排序

SortOrder

String

否

Desc

直播间排序规则的顺序。默认值为 Asc。取值如下：

  • Desc：倒序
  • Asc：正序

说明

当 SortBy 取值为 Status 时，直播状态的正序排序顺序为：直播、预告、回放、已结束。无论 SortOrder 取值如何，在每个状态下均按照直播间的开播时间倒序排序。

LiveLayout

Integer

否

2

直播模式。默认值为 0。取值如下：

  • 0：所有直播模式
  • 1：三分屏。主播画面和视频画面使用不同视频源，主播画面不会遮挡视频画面
  • 2：纯视频。主播画面和视频画面共用一个视频源，支持调整主播画面位置

SiteTagNews

参数类型是否必选示例值描述
ValueArray of String是["标签1","标签2"]分类标签的可选标签值。筛选时满足其中一项即可。

Name

String

否

分类标签

分类标签名称。

说明

Name 和 Index 传且仅传一个。

Index

Integer

否

0

分类标签的索引值，用于标识分类标签在控制台展示的位置，取值范围为 [0,19]。

说明

Name 和 Index 传且仅传一个。

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
TotalItemCountInteger1直播间总数量。
ActivitiesArray of Activities-直播间数据列表。

Activities

参数类型示例值描述
IdLong1772286780853直播间 ID。
NameString直播间 A直播间名称。

Status

Integer

2

直播状态。取值如下：

  • 1：直播中
  • 2：预告
  • 3：回放
  • 4：已结束
CoverImageStringhttps://p1-live.xxxx.image横屏直播的封面图 URL，包含协议头。
CreateTimeInteger1642070520直播间的创建时间。Unix 时间戳，单位为秒。
ViewUrlStringhttps://live.xxx.com/xxx直播间的观看地址。
LiveTimeInteger1642070525直播间的开播时间。Unix 时间戳，单位为秒。
StreamStartTimeInteger0直播推流时间。Unix 时间戳，单位为秒。

IsLockPreview

Integer

0

是否锁定预告。取值如下：

  • 0：否
  • 1：是
SiteTagsArray of SiteTags-直播间分类标签信息列表。
TextSiteTagsArray of TextSiteTags-直播间文本标签信息列表。
HostAccountIdInteger4582125直播间关联的主播/品牌方账号 ID。
HostAccountNameStringzhubo直播间关联的主播/品牌方名称。

LiveReviewStatus

Integer

2

审核状态。取值如下：

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

LiveMode

Integer

2

直播延时类型。取值如下：

  • 0：对于企业直播支持超低延时直播功能前创建的直播间，若未更新过直播延时类型，则取值为 0，表示普通延时直播。更多有关超低延时直播的功能介绍，详见超低延时直播。
  • 1：超低延时直播
  • 2：普通延时直播
VerticalCoverImageStringhttps://p2-live.xxxx.image竖屏直播的封面图 URL，包含协议头。
OnlineStatusInteger-已废弃。

LiveLayout

Integer

2

直播模式。取值如下：

  • 1：三分屏。主播画面和视频画面使用不同视频源，主播画面不会遮挡视频画面
  • 2：纯视频。主播画面和视频画面共用一个视频源，支持调整主播画面位置

SiteTags

参数类型示例值描述
NameString分类标签分类标签名称。
ValueString["标签1","标签2"]分类标签的标签值。
IndexInteger0分类标签的索引值，用于标识分类标签在控制台展示的位置。
DbIndexInteger-已废弃。
ShowInteger-已废弃。
IdInteger-已废弃。

TextSiteTags

参数类型示例值描述
NameString文本标签文本标签名称。
ValueString标签3文本标签值。
IndexInteger0文本标签的索引值，用于标识文本标签在控制台展示的位置。
DbIndexInteger-已废弃。
ShowInteger-已废弃。
IdInteger-已废弃。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListActivityByCacheAPI&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,
        "LiveLayout": 2
      }
    ]
  }
}

错误码

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