低代码互动课堂产品更名公告
关于低代码互动课堂升级的公告
Domain name for API request: lcic.intl.tencentcloudapi.com.
This API is used to get the events of a room. It only works within one hour after a class ends.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetRoomEvent. |
| Version | Yes | String | Common Params. The value used for this API: 2022-08-17. |
| Region | No | String | Common Params. This parameter is not required. |
| RoomId | Yes | Integer | The room ID. |
| SdkAppId | Yes | Integer | The application ID. |
| Page | Yes | Integer | The starting page. Pagination starts from 1. This parameter is valid only if keyword is empty. |
| Limit | Yes | Integer | The maximum number of records (up to 200) per page. This parameter is valid only if keyword is empty. |
| Keyword | No | String | The type of events to query. Valid values:RoomStart: The class started.RoomEnd: The class ended.MemberJoin: A user joined.MemberQuit: A user left.RecordFinish: Recording is finished. |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | The total number of events for the room. The value of this parameter is not affected by keyword. |
| Events | Array of EventInfo | The event details, including the type and time. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to get the events of a room.
POST / HTTP/1.1
Host: lcic.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRoomEvent
<Common request parameters>
{
"RoomId": 1,
"SdkAppId": 1234,
"Page": 1,
"Limit": 10,
"Keyword": ""
}{
"Response": {
"Total": 1,
"Events": [
{
"Timestamp": 1,
"EventType": "abc",
"EventData": {
"RoomId": 1,
"UserId": "abc"
}
}
],
"RequestId": "abc"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| ResourceNotFound.Room | The room does not exist. |
文档反馈