GetRooms

Last updated: 2024-04-01 19:34:21

GetRooms

Last updated: 2024-04-01 19:34:21

1. API Description

Domain name for API request: lcic.tencentcloudapi.com.

This API is used to get the room list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: GetRooms.
Version	Yes	String	Common Params. The value used for this API: 2022-08-17.
Region	No	String	Common Params. This parameter is not required.
SdkAppId	Yes	Integer	The SDKAppID assigned by LCIC.
StartTime	No	Integer	The start time. The default start time is 30 minutes before the current time.
EndTime	No	Integer	The end time. The default end time is 30 minutes after the current time.
Page	No	Integer	The page to return records from. Pagination starts from 1.
Limit	No	Integer	The number of records per page. The default is 10.
Status.N	No	Array of Integer	Classroom status. Default display all classes, 0 is not started, 1 is in class, 2 is finished, 3 is expired

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	The total number of rooms.
Rooms	Array of RoomItem	The room list.
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.

4. Example

Example1 Getting a list of rooms

This example shows you how to get a list of rooms.

Input Example

POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRooms
<Common request parameters>

{
    "SdkAppId": 1,
    "StartTime": 1,
    "EndTime": 1,
    "Page": 1,
    "Limit": 1
}

Output Example

{
    "Response": {
        "Total": 1,
        "Rooms": [
            {
                "Name": "abc",
                "RoomId": 1,
                "Status": 1,
                "StartTime": 1,
                "EndTime": 1,
                "RealStartTime": 1,
                "RealEndTime": 1,
                "Resolution": 1,
                "MaxRTCMember": 1,
                "ReplayUrl": "abc",
                "EnableDirectControl": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.
FailedOperation.ClassEnded	Room status error. The room has ended.
FailedOperation.ClassExpired	Room status error. The room has expired.
FailedOperation.RequestTimedOut	Request timed out.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter.
OperationDenied	Operation denied.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud