Overview
This node integrates with the Evolution API to interact with WhatsApp instances. It supports sending text messages, sending media files, and retrieving QR codes for WhatsApp instance connections. This node is useful for automating WhatsApp communications such as customer support messages, marketing campaigns, or sending notifications.
For example:
- Sending a personalized text message to a customer.
- Sharing images, videos, or documents via WhatsApp automatically.
- Retrieving a QR code to connect or authenticate a WhatsApp instance.
Properties
| Name | Meaning |
|---|---|
| Instance | The name of the WhatsApp instance to target for the operation. |
| Phone Number | The recipient's phone number including country code (used in sendMessage and sendMedia). |
| Message | The text message content to be sent (used only in sendMessage). |
Output
The output is a JSON array containing the response data from the Evolution API for each input item processed. The structure depends on the API response but generally includes confirmation or details about the sent message or requested QR code.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for the Evolution API.
- The node makes HTTP requests to the Evolution API endpoints using Axios.
- The base URL and API key must be configured in the node credentials.
Troubleshooting
Common issues:
- Invalid or missing API key will cause authentication errors.
- Incorrect instance name or phone number format may result in failed message delivery.
- Network connectivity problems can prevent API calls from succeeding.
Error messages:
"The operation \"<operation>\" is not supported!"indicates an unsupported operation was selected.- API errors returned from the Evolution API will be included in the error message; check the API documentation for details.
Resolutions:
- Verify that the API key and base URL are correctly set in credentials.
- Ensure phone numbers include the correct country code and no extra characters.
- Confirm the WhatsApp instance name matches what is configured in the Evolution API system.
Links and References
- Evolution API official documentation (not provided in source, please refer to your API provider)
- WhatsApp Business API guidelines for message formatting and media types