Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the Resource "Instancia" and Operation "Definir Comportamento" (Define Behavior), it configures instance settings such as call rejection, message reading, status reading, synchronization of full history, and online presence behavior. This node is useful in scenarios where you want to programmatically control how an instance behaves in terms of communication handling and data synchronization.

Practical examples include:

  • Automatically rejecting incoming calls with a custom message.
  • Setting the instance to always appear online.
  • Enabling or disabling reading of messages and statuses.
  • Synchronizing the complete chat history for backup or analysis purposes.

Properties

Name Meaning
Nome Da Instância The name assigned to the instance.
Rejeitar Chamadas Whether to reject incoming calls (true/false).
Mensagem De Chamadas Message sent when calls are rejected.
Ignorar Grupos Whether to ignore groups (true/false).
Sempre Online Whether the instance should always be online (true/false).
Ler Mensagens Whether the instance should read messages (true/false).
Sincronizar Histórico Completo Whether to synchronize the full chat history (true/false).
Ler Status Whether the instance should read statuses (true/false).

Output

The node outputs a JSON array containing the result of the operation performed on the instance. The exact structure depends on the Evolution API response but generally includes confirmation of the updated settings or any relevant data returned by the API after applying the behavior configuration.

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 credential within n8n is necessary for successful execution.

Troubleshooting

  • Operation not supported error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "instances-api" and "instance-settings" respectively.
  • Authentication errors: Ensure the API key credential is valid and has the necessary permissions.
  • Network issues: Confirm network connectivity to the Evolution API endpoint.
  • Invalid property values: Check that required properties like "Nome Da Instância" are provided and valid.

Links and References

Discussion