Evolution API

Overview

The node "Evolution API" provides an interface to interact with the Evolution API service. Specifically, for the Chat resource and the Read Messages operation, it allows users to retrieve a specific chat message by specifying the contact, message ID, and whether the message was sent by the instance itself. This is useful in scenarios where you want to fetch detailed information about a particular message in a chat conversation, such as for auditing, displaying message history, or processing messages programmatically.

Practical examples include:

• Fetching a message to display its content in a custom dashboard.
• Retrieving message details to trigger further automation based on message content.
• Verifying if a message was sent by the user or received from a contact.

Properties

Output

The node outputs a JSON array containing the data of the requested chat message. The structure of the json output field corresponds to the message details returned by the Evolution API, which typically includes message content, sender information, timestamps, and metadata related to the message.

If the API supports binary data (e.g., media attachments), the node would handle this accordingly, but based on the provided code and properties, the focus is on JSON message data retrieval.

Dependencies

• Requires an active Evolution API instance configured with appropriate credentials (an API key or authentication token).
• The node depends on the Evolution API endpoint accessible at https://doc.evolution-api.com/api-reference.
• Proper configuration of the instance name and credentials within n8n is necessary to authenticate requests.

Troubleshooting

• Operation not supported error: If the specified operation or resource is not implemented, the node will throw an error stating the function is not supported. Ensure that the resource is set to "chat-api" and operation to "read-messages".
• Missing required parameters: The node requires all properties (Instance Name, Contact, Message ID, and Is My Message) to be provided. Omitting any will likely cause errors or failed API calls.
• Authentication failures: Incorrect or missing API credentials will prevent successful communication with the Evolution API.
• Invalid message ID or contact: Providing incorrect identifiers may result in empty responses or errors from the API.

Links and References

• Evolution API Documentation - Official API reference for detailed endpoint information.
• n8n Documentation on Creating Custom Nodes - For understanding how nodes are structured and executed.