SetUserBlocked

1. API Description

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

This API is used to disable or enable the audio and video of a user. It can be used by an anchor, room owner, or admin to block or unblock a user. It supports platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API if the room ID is a number.

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: SetUserBlocked.
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.
SdkAppIdYesIntegerThe application ID.
RoomIdYesIntegerThe room ID (number).
UserIdYesStringThe user ID.
IsMuteYesIntegerWhether to disable the user’s audio and video. 0: Enable; 1: Disable.

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 Disabling the audio and video of a user

Input Example

https://trtc.tencentcloudapi.com/?Action=SetUserBlocked
&SdkAppId=1400188366
&RoomId=10006
&UserId=29376
&IsMute=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "44e494f6-8010-4bb2-9a9d-ba5fd191353a"
    }
}

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.
FailedOperation.SdkAppIdNotExistThe application ID does not exist.
FailedOperation.UserNotExistThe user is not in the room.
InternalErrorInternal error.
InternalError.UserNotExistThe user is not in the room.
InvalidParameterParameter error.
InvalidParameter.RoomIdRoomId is incorrect.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.UserIdInvalid UserId.
InvalidParameterValue.RoomIdInvalid RoomId.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
UnauthorizedOperation.SdkAppIdNo permission to manipulate SdkAppId.