Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Actions64

Overview

This node, named "Evolution API Direct," allows users to interact with the Evolution API by specifying a direct URL and an API key. It supports various resources and operations; in this case, focusing on the Chat resource with the Gerenciar Arquivo (Manage Archive) operation. The primary function of this operation is to archive or unarchive chat conversations based on message details.

Typical use cases include:

  • Archiving chat conversations programmatically to keep the chat interface clean.
  • Unarchiving conversations when needed for review or follow-up.
  • Managing chat archives automatically based on message metadata such as sender and message ID.

For example, a user can automate archiving chats that have been inactive for a certain period or unarchive important conversations when a new message arrives.

Properties

Name Meaning
Server URL The full URL of your Evolution API endpoint (e.g., https://api.exemplo.com).
API Key The API key credential required to authenticate requests to the Evolution API.
Nome Da Instância The name of the instance you are interacting with.
Contato The contact number associated with the chat conversation to be archived/unarchived.
Ação Action to perform: either Arquivar (archive) or Desarquivar (unarchive) the chat.
ID Da Mensagem The ID of the last message in the conversation, used to identify which chat to manage.
Mensagem É Minha Boolean indicating if the message was sent by the instance itself (true/false).

Output

The node outputs a JSON array containing the result of the archive management operation. Each item in the output corresponds to the response from the Evolution API after attempting to archive or unarchive the specified chat conversation.

If the API returns any binary data (not indicated in the provided code), it would typically represent files or media related to the chat, but this node primarily deals with JSON responses confirming the success or failure of the archive action.

Dependencies

  • Requires access to the Evolution API via a valid Server URL and API Key.
  • The node expects the user to provide correct instance names and contact numbers relevant to their Evolution API setup.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure you choose valid combinations of resource and operation.
  • Authentication errors: Incorrect or missing API keys will cause authentication failures. Verify that the API key is correct and has sufficient permissions.
  • Invalid parameters: Missing required fields like contact number, message ID, or instance name will cause the request to fail. Double-check all required inputs.
  • Network issues: Ensure the Server URL is reachable and correctly formatted (including protocol https://).
  • Message ownership mismatch: The Mensagem É Minha boolean must accurately reflect whether the message was sent by the instance; otherwise, the API might reject the request.

Links and References

Discussion