Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node provides an interface to interact with the "Evolution API," specifically supporting operations on various resources. For the Chat resource and the Manage Archive operation, it allows users to archive or unarchive a conversation associated with a specific contact. This is useful in scenarios where managing chat history visibility or organization is required, such as hiding inactive conversations or restoring archived chats for review.

Practical examples include:

  • Archiving a chat after a customer support case is closed.
  • Unarchiving a chat when a follow-up is needed on a previously archived conversation.

Properties

Name Meaning
Instance Name The name of the instance interacting with the Evolution API.
Contact The contact number whose conversation archive status will be managed.
Action Choose whether to archive (Archive) or unarchive (Unarchive) the conversation.
Message ID The ID of the last message in the conversation, used to identify the conversation context.
Is My Message Boolean indicating if the message was sent by the instance (true) or received (false).

Output

The node outputs a JSON array containing the result of the archive management operation. The exact structure depends on the Evolution API response but generally includes confirmation of the archive/unarchive action performed on the specified conversation.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Needs an API authentication credential configured in n8n to authorize requests to the Evolution API.
  • The node depends on the Evolution API service being available and responsive.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error stating the function is not supported. Ensure that the resource is set to "Chat" and operation to "Manage Archive."
  • Invalid or missing parameters: Required properties like Instance Name, Contact, Message ID, and Action must be provided; otherwise, the API call may fail.
  • Authentication errors: Verify that the API key or authentication token is correctly configured in n8n credentials.
  • API connectivity issues: Network problems or incorrect base URL configuration can cause failures. Confirm internet access and correct API endpoint.

Links and References

Discussion