1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to remove a user from a room. It is applicable to scenarios where the anchor, room owner, or admin wants to kick out a user. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.
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.
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: RemoveUser. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-07-22. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-singapore. |
| SdkAppId |
Yes |
Integer |
SDKAppId of TRTC. |
| RoomId |
Yes |
Integer |
Room number. |
| UserIds.N |
Yes |
Array of String |
List of up to 10 users to be removed. |
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 Removing users from a room
This example shows you how to remove users test1 and test2 from room 1234.
https:
&SdkAppId=1400000001
&RoomId=1234
&UserIds.0=test1
&UserIds.1=test2
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
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.RoomNotExist |
The room does not exist. |
| InternalError |
Internal error. |
| InternalError.GetRoomCacheIpError |
Failed to query the room. |
| InternalError.GetRoomFromCacheError |
Failed to get room information. |
| InvalidParameter.RoomId |
RoomId is incorrect. |
| InvalidParameter.SdkAppId |
SdkAppId is incorrect. |
| InvalidParameter.UserIds |
UserIds is incorrect. |
| InvalidParameterValue.RoomId |
Invalid RoomId. |
| MissingParameter.RoomId |
RoomId is missing. |
| MissingParameter.SdkAppId |
SdkAppId is missing. |
| MissingParameter.UserIds |
UserIds is missing. |
| UnauthorizedOperation.SdkAppId |
No permission to manipulate SdkAppId. |