Mute Live Room Members via MuteGroupUser API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:MuteGroupUser

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application.	VKL3***
GroupId	string	Yes	The message group ID.	AE35-****-T95F
MuteUserList	array	Yes	The mute details.
	string	No	The list of user IDs to mute.	qu*,yu1*
MuteTime	integer	No	The mute duration. Unit: seconds. Note If this parameter is not specified or is set to 0, the default mute duration (86400 seconds) is used.	3600
OperatorUserId	string	No	The user ID of the operator. Note This parameter is required, and the user must be the creator of the group.	de1**a0
BroadCastType	integer	No	The system message broadcast type. Valid values: 0: no broadcast. 1: broadcast to specified users. 2: broadcast to the group.	2

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	The returned result.
Success	boolean	Indicates whether the mute operation is successful. Valid values: true: Successful. false: Not successful.	true

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "Success": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.