ListChatappMessage - Chat App Message Service - Alibaba Cloud Documentation Center

Queries the message list.

Operation description

You can call this operation to query the message list. You can also view the message list in the Channel Management > Management > Message List console.
This operation only supports querying the message list for WhatsAppand Viber channel types.
Before calling this operation, make sure that you have created a WhatsAppor Viber channel, bound a phone number or merchant account ID, created a template that has passed the review, and sent messages through the channel.

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

cams:ListChatappMessage

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The business phone number. For WhatsApp channels, view the business phone number in the Channel Management > Management > WABA Management > Phone Number Management console. For Viber channels, view the Service ID in the Channel Management > Management > Service Account Management console.	8613800****
StartTime	integer	No	The start time. This value is a UNIX timestamp in milliseconds.	1727057232686
EndTime	integer	No	The end time. This value is a UNIX timestamp in milliseconds.	1727057232686
EventAction	string	No	The message type. Valid values: DOWN: outbound message. UP: inbound message. Valid values: DOWN : DOWN UP : UP	UP
UserNumber	string	No	The user phone number. This is the phone number that you imported when sending messages in the Channel Management > Management > Message Sending console.	86138***
ChannelType	string	Yes	The channel type. Valid values: whatsapp viber	WHATSAPP
ClientAcceptStatus	string	No	The message receiving status of the user.	success
TemplateCode	string	No	The template code. View the template code in the Channel Management > Management > Template Design console.	9938***
GroupMessageId	string	No	The bulk message ID. View the bulk message ID in the Channel Management > Management > Message List > Bulk Sending List console.	9292****
MessageStatus	string	No	The message status.	success
CustSpaceId	string	Yes	The space ID of the ISV sub-customer or the instance ID of the direct customer. View the Space ID in the Channel Management console.	cams-************
Page	object	Yes	The pagination object.
Size	integer	Yes	The number of entries per page.	10
Index	integer	Yes	The page number.	1

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The access denied details.	None
Message	string	The error message.	None
RequestId	string	The request ID.	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Data	array<object>	The list of returned data objects.
	object	The returned data.
ConversationId	string	The conversation ID.	805a66**************************
BusinessNumber	string	The business phone number.	86183********
ClientAcceptStatusName	string	The name of the message receiving status.	Success
Message	string	The message content.	test
MessageTypeName	string	The message type name.	interactive
FailReason	string	The reason for the sending failure.	timeout
EventActionName	string	The name of the inbound or outbound message type. Valid values: DOWN: outbound message. UP: inbound message.	DOWN
Month	string	The month of the message.	202507
LanguageCode	string	The template language. For more languages, see Language codes.	en
TemplateName	string	The template name.	picture_template
MessageType	string	The message type.	INTERACTIVE
SendTime	string	The sending time.	2025-07-11T01:16:49.761+00:00
MessageStatusName	string	The message status name.	Success
ClientReadStatus	string	The message read status.	success
MessageSource	string	The message source.	api
FailBackFlag	string	Indicates whether the message falls back to SMS. Valid values: Y: Yes. N: No.	Y
UserNumber	string	The user phone number.	86177********
TemplateCode	string	The template code.	1103***************
MessageStatus	string	The message status.	success
Type	string	The type.	message
FailBackContent	string	The fallback content.	None
EventAction	string	The inbound or outbound message type.	DOWN
ClientReadStatusName	string	The message read status name.	Success
UniqueMessageId	string	The unique message ID.	20250911******************************
ChannelType	string	The channel type.	WHATSAPP
MessageId	string	The message ID.	202509*******************
Code	string	The response code. OK: The request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC",
  "Data": [
    {
      "ConversationId": "805a66**************************",
      "BusinessNumber": "86183********",
      "ClientAcceptStatusName": "Success",
      "Message": "test",
      "MessageTypeName": "interactive",
      "FailReason": "timeout",
      "EventActionName": "DOWN",
      "Month": "202507",
      "LanguageCode": "en",
      "TemplateName": "picture_template",
      "MessageType": "INTERACTIVE",
      "SendTime": "2025-07-11T01:16:49.761+00:00",
      "MessageStatusName": "Success",
      "ClientReadStatus": "success",
      "MessageSource": "api",
      "FailBackFlag": "Y",
      "UserNumber": "86177********",
      "TemplateCode": "1103***************",
      "MessageStatus": "success",
      "Type": "message",
      "FailBackContent": "None",
      "EventAction": "DOWN",
      "ClientReadStatusName": "Success",
      "UniqueMessageId": "20250911******************************",
      "ChannelType": "WHATSAPP",
      "MessageId": "202509*******************"
    }
  ],
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.