1. 接口描述
接口请求域名: lcic.tencentcloudapi.com 。
获取房间列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetRooms。 |
Version | 是 | String | 公共参数,本接口取值:2022-08-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 低代码平台的SdkAppId。 示例值:234331324 |
StartTime | 否 | Integer | 开始时间。默认以当前时间减去半小时作为开始时间。 示例值:1708921829 |
EndTime | 否 | Integer | 结束时间。默认以当前时间加上半小时作为结束时间。 示例值:1708936229 |
Page | 否 | Integer | 分页查询当前页数,从1开始递增 示例值:1 |
Limit | 否 | Integer | 默认是10条 示例值:10 |
Status.N | 否 | Array of Integer | 课堂状态。默认展示所有课堂,0为未开始,1为正在上课,2为已结束,3为已过期 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 示例值:40 |
Rooms | Array of RoomItem | 房间列表 示例值:[{"Name":"课件展示","RoomId":352310919,"Status":1,"StartTime":1700029180,"EndTime":1708990380,"RealStartTime":17089018212,"RealEndTime":0,"Resolution":1,"MaxRTCMember":5,"ReplayUrl":"","RecordUrl":"","MaxMicNumber":1000,"EnableDirectControl":1,"InteractionMode":0,"VideoOrientation":0,"IsGradingRequiredPostClass":0,"RoomType":0,"EndDelayTime":0,"LiveType":0,"RecordLiveUrl":"","EnableAutoStart":0,"RecordBackground":""}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRooms
<公共请求参数>
{
"SdkAppId": 1,
"StartTime": 1,
"EndTime": 1,
"Page": 1,
"Limit": 1,
"Status": [
0,
1,
2,
3
]
}
输出示例
{
"Response": {
"Total": 1,
"Rooms": [
{
"Name": "abc",
"RoomId": 1,
"Status": 1,
"StartTime": 1,
"EndTime": 1,
"RealStartTime": 1,
"RealEndTime": 1,
"Resolution": 1,
"MaxRTCMember": 1,
"ReplayUrl": "abc",
"RecordUrl": "abc",
"MaxMicNumber": 1,
"EnableDirectControl": 1,
"InteractionMode": 0,
"VideoOrientation": 0,
"IsGradingRequiredPostClass": 0,
"RoomType": 0,
"EndDelayTime": 0,
"LiveType": 1,
"RecordLiveUrl": "abc",
"EnableAutoStart": 1,
"RecordBackground": "abc"
}
],
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ClassEnded | 房间状态错误,房间已结束。 |
FailedOperation.ClassExpired | 房间状态错误,房间已过期。 |
FailedOperation.RequestTimedOut | 请求超时 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |