Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
The "Messages: List" operation in this node allows users to retrieve a list of received messages for a specified project. It supports filtering messages by various criteria such as platform ID, platform type (e.g., telegram, discord, whatsapp-evo), chat or channel ID, user ID, and date ranges. Users can also control pagination with limit and offset parameters, specify sort order, and optionally include raw platform message data and reactions on each message.
This operation is beneficial when you want to analyze or process incoming messages across multiple messaging platforms within a project. For example, it can be used to monitor customer support chats, aggregate messages from different channels, or build analytics dashboards based on message activity.
Practical examples:
- Fetch the last 50 messages received on Telegram for a specific chat.
- Retrieve all messages from a particular user across all platforms within a date range.
- Include reactions and raw platform data for detailed processing or auditing.
Properties
| Name | Meaning |
|---|---|
| Filter by platform ID | Filter messages by a specific platform configuration ID |
| Filter by platform type | Filter messages by platform type; options: telegram, discord, whatsapp-evo |
| Filter by chat/channel ID | Filter messages by a specific chat or channel ID |
| Filter by user ID | Filter messages sent by a specific user |
| Filter messages after this date (ISO 8601) | Only include messages received after this ISO 8601 formatted date |
| Filter messages before this date (ISO 8601) | Only include messages received before this ISO 8601 formatted date |
| Number of messages to return (1-100) | Limit the number of messages returned; default is 50 |
| Number of messages to skip | Skip a number of messages for pagination |
| Sort order (asc or desc) | Sort messages in ascending or descending order; default is descending |
| Include raw platform message data | Boolean flag to include the original raw message data from the platform |
| Include reactions on each message | Boolean flag to include reactions associated with each message |
| Project | Identifier of the project to operate on; required |
Output
The output JSON contains an array of message objects representing the retrieved messages matching the filter criteria. Each message object typically includes metadata such as message ID, platform details, sender information, timestamps, content, and optionally raw platform data and reactions if requested.
If enabled, the raw field provides the unprocessed message data as received from the platform, useful for advanced processing or debugging.
Reactions, if included, provide details about emoji reactions or similar interactions attached to each message.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential configured with access to the messaging gateway service.
- The node must be configured with the base URL of the messaging API.
- The "Project" property must correspond to a valid project identifier in the messaging system.
Troubleshooting
- Empty results: Ensure that the project ID is correct and that messages exist matching the filter criteria. Check date formats for correctness (ISO 8601).
- Invalid filter values: Using unsupported platform types or invalid IDs may cause errors or empty responses.
- API authentication errors: Verify that the API key credential is valid and has appropriate permissions.
- Pagination issues: If using offset and limit, ensure values are within allowed ranges (limit between 1 and 100).
- Unexpected response structure: If including raw data or reactions, verify that the platform supports these features and that the flags are set correctly.
Links and References
- ISO 8601 Date Format
- Messaging gateway API documentation (refer to your service provider's docs for detailed message schema and platform-specific data)