Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node named "Evolution API" provides integration with the Evolution API service. Specifically, for the Resource "Chat" and Operation "List Contacts," it allows users to retrieve a list of contacts from a chat instance. This is useful in scenarios where you want to automate contact management, synchronize contact lists, or perform bulk operations on chat contacts.

For example, a user might use this node to:

  • Fetch all contacts from a specific chat instance to update a CRM system.
  • Retrieve a particular contact's details by specifying their number.
  • Automate messaging workflows based on contact lists.

Properties

Name Meaning
Name Da Instância The name of the chat instance from which to list contacts.
Listar Todos Boolean option to indicate whether to list all contacts (true) or a specific contact (false).
Contato The specific contact number to retrieve when not listing all contacts (used if Listar Todos is false).

Output

The node outputs a JSON array containing the contact(s) information retrieved from the specified chat instance. Each item in the array represents a contact with its associated data as returned by the Evolution API.

If binary data were involved (e.g., profile pictures), it would be included in the output's binary property, but based on the provided code and properties, the output focuses on JSON contact data only.

Dependencies

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

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the selected resource and operation are valid and implemented.
  • Missing Required Parameters: Ensure that required fields such as "Name Da Instância" and either "Listar Todos" or "Contato" (depending on the selection) are correctly filled.
  • API Authentication Issues: Errors related to authentication usually mean the API key or credentials are missing or invalid. Check the configured credentials in n8n.
  • Empty Contact List: If no contacts are returned, confirm that the instance name is correct and that the account has contacts available.

Links and References

Discussion