機能とサーバーインターフェース
  • クラウドレコーディング
  • CDN へのストリーミング
  • TRTC を介して RTMP との相互接続を実現
  • イベントコールバック
    • イベントコールバック
    • バイパスリレーコールバック
    • クラウドレコーディングのコールバック
    • サイン検証の例
  • メッセージの送受信
  • アクセス管理
    • Overview
    • 認可可能なリソースおよび操作
    • プリセットされたポリシー
    • カスタムポリシー
  • 高度な権限制御の有効化
  • OBS WHIP 経由で TRTC ルームにプッシュする方法
  • サーバー API
    • インターフェースのカテゴリー
    • 過去の記録
    • インターフェースリクエストの発行
      • リクエスト構造
      • 一般的なパラメータ
      • サイン方法 v3
      • サイン
      • 返信
    • ルーム管理インターフェース
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 通話品質モニタリングインターフェース
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • プッシュ取得の関連インターフェース
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • クラウドレコーディングインターフェース
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • ミクスストリーミング転送の関連インターフェース
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 使用量統計関連インターフェース
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • データタイプ
    • エラーコード
    • 付録
      • イベント ID マッピングテーブル
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

RemoveUser

1. API Description

Domain name for API request: trtc.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.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: RemoveUser.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-singapore.
SdkAppIdYesIntegerSDKAppId of TRTC.
RoomIdYesIntegerRoom number.
UserIds.NYesArray of StringList of up to 10 users to be removed.

3. Output Parameters

Parameter NameTypeDescription
RequestIdStringThe 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.

Input Example

https://trtc.tencentcloudapi.com/?Action=RemoveUser
&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 CodeDescription
FailedOperation.RoomNotExistThe room does not exist.
InternalErrorInternal error.
InternalError.GetRoomCacheIpErrorFailed to query the room.
InternalError.GetRoomFromCacheErrorFailed to get room information.
InvalidParameter.RoomIdRoomId is incorrect.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.UserIdsUserIds is incorrect.
InvalidParameterValue.RoomIdInvalid RoomId.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.UserIdsUserIds is missing.
UnauthorizedOperation.SdkAppIdNo permission to manipulate SdkAppId.