ListMessageGroup - - Alibaba Cloud Documentation Center

Call ListMessageGroup to query the message group list for a specified user.

Operation description

QPS limits

The single-user QPS limit for this API is 100 queries per second. If this limit is exceeded, API calls will be throttled, which may affect your business. You can call this API at a reasonable rate. For more information, see QPS limits.

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 support 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:ListMessageGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	No	User ID, which is customized by the user and must be unique within an AppId. Different users must use different UserIds. Note You must correctly fill in this parameter to perform a normal query.	de1**a0
AppId	string	No	Interactive Messages application ID. Note You must correctly fill in this parameter to perform a normal query.	VKL3***
SortType	integer	No	Sorting method. Valid values: 0: Ascending order by time. 1: Descending order by time.	1
PageNum	integer	Yes	Page number. Default value: 1. Valid values: 1 to 100000.	10
PageSize	integer	Yes	Number of message groups to display per page. Default value: 20. Valid values: 1 to 50.	20

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	Return result.
GroupList	array	Message group list.
	object	Message group details.
AppId	string	Interactive Messages application ID.	VKL3***
CreateTime	integer	UTC timestamp when the message group was created.	1502280113
CreatorId	string	Creator ID.	as****hs
Extension	object	Extension field.
	string	Extension field.	test001
GroupId	string	Message group ID.	AE35-****-T95F
Status	integer	Message group status. The default value is 1, indicating that the message group status is normal.	1
HasMore	boolean	Indicates whether there is a next page. Valid values: true: There is a next page. false: There is no next page.	false
Total	integer	Total number of message groups.	5

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "GroupList": [
      {
        "AppId": "VKL3***",
        "CreateTime": 1502280113,
        "CreatorId": "as****hs",
        "Extension": {
          "key": "test001"
        },
        "GroupId": "AE35-****-T95F",
        "Status": 1
      }
    ],
    "HasMore": false,
    "Total": 5
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.