Actions51
- Platforms Actions
- Projects Actions
- Webhooks Actions
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs 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 by various criteria such as platform ID, platform type (e.g., telegram, discord, whatsapp-evo), chat or channel ID, user ID, date ranges, and pagination controls like limit and offset. Additional options include sorting order, inclusion of 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, you could use it to fetch recent Telegram messages from a specific chat, or to gather all Discord messages sent by a particular user within a date range.
Properties
| Name | Meaning |
|---|---|
| Filter by platform ID | Filter messages originating from a specific platform configuration ID. |
| Filter by platform type | Filter messages by platform type; options are telegram, discord, whatsapp-evo. |
| Filter by chat/channel ID | Filter messages from a specific chat or channel ID. |
| Filter by user ID | Filter messages sent by a specific user ID. |
| Filter messages after this date (ISO 8601) | Only include messages sent after this ISO 8601 formatted date. |
| Filter messages before this date (ISO 8601) | Only include messages sent 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 purposes. |
| Sort order (asc or desc) | Sort the results in ascending (asc) or descending (desc) order; default is desc. |
| Include raw platform message data | Boolean option to include the raw message data as received from the platform. |
| Include reactions on each message | Boolean option to include reactions associated with each message. |
| Project | The identifier of the project to operate on; required field. |
Output
The output JSON contains an array of message objects representing the messages retrieved according to the applied filters. Each message object typically includes metadata such as message ID, sender information, timestamps, content, and optionally raw platform-specific data and reactions if those options were enabled.
If the "Include raw platform message data" option is selected, the output will also contain the original message payloads as provided by the respective messaging platforms.
Reactions, if included, provide details about emoji reactions or similar feedback attached to each message.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential configured with access to the GateKit API.
- The node must be configured with the base URL of the GateKit API service.
- The "Project" property must specify a valid project identifier within the GateKit system.
Troubleshooting
- Empty results: Ensure that the project ID is correct and that there are messages matching the filter criteria. Check date formats for correctness (ISO 8601).
- Invalid date format errors: Dates must be in ISO 8601 format; otherwise, the API may reject the request.
- Permission errors: Verify that the API key used has sufficient permissions to access messages for the specified project.
- Limit and offset misuse: The limit must be between 1 and 100; setting values outside this range may cause errors or unexpected behavior.
- Boolean properties: Make sure boolean inputs like "Include raw platform message data" and "Include reactions" are set correctly (true/false).
Links and References
- GateKit API Documentation (general reference for API endpoints and parameters)
- ISO 8601 Date Format (for date filtering)