Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node allows you to define the behavior of an "Instancia" (Instance) in the Evolution API. It is typically used to configure how a specific instance should handle calls, messages, group interactions, online status, and message reading behaviors. This is useful for automating the management of communication instances, such as setting them to always be online, rejecting incoming calls with a custom message, or synchronizing full message history.

Practical examples:

  • Automatically reject all incoming calls to a WhatsApp business instance and send a predefined message.
  • Set an instance to always appear online for customers.
  • Enable or disable reading of messages or statuses for compliance or automation purposes.

Properties

Display Name Type Description
Nome Da Instância String Digite o nome para a instância (Enter the name for the instance).
Rejeitar Chamadas Boolean Whether to reject calls or not.
Mensagem De Chamadas String Mensagem a ser enviada se as chamadas forem rejeitadas (Message sent if calls are rejected).
Ignorar Grupos Boolean Whether to mention them all (controls group notification behavior).
Sempre Online Boolean Whether the instance should always be online or not.
Ler Mensagens Boolean Whether to mark messages as read automatically.
Sincronizar Histórico Completo Boolean Whether to synchronize the complete message history.
Ler Status Boolean Whether to mark statuses as read automatically.

Output

The output is a JSON object reflecting the result of the operation. The structure will typically include confirmation of the settings applied to the specified instance, and may echo back the parameters set. For example:

[
  {
    "instanceName": "MinhaInstancia",
    "rejectCall": true,
    "msgCall": "Não aceitamos ligações telefônicas.",
    "groupsIgnore": false,
    "alwaysOnline": true,
    "readMessages": false,
    "syncFullHistory": false,
    "readStatus": false,
    "status": "success"
  }
]

Note: The actual fields may vary depending on the API response.

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid credentials for the "evolutionApi" in n8n.
  • n8n Configuration: Ensure the node is properly authenticated using the required credentials.

Troubleshooting

  • Common Issues:
    • Missing or invalid credentials will prevent the node from executing successfully.
    • If an unsupported operation or resource is selected, the node will throw an error indicating that the function is not supported.
  • Error Messages:
    • "Operação não suportada."
      Resolution: Check that you have selected a valid combination of Resource and Operation.
    • Credential errors or network issues may result in standard n8n error messages; ensure your API key is correct and the Evolution API is reachable.

Links and References

Discussion