Modifies the mute status of users.
Operation description
Usage notes
Before you call this operation, make sure that you have called the CreateLiveMessageGroup operation to create an interactive messaging group.
QPS limit
You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:ModifyLiveMessageGroupBand | update | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AppId | string | Yes | The application ID. | demo |
| GroupId | string | Yes | The group ID. | grouptest |
| BannedAll | boolean | No | Specifies whether to mute all users. | false |
| BannnedUsers | array | No | The ID of the user whom you want to mute. Separate multiple user IDs with commas (,). You can specify up to 30 users IDs. | |
| string | No | Users who are muted, separated by commas (,). Up to 30 users. | ["uid1","uid2"] | |
| ExceptUsers | array | No | The ID of the user whom you do not want to mute when you set the BannedAll parameter to true. Separate multiple user IDs with commas (,). You can specify up to 30 users IDs. | |
| string | No | Users who are not muted when global mute is enabled, separated by commas (,). Up to 30 users allowed. | ["uid3"] | |
| DataCenter | string | No | The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore). | cn-shanghai |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "84AF36BF-0B39-1F8A-A416-FAC7C484****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InputInvalid | %s. | Illegal input parameters |
| 403 | NoAuth | %s. | No permission |
| 404 | ResourceNotExist | %s. | The requested resource does not exist, please check and try again |
| 500 | ServerError | %s. | Unknown error, please try again later or submit a ticket for consultation. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|