SetUserBlockedByStrRoomId
1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
This API allows an anchor, room owner, admin to mute/unmute a user. It can be used on platforms including Android, iOS, Windows, macOS, web, and WeChat Mini Program. Use this API when the room ID is a string.
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: SetUserBlockedByStrRoomId. |
| 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. |
| StrRoomId | Yes | String | The room ID (string). |
| UserId | Yes | String | The user ID. |
| IsMute | Yes | Integer | Whether to disable the user’s audio and video. 0: Enable; 1: Disable. |
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 (string-type room ID)
Input Example
https://trtc.tencentcloudapi.com/?Action=SetUserBlockedByStrRoomId
&SdkAppId=1400188366
&StrRoomId=”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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| InvalidParameter | Parameter error. |
| InvalidParameter.RoomId | RoomId is incorrect. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| InvalidParameter.UserId | Invalid UserId. |
| MissingParameter | Missing parameter. |
| MissingParameter.AppId | AppId missing. |
| MissingParameter.RoomId | RoomId is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.UserId | Missing UserId parameter. |
| UnauthorizedOperation.SdkAppId | No permission to manipulate SdkAppId. |