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

文档中心

立即注册

导航

企业直播

ListMediasAPI - 获取回放视频列表

最近更新时间：2025.07.16 11:02:02首次发布时间：2022.03.29 22:10:12

调用 ListMediasAPI，获取指定直播间的回放视频列表。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListMediasAPI`	接口名称。当前 API 的名称为 `ListMediasAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`177588964960`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IsNeedTotalCount	Boolean	否	`true`	是否需要直播间回放视频总数。默认值为 `false`。取值如下： `true`：需要 `false`：不需要
PageNo	Integer	否	`1`	分页查询页码，默认值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量，默认值为 `10`。
Name	String	否	`A`	根据回放视频名称进行筛选。支持模糊搜索。
Vid	String	否	`v02a49g10000d1****vog65t6nkiqqh0`	根据视频 Vid 查询。不支持模糊搜索。您可以通过 ListActivityMediaAPI 接口获取视频 Vid。
OnlineStatus	Integer	否	`0`	回放视频上下架状态。默认获取所有状态下的回放视频。取值如下： `0`：下架 `1`：上架
StartTime	Long	否	`1751510600`	查询开始时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。
EndTime	Long	否	`1752526000`	查询结束时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

返回参数

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

Medias

参数	类型	示例值	描述
MediaId	String	`1`	回放列表视频 ID。您可调用 UpdateMediaOnlineStatusAPI 接口，通过该 ID，在指定直播间内上架、下架或解绑回放视频。
Name	String	`回放 A`	回放视频名称。
Duration	Integer	`5400`	回放视频时长，单位为秒。
SourceType	Integer	`1`	回放视频来源。取值如下： `1`：视频库或本地上传 `2`：直播结束后自动生成 `4`：直播伴侣云端录制生成
OnlineStatus	Integer	`0`	回放视频上下架状态。取值如下： `0`：下架 `1`：上架
Vid	String	`v02a49g10000d1****vog65t6nkiqqh0`	视频 Vid。
CreateTime	Long	`1751526600`	视频绑定直播间的时间。Unix 时间戳，单位为秒。
CoverImage	String	`//p-example.e.org/example.img`	视频封面图 URL。默认的封面图 URL 有协议头，通过控制台上传的封面图 URL 没有协议头。
StartTime	Long	`1751520600`	回放视频对应的直播开始时间。Unix 时间戳，单位为秒。例如直播于 2025-07-03 13:30:00 开始，2025-07-03 15:00:00 结束，则该参数取值为 `1751520600`。说明仅当 `SourceType` 取值为 `2` 或者 `4` 时，该参数生效。
EndTime	Long	`1751526000`	回放视频对应的直播结束时间。Unix 时间戳，单位为秒。例如直播于 2025-07-03 13:30:00 开始，2025-07-03 15:00:00 结束，则该参数取值为 `1751526000`。说明仅当 `SourceType` 取值为 `2` 或者 `4` 时，该参数生效。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListMediasAPI&Version=2020-06-01&ActivityId=177588964960&IsNeedTotalCount=true&PageNo=1&PageItemCount=10&Name=A&Vid=v02a49g10000d1****vog65t6nkiqqh0&OnlineStatus=0&StartTime=1751510600&EndTime=1752526000

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListMediasAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "TotalItemCount": 1,
        "Medias": [
            {
                "MediaId": "1",
                "Name": "回放 A",
                "Duration": 5400,
                "SourceType": 1,
                "OnlineStatus": 0,
                "Vid": "v02a49g10000d1****vog65t6nkiqqh0",
                "CreateTime": 1751526600,
                "CoverImage": "//p-example.e.org/example.img",
                "StartTime": 1751520600,
                "EndTime": 1751526000
            }
        ]
    }
}

错误码

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