tencent cloud

All product documents
Tencent Real-Time Communication
DocumentationTencent Real-Time CommunicationServer APIsRoom Management APIsSetUserBlocked
SetUserBlocked
Download PDF
Last updated: 2025-02-27 10:42:05
SetUserBlocked
Last updated: 2025-02-27 10:42:05
Download PDF

1. API Description

Domain name for API request: trtc.intl.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 Name Required Type Description
Action Yes String Common Params. The value used for this API: SetUserBlocked.
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 The application ID.
RoomId Yes Integer The room ID (number).
UserId Yes String The user ID.
IsMute Yes Integer Controls the activation state of audio and video.
0: Enable audio and video,
1: Disable audio and video,
2: Disable audio only,
3: Disable video only.

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

Input Example

https://trtc.intl.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 Code Description
FailedOperation.RoomNotExist The room does not exist.
FailedOperation.SdkAppIdNotExist The application ID does not exist.
FailedOperation.UserNotExist The user is not in the room.
InternalError Internal error.
InternalError.UserNotExist The user is not in the room.
InvalidParameter Parameter error.
InvalidParameter.RoomId RoomId is incorrect.
InvalidParameter.SdkAppId SdkAppId is incorrect.
InvalidParameter.UserId Invalid UserId.
InvalidParameterValue.RoomId Invalid RoomId.
MissingParameter.RoomId RoomId is missing.
MissingParameter.SdkAppId SdkAppId is missing.
UnauthorizedOperation.SdkAppId No permission to manipulate SdkAppId.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon