ListMessage - - Alibaba Cloud Documentation Center

Operation description

QPS limits

The single-user QPS limit for this API operation is 100 queries per second (QPS). If the limit is exceeded, API calls will be throttled, which may affect your business. You can call the API operation properly to avoid this issue. 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:ListMessage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The message group ID.	AE35-****-T95F
AppId	string	Yes	The interactive message application ID.	VKL3***
Type	integer	No	The user-defined message type. The value must be greater than 10000.	10002
SortType	integer	No	The sorting method. Valid values: 0: ascending order by time. 1: descending order by time.	1
PageNum	integer	Yes	The page number. Default value: 1. Valid values: 1 to 100000.	10
PageSize	integer	Yes	The number of users displayed per page. Default value: 20. Valid values: 1 to 50.	20

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	The returned results.
HasMore	boolean	Indicates whether there is a next page. Valid values: true: There is a next page. false: There is no next page.	false
MessageList	array	The message list.
	object
Data	string	The message body, in JSONString format.	test
GroupId	string	The message group ID.	AE35-****-T95F
MessageId	string	The message ID.	qt***
SenderId	string	The message sender ID.	yi***
Type	integer	The message type.	10002

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "HasMore": false,
    "MessageList": [
      {
        "Data": "test",
        "GroupId": "AE35-****-T95F",
        "MessageId": "qt***",
        "SenderId": "yi***",
        "Type": 10002
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.