ListLiveMessageGroups API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Before you call this operation, make sure that you have created an interactive messaging group by calling the CreateLiveMessageGroup operation.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped, which may cause service interruptions. Take note of this limit when you call this operation.

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

list

*Rtc

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
SortType	integer	Yes	The sort order based on the time when the groups were created. Valid values: 1: ascending order 2: descending order	1
NextPageToken	integer	No	The starting page number for the query. If not specified, the query starts from the first page.	1001
GroupStatus	integer	No	The status of the groups to query. Default value: 0. Valid values: 0: all groups 1: existing groups 2: deleted groups	1
DataCenter	string	No	The data center. This value must match the data center 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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B5D95365-5A46-1A6A-BBF5-C7B6BDED****
Hasmore	boolean	Indicates whether more results are available on subsequent pages.	false
NextpageToken	string	The starting page number for the next query. Returned only when Hasmore is true.	1001
GroupList	array<object>	Details about the groups.
	object	Details about the groups.
GroupId	string	The ID of the group.	cU9MeBqf****
CreatorId	string	The ID of the group creator.	user_77
AdminList	array	The IDs of the group administrators.
	string	The administrator ID.	uid1
Createtime	integer	The time when the group was created. The value is a UNIX timestamp. Unit: seconds.	1698299727
GroupName	string	The name of the group.	mytestgroup
GroupInfo	string	The additional information about the group.	testgroupinfo
Delete	boolean	Indicates whether the group is deleted.	true

Examples

Success response

JSON format

{
  "RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "Hasmore": false,
  "NextpageToken": "1001",
  "GroupList": [
    {
      "GroupId": "cU9MeBqf****",
      "CreatorId": "user_77",
      "AdminList": [
        "uid1"
      ],
      "Createtime": 1698299727,
      "GroupName": "mytestgroup",
      "GroupInfo": "testgroupinfo",
      "Delete": true
    }
  ]
}

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.