Domain name for API request: lcic.tencentcloudapi.com.
This API is used to start a room. Before you call this API, make sure a user has entered the room so that the class is initialized.
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: StartRoom. |
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. |
Parameter Name | Type | Description |
---|---|---|
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 end a room (the room ID passed in does not exist).
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartRoom
<Common request parameters>
{
"RoomId": 11111
}
{
"Response": {
"RequestId": "0479a5ea-0b81-4d94-845d-f57b23e52e4e"
}
}
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. |
FailedOperation.ClassEnded | Room status error. The room has ended. |
FailedOperation.ClassExpired | Room status error. The room has expired. |
FailedOperation.ClassStarted | Class status error. The class has already started. |
FailedOperation.RequestTimedOut | Request timed out. |
FailedOperation.RoomNotEnd | The class has not ended. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Invalid parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound.Room | The room does not exist. |
UnauthorizedOperation | Unauthorized operation. |
UnknownParameter | Unknown parameter error. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?