Actions64
- Instance Actions
- Message Actions
- Group Actions
- Integration Actions
- Chat Actions
- Profile Actions
- Event Actions
Overview
The node named "Evolution API" provides an interface to interact with the Evolution API service. Specifically, for the Chat resource and the List Contacts operation, it allows users to retrieve a list of contacts from their chat instance. This can be useful in scenarios where you want to automate workflows involving contact management, such as syncing contacts, filtering specific contacts for messaging campaigns, or integrating contact data into other systems.
For example, a user might use this node to:
- Retrieve all contacts from a chat instance to export them to a CRM.
- Find a specific contact by number to check their status or send targeted messages.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the chat instance to connect to. |
| List All | Boolean option to either list all contacts (true) or specify a single contact (false). |
| Contact | When List All is false, specify the exact contact number (remote JID) to retrieve. |
Output
The node outputs a JSON array containing the contact(s) information retrieved from the Evolution API. Each item in the array represents a contact object with details as provided by the API. The exact structure depends on the API response but typically includes identifiers like contact ID, name, and possibly status or metadata.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Evolution API.
- The node uses the base URL
https://doc.evolution-api.com/api-referencefor API requests. - Proper configuration of the API credential within n8n is necessary for successful execution.
Troubleshooting
- Operation not supported error: If the specified operation or resource is not implemented, the node will throw an error indicating the function is unsupported. Ensure that the resource is set to "chat" and operation to "list contacts".
- Authentication errors: Failure to provide valid API credentials will result in authentication failures. Verify that the API key or token is correctly configured.
- Empty results: If no contacts are returned, verify that the instance name is correct and that the account has contacts available.
- Invalid contact number: When specifying a single contact, ensure the remote JID format matches what the API expects.
Links and References
- Evolution API Documentation (official API reference)