tencent cloud

フィードバック

RemoveUserByStrRoomId

最終更新日:2022-08-19 10:35:09

1. API Description

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

This API is used to remove a user from a room. It allows the anchor, room owner, or admin to kick out a user, and works on all platforms. For Android, iOS, Windows, and macOS, you need to update the TRTC SDK to version 6.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.

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: RemoveUserByStrRoomId.
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 String Room ID
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, which is returned for each request. 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 abcd.

Input Example

https://trtc.tencentcloudapi.com/?Action=RemoveUserByStrRoomId
&SdkAppId=1400000001
&RoomId=abcd
&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.
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.
お問い合わせ

カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

テクニカルサポート

さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

電話サポート(24 時間365日対応)