Overview
This node integrates with the Evolution API to interact with WhatsApp instances. It allows users to send text messages, send media files, or retrieve a QR code for connecting a WhatsApp instance. This 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 automatically via WhatsApp.
- Retrieving a QR code to link a new WhatsApp instance for messaging.
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 sending messages/media). |
| Message | The text content of the message to be sent (only for Send Message operation). |
Output
The output is a JSON array where each item corresponds to the result of an operation on an input item. For the "Send Message" operation, it returns the API response confirming the message was sent. For "Send Media," it returns the API response related to the media message delivery. For "Get QR Code," it returns the QR code data needed to connect the WhatsApp instance.
If an error occurs and the node is set to continue on failure, the output will include an object with an error field describing the issue.
No binary data output is produced by this node.
Dependencies
- Requires an external Evolution API service URL and an API key credential for authentication.
- The node uses HTTP requests to communicate with the Evolution API endpoints.
- Proper configuration of the API credentials within n8n is necessary.
Troubleshooting
Common issues:
- Invalid or missing API key or URL will cause authentication failures.
- Incorrect instance name may lead to "instance not found" errors.
- Malformed phone numbers can cause message sending to fail.
- Network connectivity problems can prevent API calls from succeeding.
Error messages:
"The operation \"<operation>\" is not supported!": Indicates an unsupported operation was requested; ensure only valid operations are used.- API errors returned from the Evolution API will be included in the output if "continue on fail" is enabled.
Resolutions:
- Verify API credentials and endpoint URLs.
- Confirm the instance name matches one configured in the Evolution API.
- Validate phone numbers follow the correct international format.
- Check network access and firewall settings.
Links and References
- Evolution API documentation (refer to your provider's official docs)
- WhatsApp Business API guidelines for message formatting and media types