You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取回放文件列表

最近更新时间：2023.06.30 11:49:31

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

我的收藏

获取指定直播间的回放文件列表。

请求说明

  • 接口名称：ListMediasAPI
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=ListMediasAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数

类型

是否必选

描述

Action

String

是

接口名称。

Version

String

是

接口版本。直播当前 API 的版本为 2020-06-01。

ActivityId

Int64

是

直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

IsNeedTotalCount

Bool

否

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

PageNo

Int

否

分页查询页码，默认值为 1。

PageItemCount

Int

否

分页查询数量，默认值为 10。

Name

String

否

根据回放名称查询，支持模糊匹配。

Vid

String

否

根据视频媒体库 Vid 查询，不支持模糊匹配。

OnlineStatus

Int

否

回放上下架状态。默认获取所有回放文件。

  • 0：下架状态
  • 1：上架状态

StartTime

Int

否

开始时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

EndTime

Int

否

结束时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

返回参数

参数

类型

描述

PageNo

Int

分页查询页码。

PageItemCount

Int

分页查询数量。

TotalItemCount

Int

直播间回放视频的总数。

Medias

Array of Media

回放信息列表。

Media

参数

类型

描述

MediaId

String

回放列表视频 ID，用于操作回放的上架、下架和解绑。

Name

String

视频名称。

Duration

Int

视频时长，单位秒。

SourceType

Int

视频来源。

  • 1：源自上传
  • 2：源自回放自动生成

OnlineStatus

Int

视频上下架状态。

  • 0：下架状态
  • 1：上架状态

Vid

String

视频媒体库 ID。

CreateTime

Int64

视频绑定直播间的时间。

CoverImage

String

视频封面图 URL。默认的封面图 URL 有协议头，通过控制台上传的封面图 URL 没有协议头。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListMediasAPI&Version=2020-06-01&ActivityId=1231231231&PageNo=1&PageItemCount=10

正常返回示例

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

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"ListMediasAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
   }
}

错误码

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