tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

KickUserFromRoom

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

    1. API Description

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

    This API is used to remove a user from the room.

    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: KickUserFromRoom.
    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.
    UserId Yes String The ID of the user to be removed.
    KickType Yes Integer The removal type:
    1: Keep the user out temporarily. The Duration parameter specifies the ban duration, during which the user is banned from entering the room.
    2: Remove the user permanently.
    Duration Yes Integer The ban duration (seconds). This parameter is valid if KickType is 1. The default value is 0.

    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 永久踢除用户

    示例

    Input Example

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

{
    "RoomId": 313337981,
    "SdkAppId": 3520371,
    "UserId": "2PMcgEVHi9CMWq6tmfNnPGUkEGn",
    "KickType": 2,
    "Duration": 0
}

    Output Example

    {
    "Response": {
        "RequestId": "3f156f86-9939-4ea0-aee7-81d32fa46c3f"
    }
}

    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
    InternalError Internal error.
    ResourceNotFound.Room The room does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy