Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to manage chat conversations by archiving or unarchiving them. It is useful in scenarios where users want to organize their chat history, for example, to hide inactive conversations without deleting them or to restore previously archived chats for active use.

A practical example would be a customer support system that archives resolved chat sessions automatically and allows agents to unarchive conversations when follow-up is needed.

Properties

Name Meaning
Nome Da Instância The name of the instance managing the chat (required).
Contato The contact number associated with the chat conversation to be archived/unarchived (required).
Ação Action to perform: "Arquivar" (archive) or "Desarquivar" (unarchive) (required).
ID Da Mensagem The ID of the last message in the conversation (required).
Mensagem É Minha Boolean indicating if the last message was sent by the instance (true/false) (required).

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 status change for the specified chat.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the resource is set to "chat-api" and the operation to "manage-archive".
  • Missing Required Parameters: Ensure all required fields (instance name, contact number, action, message ID, and fromMe flag) are provided; missing any will cause execution failure.
  • API Authentication Issues: Confirm that the API key credential is correctly configured and has sufficient permissions.
  • Invalid Contact or Message ID: Errors may occur if the contact number or message ID does not exist or is malformed; double-check these values.

Links and References

Discussion