Actions64
- Instance Actions
- Message Actions
- Group Actions
- Integration Actions
- Chat Actions
- Profile Actions
- Event Actions
Overview
The node "Evolution API" provides an interface to interact with the Evolution API service. Specifically, for the Resource "Chat" and Operation "Search Status," it allows users to search for status messages related to a particular chat contact. This can be useful in scenarios where you want to retrieve message status information such as read receipts or delivery confirmations for specific messages within a chat instance.
Practical examples include:
- Fetching the delivery status of a message sent to a customer.
- Monitoring read receipts for messages in a support chat.
- Paginating through status messages to analyze communication history.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the Evolution API instance to connect to. |
| Contact | The contact number (remote JID) whose message statuses are being searched. |
| Message ID | The unique identifier of the message for which status messages are requested. |
| Page | The page number of results to retrieve (for pagination). |
| Items Per Page | Number of status messages to return per page (pagination size). |
Output
The node outputs a JSON array containing the status messages found for the specified message and contact. Each item in the output array represents a status message record, likely including details such as status type, timestamp, and any relevant metadata returned by the Evolution API.
If the API supports binary data (not indicated here), it would typically represent attachments or media related to the status messages, but this is not evident from the provided code.
Dependencies
- Requires an active connection to the Evolution API service.
- Needs an API authentication credential configured in n8n (an API key or token).
- The base URL for requests is set to
https://doc.evolution-api.com/api-reference. - No other external dependencies are indicated.
Troubleshooting
- Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "chat-api" and "find-status-messages" respectively.
- Missing Required Parameters: Ensure all required properties (Instance Name, Contact, Message ID) are provided; missing these will cause errors.
- API Authentication Issues: Confirm that the API credentials are valid and have sufficient permissions.
- Pagination Errors: Providing invalid page numbers or offsets may result in empty responses or errors; use positive integers.
- Network or API Downtime: Check network connectivity and Evolution API service status if requests fail.
Links and References
- Evolution API Documentation (base URL referenced in the node)
- n8n Documentation on Creating Custom Nodes