Overview
This node integrates with the Evolution API to interact with WhatsApp instances. It supports sending text messages, sending various types of media (images, documents, videos, audio), and retrieving QR codes for WhatsApp instance connections.
A common use case is automating WhatsApp communications within workflows, such as sending notifications, alerts, or media content to contacts programmatically. For example, a business could automatically send an image brochure or a PDF document to customers after they place an order.
Properties
| Name | Meaning |
|---|---|
| Instance | The name identifier of the WhatsApp instance to use for sending messages or media. |
| Phone Number | The recipient's phone number including country code. |
| Media Type | The type of media to send. Options: Image, Document, Video, Audio. |
| Media URL | The URL pointing to the media file to be sent. |
| Caption | Optional caption text to accompany the media message. |
Output
The node outputs JSON data representing the response from the Evolution API for each operation:
- For Send Media, the output contains the API response confirming the media message was sent.
- For Send Message, it returns the API response confirming the text message was sent.
- For Get QR Code, it returns the QR code data needed to connect the WhatsApp instance.
No binary data output is produced by this node; all outputs are JSON objects reflecting the API responses.
Dependencies
- Requires an active Evolution API WhatsApp integration with valid credentials including:
- Base URL of the Evolution API endpoint.
- An API key for authentication.
- The node uses HTTP requests via Axios to communicate with the Evolution API.
- Proper configuration of the API credentials in n8n is necessary before using this node.
Troubleshooting
- Common issues:
- Invalid or missing API key or base URL will cause authentication failures.
- Incorrect WhatsApp instance name may result in errors or no response.
- Providing invalid phone numbers or unsupported media URLs can cause message sending to fail.
- Error messages:
"The operation \"<operation>\" is not supported!"indicates an unsupported operation was requested.- Network or API errors will typically return error messages from the Evolution API; ensure the API endpoint is reachable and credentials are correct.
- To resolve errors, verify credentials, instance names, phone numbers, and media URLs. Also, check network connectivity to the Evolution API service.
Links and References
- Evolution API Documentation (replace with actual link if available)
- WhatsApp Business API Overview
- Axios HTTP Client