DeleteRoomMember

Download

Focus Mode

Font Size

Last updated: 2026-06-11 10:55:51

1. API Description

Domain name for API request: gme.intl.tencentcloudapi.com.

This API is used to delete a room or remove members from the room.

A maximum of 200 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: DeleteRoomMember.
Version	Yes	String	Common Params. The value used for this API: 2018-07-11.
Region	No	String	Common Params. This parameter is not required.
RoomId	Yes	String	ID of the target room
DeleteType	Yes	Integer	Operation type. `1`: Delete a room; `2`: Remove members
BizId	Yes	Integer	Application ID
Uids.N	No	Array of String	List of the members to remove
StrUids.N	No	Array of String	List of users to exclude (string type)

3. Output Parameters

Parameter Name	Type	Description
DeleteResult	DeleteResult	Result of the operation to delete a room or remove a member
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 Removing two members from the room

This example shows you how to Remove two members from the room.

Input Example

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

{
    "DeleteType": "2",
    "RoomId": "100",
    "BizId": "140014556",
    "Uids": [
        "2",
        "1"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "dfe39c29-ce97-44df-ba79-7d947d465694",
        "DeleteResult": {
            "Code": 0,
            "ErrorMsg": ""
        }
    }
}

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.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameterValue.InvalidDeleteType	The input deletion type must be 1 or 2.
InvalidParameterValue.InvalidStrUin	There is no need to fill in StrUid; please fill in Uid.
InvalidParameterValue.InvalidUinOrStrUin	Cannot input both uid and strUid.
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Operation unsupported.
UnsupportedOperation.LimitDeleteExceeded	Maximum number of kicks exceeded

Help and Support

Was this page helpful?

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

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Game Multimedia Engine