tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyRoom

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

    1. API Description

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

    This API is used to modify a room.
    A maximum of 20 requests can be initiated per second for this API.

    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: ModifyRoom.
    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 SDKAppID assigned by LCIC.
    StartTime No Integer The room start time (Unix timestamp).
    EndTime No Integer The room end time (Unix timestamp).
    TeacherId No String The user ID of the teacher. User IDs are returned by the user registration APIs.
    Name No String The room name.
    Resolution No Integer The resolution. Valid values: 1: SD; 2: HD; 3: FHD.
    MaxMicNumber No Integer The maximum number of mic-on users (excluding the teacher). Value range: 0-16.
    AutoMic No Integer Whether to automatically turn the mic on when a user enters the room. Valid values: 0: No (default value); 1: Yes.
    AudioQuality No Integer Whether to enable the high audio quality mode. Valid values: 0: No (default value); 1: Yes.
    SubType No String The room subtype. Valid values: videodoc: Document + Video; video: Video only; coteaching: Dual-teacher.
    DisableRecord No 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.N No Array of String The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.
    GroupId No String The ID of the group to bind.
    EnableDirectControl No Integer Whether the students' consent is required to control their cameras/microphones.

    3. Output Parameters

    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.

    4. Example

    Example1 Modifying room parameters

    This example shows you how to modify room parameters.

    Input Example

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

{
    "RoomId": 1,
    "StartTime": 1,
    "EndTime": 1,
    "TeacherId": "abc",
    "Name": "abc",
    "Resolution": 1,
    "MaxMicNumber": 1,
    "AutoMic": 1,
    "AudioQuality": 1,
    "SubType": "abc",
    "DisableRecord": 1,
    "Assistants": [
        "abc"
    ],
    "SdkAppId": 1,
    "GroupId": "abc",
    "EnableDirectControl": 1
}

    Output Example

    {
    "Response": {
        "RequestId": "abc"
    }
}

    Example2 示例

    修改类型

    Input Example

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

{
    "RoomId": 368760996,
    "SdkAppId": 3520371
}

    Output Example

    {
    "Response": {
        "RequestId": "50034c8f-cd77-43f2-815e-afe990fb023d"
    }
}

    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

    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.ClassStarted Class status error. The class has already started.
    FailedOperation.ClassTooLong A class session cannot be longer than five hours.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.Content Prohibited content (pornographic, terrorist, politically sensitive) detected.
    InvalidParameter.EndTime The end time cannot be earlier than the current time.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameter.StartTime The start time cannot be earlier than the current time.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    ResourceNotFound.Room The room does not exist.
    ResourceNotFound.User The user does not exist.
    UnknownParameter Unknown parameter error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy