Changes the mute status of users in a group.
Operation description
Before you call this operation, you must call the CreateLiveMessageGroup operation to create an interactive messaging group.
QPS limit
A single user can make up to 10 queries per second (QPS). If you exceed this limit, API calls are throttled, which may impact your business. Call this operation at a reasonable rate.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:ModifyLiveMessageGroupBand |
update |
*Rtc
|
None | 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 in the group. |
false |
| BannnedUsers |
array |
No |
The list of users to mute. You can specify up to 30 users. Separate multiple user IDs with a comma (,). |
|
|
string |
No |
The user to mute. |
uid1 |
|
| ExceptUsers |
array |
No |
The list of users who are not muted when all users in the group are muted. You can specify up to 30 users. Separate multiple user IDs with a comma (,). |
|
|
string |
No |
A user who is not muted when all users in the group are muted. |
uid3 |
|
| DataCenter |
string |
No |
The data center. This must be the same data center specified in the CreateLiveMessageApp call. Valid values: `cn-shanghai` (Shanghai) and `ap-southeast-1` (Singapore). |
cn-shanghai |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
84AF36BF-0B39-1F8A-A416-FAC7C484**** |
Examples
Success response
JSON format
{
"RequestId": "84AF36BF-0B39-1F8A-A416-FAC7C484****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InputInvalid | %s. | Illegal input parameters |
| 500 | ServerError | %s. | Unknown error, please try again later or submit a ticket for consultation. |
| 403 | NoAuth | %s. | No permission |
| 404 | ResourceNotExist | %s. | The requested resource does not exist, please check and try again |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.