DescribeLiveMessageGroupBand - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the mute status of users.

Operation description

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 50 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:DescribeLiveMessageGroupBand	get	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
GroupId	string	Yes	The ID of the interactive messaging group.	grouptest
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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	021D1FE7-2E87-16AC-9364-4E7EA47C****
GroupId	string	The group ID.	grouptest
BannedUserList	array	The list of users that were muted separately, but not by muting the entire group.
BannedUsers	string	The ID of the users.	["uid1","uid2"]
UnbannedUserList	array	The list of users who were not muted when the entire group was muted.
UnbannedUsers	string	The ID of the users.	["uid3"]
IsbannedAll	boolean	Indicates whether all users in the interactive messaging group are muted.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "021D1FE7-2E87-16AC-9364-4E7EA47C****",
  "GroupId": "grouptest",
  "BannedUserList": [
    "[\"uid1\",\"uid2\"]"
  ],
  "UnbannedUserList": [
    "[\"uid3\"]"
  ],
  "IsbannedAll": false
}

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

No change history