ListVideoRoomMedias - 获取点播间内视频列表--企业直播-火山引擎

文档中心

企业直播

请输入

点播间管理

ListVideoRoomMedias - 获取点播间内视频列表

调用 ListVideoRoomMedias 接口，获取指定点播间内的视频列表信息。

注意事项

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

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListVideoRoomMedias&Version=2023-08-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVideoRoomMedias`	接口名称。当前 API 的名称为 `ListVideoRoomMedias`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
VideoRoomId	Integer	是	`20001`	点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。
PageNo	Integer	否	`1`	分页查询页码，默认值为 `1`。接口最多支持返回 10,000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 10,000。
PageItemCount	Integer	否	`10`	分页查询数量，取值范围为`1`到`100`，默认值为 `10`。接口最多支持返回 10,000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 10,000。
Name	String	否	`视频 A`	视频名称。支持模糊查询。例如，`Name` 取值为 `视频 A` 时，则返回视频名称为 `视频 ABC`、`视频 a`、`回放视频 ab` 等包含 `视频 A` 关键词的视频列表。

返回参数

参数	类型	示例值	描述
TotalItemCount	Integer	`2`	点播间内视频的总数量。
Medias	Array of Medias	`-`	视频列表。
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`10`	分页查询数量。

Medias

参数	类型	示例值	描述
Duration	Integer	`3600`	视频时长，单位为秒。
Vid	String	`v02a49g10000d1****vog65t6nkiqqh0`	视频的 Vid。
OnlineStatus	Integer	`1`	视频的上下架状态，点播间场景下，该参数默认为`1`。取值如下： `0`：下架 `1`：上架
CreateTime	Integer	`1710000000`	视频关联点播间的时间。Unix 时间戳，单位为秒。
CoverImage	String	`https://tplv-gjr25qtd0-image.image`	点播间的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。
MediaId	Integer	`50001`	点播间视频列表中的视频 ID。
Name	String	`第一章`	视频名称。
SourceType	Integer	`1`	视频来源。取值如下： `1`：视频库或本地上传 `2`：直播结束后自动生成 `4`：直播伴侣云端录制生成
StartTime	Integer	`1710000100`	查询开始时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。
EndTime	Integer	`1710003700`	查询结束时间，Unix 时间戳，单位为秒。大于 0 为有效筛选条件。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListVideoRoomMedias&Version=2023-08-01&VideoRoomId=20001&PageNo=1&PageItemCount=10&Name=课程视频

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListVideoRoomMedias",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TotalItemCount": 2,
        "Medias": [
            {
                "Duration": 3600,
                "Vid": "v02a49g10000d1****vog65t6nkiqqh0",
                "OnlineStatus": 1,
                "CreateTime": 1710000000,
                "CoverImage": "https://tplv-gjr25qtd0-image.image",
                "MediaId": 50001,
                "Name": "第一章",
                "SourceType": 1,
                "StartTime": 1710000100,
                "EndTime": 1710003700
            }
        ],
        "PageNo": 1,
        "PageItemCount": 10
    }
}

错误码

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

最近更新时间：2026.06.24 11:45:18

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

Medias #

请求示例 #

返回示例 #

错误码 #