1. 接口描述
接口请求域名： lcic.tencentcloudapi.com 。
获取房间事件,仅在课堂结束1小时内有效。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetRoomEvent。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| RoomId | 是 | Integer | 课堂Id。 示例值：301234567 |
| SdkAppId | 是 | Integer | 应用Id。 示例值：13465287 |
| Page | 是 | Integer | 起始页，1开始。keyword为空时有效。 示例值：1 |
| Limit | 是 | Integer | 每页个数。keyword为空时有效。一次性最多100条。 示例值：10 |
| Keyword | 否 | String | 搜索事件类型。有以下事件类型: RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束 CameraOn: 摄像头打开 CameraOff: 摄像头关闭 MicOn: 麦克风打开 MicOff: 麦克风关闭 ScreenOn: 屏幕共享打开 ScreenOff: 屏幕共享关闭 VisibleOn: 页面可见 VisibleOff: 页面不可见 示例值：RoomStart |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 该课堂的事件总数，keyword搜索不影响该值。 示例值：100 |
| Events | Array of EventInfo | 详细事件内容。包含相应的类型、发生的时间戳。 示例值：[{"Timestamp":1234,"EventType":"RoomStart","EventData":{"RoomId":123456}}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取房间事件
获取房间事件
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRoomEvent
<公共请求参数>
{
"RoomId": 1,
"SdkAppId": 13465287,
"Page": 1,
"Limit": 10,
"Keyword": ""
}输出示例
{
"Response": {
"Total": 1,
"Events": [
{
"Timestamp": 1,
"EventType": "MemberJoin",
"EventData": {
"RoomId": 1,
"UserId": "2d3FgsZRRB2EbRu5Cwe8Rd7R6Bc"
}
}
],
"RequestId": "e574aae1-lp02-4225-a2f8-9032h7199f5f0"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| ResourceNotFound.Room | 房间不存在。 |
