You need to enable JavaScript to run this app.
导航
获取直播间列表信息
最近更新时间:2024.03.19 10:48:02首次发布时间:2022.03.29 22:10:12

本接口用于获取当前账号下直播列表中所有直播间的基础信息。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListActivityAPI接口名称。当前 API 的名称为 ListActivityAPI
VersionString2020-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。

Name

String

直播间 A

直播间名称。支持模糊查询。
例如,Name 取值为 直播间 A 时,则返回直播间名称为 直播间 ABC直播间 a企业直播间 ab 等包含 直播间 A 关键词的直播间列表。

Status

Integer

0

直播状态。支持以下取值,默认取值为 0

  • 0:所有
  • 1:直播中
  • 2:预告
  • 3:回放
  • 4:已结束

说明

已结束指直播结束但未上架回放的状态。

LiveTimeLong1642070520查询该开播时间及以后的直播。Unix 时间戳,单位为秒。

IsLockPreview

Integer

0

是否查询已锁定预告的直播间。支持以下取值,默认取值为 0

  • -1:查询所有直播间
  • 0:查询非锁定预告的直播间
  • 1:查询锁定预告的直播间
SiteTagNewsArray of SiteTagNews根据分类标签信息进行筛选。您可以通过 ListSiteTagAPIV2 接口获取分类标签信息。
HostAccountIdInteger4582125直播间关联的主播/品牌方账号 ID。您可以通过 GetBusinessAccountInfoAPI 接口获取 ID。
HostAccountNameStringzhubo直播间关联的主播/品牌方名称。您可以通过 GetBusinessAccountInfoAPI 接口获取名称。

LiveReviewStatus

Integer

0

根据审核状态进行筛选。支持以下取值,默认取值为 0

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

LiveMode

Integer

0

根据直播延时类型进行筛选。支持以下取值,默认取值为 0

  • 0:所有直播
  • 1:超低延时直播(延时时间在 1 秒以内的直播)
  • 2:普通延时直播(延时时间在 5~10 秒的直播)

SiteTagNews

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

Name

String

分类标签

分类标签名称。

说明

NameIndex 传且仅传一个。

Index

Integer

0

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

说明

NameIndex 传且仅传一个。

返回参数

参数类型示例值描述
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-已废弃。

SiteTags

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

TextSiteTags

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

示例

请求示例

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
      }
    ]
  }
}

错误码

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