低代码互动课堂产品更名公告
关于低代码互动课堂升级的公告
Domain name for API request: lcic.intl.tencentcloudapi.com.
This API is used to get room information.
A maximum of 20 requests can be initiated per second for this API.
A maximum of 50 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: DescribeRoom. |
| 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 | Room ID |
| RTMPStreamingURL | No | Integer | Request RTMP stream link, 0: no, 1: yes, default is 0. |
| Parameter Name | Type | Description |
|---|---|---|
| Name | String | Room name |
| StartTime | Integer | Reserved room start time, in UNIX timestamp format |
| EndTime | Integer | Reserved room end time, in UNIX timestamp format |
| TeacherId | String | Teacher ID |
| SdkAppId | Integer | LCIC SdkAppId |
| AudienceType | Integer | Watch type. Can have the following values: 1 interactive viewing 2 standard viewing |
| Resolution | Integer | Resolution. Valid values: 1: SD; 2: HD; 3: FHD |
| MaxMicNumber | Integer | Maximum number of mic-on users (excluding teachers). Value range: [0, 16] |
| AutoMic | Integer | Whether to automatically turn the mic on when the user enters a room. Valid values: 0: No (default value); 1: Yes. |
| AudioQuality | Integer | Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes. |
| SubType | String | The room subtype. Valid values: videodoc: Document + Video; video: Video only. |
| DisableRecord | Integer | Whether to disable auto recording. Valid values: 0: No (default); 1: Yes. If this parameter is 0, recording will start when the class starts and stops when the class ends. |
| Assistants | Array of String | Assistant ID list Note: This field may return null, indicating that no valid values can be obtained. |
| RecordUrl | String | Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained. |
| GroupId | String | Note: This field may return null, indicating that no valid values can be obtained. |
| EnableDirectControl | Integer | Whether the students' consent is required to control their cameras/microphones. |
| InteractionMode | Integer | Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants |
| VideoOrientation | Integer | Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type |
| IsGradingRequiredPostClass | Integer | Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled |
| RoomType | Integer | Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class) |
| VideoDuration | Integer | Recording Duration |
| EndDelayTime | Integer | Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes |
| LiveType | Integer | Live type: 0 regular (default) 1 Simulated Live |
| RecordLiveUrl | String | Simulated Live link |
| EnableAutoStart | Integer | Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid |
| RecordBackground | String | Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being |
| RTMPStreamingURL | String | RTMP stream link |
| RecordScene | String | Record customized scene, only recordlayout=9 this parameter is valid |
| RecordLang | String | Record customized language, only when recordlayout=9, this parameter is valid |
| 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 details of a classroom.
POST / HTTP/1.1
Host: lcic.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoom
<Common request parameters>
{
"RoomId": 1
}{
"Response": {
"AutoMic": 1,
"RecordUrl": "https://example.com/test.mp4",
"Name": "test",
"AudioQuality": 1,
"MaxMicNumber": 1,
"SubType": "videodoc",
"SdkAppId": 1,
"RequestId": "test",
"StartTime": 1,
"TeacherId": "test",
"Assistants": [
"test"
],
"EndTime": 1,
"Resolution": 1,
"DisableRecord": 1,
"Status": 0,
"EnableDirectControl": 0,
"GroupId": "afdg"
}
}This example shows you how to obtain the room information.
POST / HTTP/1.1
Host: lcic.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoom
<common request parameters>
{
"RoomId": 331450358
}{
"Response": {
"Assistants": [],
"AudienceType": 1,
"AudioQuality": 0,
"AutoMic": 0,
"DisableRecord": 0,
"EnableDirectControl": 0,
"EndTime": 1687943391,
"GroupId": "",
"InteractionMode": 1,
"IsGradingRequiredPostClass": 0,
"MaxMicNumber": 2,
"Name": "Test1",
"RecordUrl": "",
"RequestId": "a8dea9b9-5172-4c01-a53d-5a53437f7fdf",
"Resolution": 1,
"RoomType": 1,
"SdkAppId": 3923193,
"StartTime": 1687943339,
"Status": 0,
"SubType": "video",
"TeacherId": "2O2bjPEXxStIac3NC9kfH3mHeBC",
"VideoDuration": 0,
"VideoOrientation": 1
}
}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. |
| ResourceNotFound.Room | The room does not exist. |
文档反馈