ListLiveMessageGroupUsers API Overview - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Before calling this operation, you must have already created an interactive messaging group by calling CreateLiveMessageGroup.
For super-large groups (groups with more than 2,000 members), member list queries are no longer supported. Additionally, notifications for members joining or leaving the group are sent at intervals of at least 5 seconds. The notifications do not display the full list of users who joined or left, but they display the exact group member count. Once a group is upgraded to a super-large group, the member list is immediately cleared. The group cannot be reverted to a regular group until all members leave the group (the group is closed). When the group is reopened, it is restored to a regular group.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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:ListLiveMessageGroupUsers

list

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the live interactive application to query.	demo
GroupId	string	Yes	The group ID of the group to query.	grouptest
PageSize	integer	Yes	The number of users to display per page. Valid values: 10 to 50.	10
SortType	integer	Yes	The sort order. Users are sorted by the time they joined the group. Valid values: 1: ascending order. 2: descending order. Valid values: 1 : ascending order. 2 : descending order.	1
NextPageToken	integer	No	The start position of the query page. If this parameter is left empty, the first page is returned by default.	1
DataCenter	string	No	The data center. This value must be the same as the data center specified in CreateLiveMessageApp. Valid values: cn-shanghai (Shanghai) and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A1D75BEA-1329-116F-B29C-76F3F200****
GroupId	string	The group ID of the group to query.	grouptest
NextPageToken	integer	The start position of the next page. A value of 0 indicates that there is no next page.	0
Hasmore	boolean	Indicates whether there is a next page.	false
UserList	array<object>	The array of objects.
	object	The details of the array.
UserId	string	The user ID.	uid1
UserInfo	string	The extended information of the user.	info1

Examples

Success response

JSON format

{
  "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
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.
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.