You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取回放文件列表

最近更新时间：2024.01.04 11:49:00

首次发布时间：2022.03.29 22:10:12

我的收藏

获取指定直播间的回放视频列表。

注意事项

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

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是ListMediasAPI接口名称。当前 API 的名称为 ListMediasAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是177588964960直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

IsNeedTotalCount

Boolean

否

true

是否需要直播间回放视频总数。

  • true：需要
  • false：不需要
PageNoInteger否1分页查询页码，默认值为 1。
PageItemCountInteger否10分页查询数量，默认值为 10。
NameString否example根据回放视频名称进行筛选。支持模糊搜索。
VidString否idexample根据视频媒资库 Vid 查询。不支持模糊搜索。

OnlineStatus

Integer

否

0

回放视频上下架状态。默认获取所有状态下的回放视频。

  • 0：下架
  • 1：上架
StartTimeInteger否1541154433670查询开始时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。
EndTimeInteger否1541154433771查询结束时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
TotalItemCountInteger1直播间回放视频总数。
MediasArray of Medias-回放视频信息列表。

Medias

参数类型示例值描述
MediaIdString1回放列表视频 ID。用于操作回放视频的上架、下架和解绑。
NameStringexample回放视频名称。
DurationInteger111回放视频时长，单位秒。

SourceType

Integer

1

回放视频来源。支持以下取值：

  • 1：视频库或本地上传
  • 2：回放自动生成

OnlineStatus

Integer

0

回放视频上下架状态。支持以下取值：

  • 0：下架
  • 1：上架
VidStringidexample视频媒资库 ID。
CreateTimeLong1541154433671视频绑定直播间时间。
CoverImageString//p-example.e.org/example.img视频封面图 URL。默认的封面图 URL 有协议头，通过控制台上传的封面图 URL 没有协议头。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListMediasAPI&Version=2020-06-01&ActivityId=177588964960&IsNeedTotalCount=true&PageNo=1&PageItemCount=10&Name=example&Vid=idexample&OnlineStatus=0&StartTime=1541154433670&EndTime=1541154433771

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D5",
    "Action": "ListMediasAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "TotalItemCount": 1,
    "PageNo": 1,
    "PageItemCount": 10,
    "Medias": {
      "MediaId": "1",
      "Name": "example",
      "Duration": 111,
      "SourceType": 1,
      "OnlineStatus": 0,
      "Vid": "idexample",
      "CreateTime": 1541154433671,
      "CoverImage": "//p-example.e.org/example.img"
    }
  }
}

错误码

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