Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource Mensaje and operation Enviar Contato, it sends one or more contact cards via WhatsApp to a specified recipient number from a given instance name.

Common scenarios include:

  • Automating the sending of contact information to customers or team members.
  • Sharing business contacts or support representatives' details through WhatsApp.
  • Integrating contact sharing into workflows that require quick dissemination of contact info.

For example, a user can configure this node to send a list of sales representatives' contact cards to a client automatically after a lead is qualified.

Properties

Name Meaning
Nombre De La Instancia The name of the instance that will send the contact(s).
Número Del Destinatario The WhatsApp number of the message recipient (in string format).
Contactos A list of contacts to send. Each contact includes:
- Nombre Completo: Full name of the contact.
- Número De WhatsApp: WhatsApp number (digits only, e.g., 5215599999999).
- Número Formateado: Formatted phone number (e.g., +52 1 55 9999 9999).
- Organización: Organization or company name (optional).
- Correo Electrónico: Email address of the contact (optional).
- URL: Website URL related to the contact (optional).

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the contact(s). The exact structure depends on the API response but typically includes status information about the sent message(s).

No binary data output is indicated in the source code or properties.

Dependencies

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

Troubleshooting

  • Unsupported Operation Error: If the selected operation or resource is not supported, the node throws an error indicating the function is not supported. Ensure the correct resource ("messages-api") and operation ("send-contact") are selected.
  • Missing Required Fields: The node requires the instance name, recipient number, and at least one contact with mandatory fields (full name, WhatsApp number, formatted phone number). Missing these will likely cause errors.
  • API Authentication Failures: Incorrect or missing API credentials will prevent the node from communicating with the Evolution API.
  • Invalid Phone Number Format: The WhatsApp numbers must be numeric strings without special characters except the formatted phone number field which accepts formatting. Invalid formats may cause message sending failures.

Links and References

Discussion