ListMediasAPI - 获取回放视频列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListMediasAPI - 获取回放视频列表

最近更新时间：2025.03.21 16:48:05首次发布时间：2022.03.29 22:10:12

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

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的回放管理 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListMediasAPI`	接口名称。当前 API 的名称为 `ListMediasAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`177588964960`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsNeedTotalCount	Boolean	否	`true`	是否需要直播间回放视频总数。 `true`：需要 `false`：不需要
PageNo	Integer	否	`1`	分页查询页码，默认值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量，默认值为 `10`。
Name	String	否	`example`	根据回放视频名称进行筛选。支持模糊搜索。
Vid	String	否	`idexample`	根据视频媒资库 Vid 查询。不支持模糊搜索。说明使用子账号调用接口时，确保视频对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
OnlineStatus	Integer	否	`0`	回放视频上下架状态。默认获取所有状态下的回放视频。 `0`：下架 `1`：上架
StartTime	Integer	否	`1541154433670`	查询开始时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。
EndTime	Integer	否	`1541154433771`	查询结束时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

返回参数

参数	类型	示例值	描述
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`10`	分页查询数量。
TotalItemCount	Integer	`1`	直播间回放视频总数。
Medias	Array of Medias	`-`	回放视频信息列表。

Medias

参数	类型	示例值	描述
MediaId	String	`1`	回放列表视频 ID。用于操作回放视频的上架、下架和解绑。
Name	String	`example`	回放视频名称。
Duration	Integer	`111`	回放视频时长，单位秒。
SourceType	Integer	`1`	回放视频来源。支持以下取值： `1`：视频库或本地上传 `2`：回放自动生成 `4`：直播伴侣云端录制生成
OnlineStatus	Integer	`0`	回放视频上下架状态。支持以下取值： `0`：下架 `1`：上架
Vid	String	`idexample`	视频媒资库 ID。
CreateTime	Long	`1541154433671`	视频绑定直播间时间。
CoverImage	String	`//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"
        }
    }
}

错误码

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