Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" provides an interface to interact with the Evolution API, specifically supporting various resources and operations. For the Chat resource with the Manage Archive operation, it allows users to archive or unarchive a chat conversation based on specific parameters such as the contact number, message ID, and whether the message was sent by the instance.

This node is beneficial in scenarios where automated management of chat archives is needed, for example:

  • Automatically archiving conversations after they are resolved.
  • Unarchiving chats when a follow-up is required.
  • Managing chat states programmatically within workflows that integrate with the Evolution API.

Properties

Name Meaning
Name Da Instância The name of the instance to be used for the operation.
Contato The contact number associated with the chat conversation to be archived or unarchived.
Ação Action to perform: either "Arquivar" (archive) or "Desarquivar" (unarchive) the chat.
Message ID The ID of the last message in the conversation, used to identify the chat state.
Mensagem É Minha Boolean indicating if the message was sent by the instance (true) or not (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 chat.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Unsupported Operation 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" and "manage-archive" respectively.
  • Missing Required Parameters: Ensure all required fields (instance name, contact number, message ID, action, and fromMe flag) are provided; missing any will cause errors.
  • Authentication Issues: Confirm that the API key credential is valid and has the necessary permissions.
  • API Response Errors: If the Evolution API returns errors, check the correctness of the input parameters and network connectivity.

Links and References

Discussion