ListLiveMessageGroupUsers - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the users in an interactive messaging group.

Operation description

Before you call this operation, make sure that you have called the CreateLiveMessageGroup operation to create an interactive messaging group.
For a super group, which has more than 2,000 users, the user list cannot be queried. In addition, the notifications about users entering or leaving the group are sent at an interval of at least of 5 seconds. These notifications display the accurate number of users in the group for the time being, but do not display the list of all users entering or leaving the group. Once a group is upgraded to a super group, the user list of the group is immediately cleared. The super group cannot be restored to a normal group until all users in the group leave the group (that is, the group is closed). After you reopen the group, it is restored to a normal 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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListLiveMessageGroupUsers	list	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application to query.	demo
GroupId	string	Yes	The ID of the group to query.	grouptest
PageSize	integer	Yes	The number of entries per page. Valid values: 10 to 50.	10
SortType	integer	Yes	The sort order based on the time when the users joined the group. Valid values: 1: ascending order 2: descending order	1
NextPageToken	long	No	The starting page number for the query. If you leave this parameter empty, the query starts from the first page.	1
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	Schema of Response
RequestId	string	The request ID.	A1D75BEA-1329-116F-B29C-76F3F200****
GroupId	string	The ID of the group queried.	grouptest
NextPageToken	long	The starting page number for the next query. A value of 0 indicates that no further pages can be queried.	0
Hasmore	boolean	Indicates whether the current page is followed by another page.	false
UserList	array<object>	Details about the users.
Users	object
UserId	string	The ID of the user.	uid1
UserInfo	string	The additional information about the user.	info1

Examples

Sample success responses

JSONformat

{
  "RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "UserList": [
    {
      "UserId": "uid1",
      "UserInfo": "info1"
    }
  ]
}

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
420	SuperLargeGroup	%s.	When the group has more than 2000 members, the group is upgraded to a super large group and no longer supports querying the user list.
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
2025-03-26	The Error code has changed	View Change Details