Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Overview

The node "Evolution API Direct" allows users to interact directly with the Evolution API by specifying a server URL and an API key. It supports various resources and operations, including managing chat contacts. Specifically, for the Chat resource and the Listar Contatos (List Contacts) operation, the node can either list all contacts or retrieve details of a specific contact by its number.

This node is beneficial in scenarios where you need to integrate Evolution API's chat contact management into your workflows, such as syncing contacts, automating messaging processes, or maintaining up-to-date contact lists.

Example use cases:

  • Automatically fetching all chat contacts from an Evolution API instance to update a CRM system.
  • Retrieving information about a specific contact by their phone number to personalize communication.

Properties

Name Meaning
Server URL The full URL of your Evolution API server endpoint (e.g., https://api.exemplo.com).
API Key The API key credential for authenticating requests to the Evolution API instance.
Nome Da Instância The name of the Evolution API instance you want to interact with.
Listar Todos Boolean option to list all contacts (true) or not (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) data retrieved from the Evolution API. Each item in the array represents a contact with its associated details as returned by the API.

If binary data were involved (not indicated here), it would typically represent files or media related to contacts, but this node focuses on JSON contact data only.

Dependencies

  • Requires access to an Evolution API server endpoint.
  • Needs a valid API key credential for authentication.
  • Proper configuration of the server URL and instance name is necessary.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error indicating the operation is not supported. Ensure that the resource is set to "chat-api" and the operation to "find-contacts" for listing contacts.
  • Authentication Failures: Incorrect or missing API key will cause authentication errors. Verify the API key and ensure it has the required permissions.
  • Invalid Server URL: Providing an incorrect or unreachable server URL will result in connection errors. Confirm the URL is correct and accessible.
  • Missing Required Parameters: The node requires certain parameters like Server URL, API Key, Nome Da Instância, and depending on the mode, either Listar Todos or Contato. Make sure all required fields are filled.

Links and References

  • Evolution API Documentation (as referenced in the code defaults)
  • Your Evolution API instance documentation for specific details on chat contacts endpoints and authentication.

Discussion