注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVideoRooms`	接口名称。当前 API 的名称为 `ListVideoRooms`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
SearchVideoRoomId	Long	否	`20001`	点播间 ID。您可以通过当前接口返回的 `VideoRoomId` 获取点播间 ID。
SearchVideoRoomName	String	否	`Python数据分析入门到应用`	点播间名称。支持模糊查询。例如，`Name` 取值为 `点播间 A` 时，则返回直播间名称为 `点播间 ABC`、`点播间 a`、`企业点播间 ab` 等包含 `点播间 A` 关键词的点播间列表。
PageNo	Integer	否	`1`	分页查询页码，默认值为 `1`。接口最多支持返回 10,000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 10,000。
PageItemCount	Integer	否	`10`	分页查询数量，取值范围为`1`到`100`，默认值为 `10`。接口最多支持返回 10,000 条查询结果，即 `PageNo` × `PageItemCount` ≤ 10,000。
SearchFollowerUserName	String	否	`teacher_a`	创建点播间的账号。默认获取所有账号创建的点播间。如需获取主账号创建的点播间，可将参数值设置为 `admin@bytedance.com`。如需获取子账号创建的点播间，可将参数值设置为子账号的账号。您可通过调用 ListSubAccounts 接口，获取子账号的账号。
SortBy	String	否	`CreateTime`	点播间排序规则。默认值为 `CreateTime`。目前仅支持传入 `CreateTime`，表示按照点播间的创建时间排序。
SortOrder	String	否	`Desc`	点播间排序规则的顺序。默认值为 `Desc`。取值如下： `Desc`：倒序 `Asc`：正序

返回参数

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

VideoRooms

参数	类型	示例值	描述
VideoRoomId	Integer	`20001`	点播间 ID。
AccountId	Integer	`30001`	点播间归属的账号 ID。
Name	String	`Python数据分析入门到应用`	点播间名称。
ViewUrl	String	`https://example.com/videoroom/20001`	点播间的观看地址。
CoverImage	String	`https://tplv-gjr25qtd0-image.image`	点播间的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。
CreateTime	Integer	`1710000000`	点播间的创建时间。Unix 时间戳，单位为秒。
ViewUrlNameSpace	String	`5545`	点播间观看地址中的路径标识，系统自动分配。例如，若观看地址为 `https://live.byteoc.com/5545/3085317`，则 `ViewUrlNameSpace` 的值为 `5545`。
VideoRoomClassification	Integer	`1`	点播间类型。目前固定为 `1`，表示知识课程类型的点播间。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListVideoRooms&Version=2023-08-01&SearchVideoRoomId=20001&SearchVideoRoomName=Python数据分析入门到应用&PageNo=1&PageItemCount=10&SearchFollowerUserName=teacher_a&SortBy=CreateTime&SortOrder=Desc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListVideoRooms",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "PageItemCount": 10,
        "PageNo": 1,
        "TotalItemCount": 1,
        "VideoRooms": [
            {
                "VideoRoomId": 20001,
                "AccountId": 30001,
                "Name": "Python数据分析入门到应用",
                "ViewUrl": "https://example.com/video-room/20001",
                "CoverImage": "https://tplv-gjr25qtd0-image.image",
                "CreateTime": 1710000000,
                "ViewUrlNameSpace": "5545",
                "VideoRoomClassification": 1
            }
        ]
    }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

VideoRooms #

请求示例 #

返回示例 #

错误码 #

注意事项

请求说明

调试

请求参数

Query

返回参数

VideoRooms

请求示例

返回示例

错误码