Overview
This node allows sending various types of WhatsApp messages through the Wuzapi WhatsApp API. It supports text, media (images, audio, video, documents, stickers), location, contact cards, interactive templates with buttons, lists, and polls (for groups). This flexibility makes it useful for automating customer communication, notifications, surveys, or interactive campaigns on WhatsApp.
Typical use cases include:
- Sending personalized text or multimedia messages to customers.
- Sharing location or contact information quickly.
- Creating interactive messages with buttons or lists for user engagement.
- Conducting polls in WhatsApp groups.
Properties
| Name | Meaning |
|---|---|
| Message Type | Type of message to send. Options: Text, Image, Audio, Video, Document, Sticker, Location, Contact, Template (with buttons), Buttons (simple buttons message), List, Poll (groups only). |
| Phone Number or Group ID | Target phone number (without + or spaces) or WhatsApp group ID. |
| Message | Text content of the message (used for Text and Buttons message types). |
| Image Source | Source of image data: Binary data from previous node or Base64 encoded string (for Image message type). |
| Binary Property | Name of binary property containing image data (when using binary source). |
| Base64 Image | Base64 encoded image string with data URL prefix (when using base64 source). |
| Caption | Caption text for Image or Video messages. |
| Audio Source | Source of audio data: Binary data or Base64 encoded string (for Audio message type). |
| Audio Binary Property | Name of binary property containing audio data (when using binary source). |
| Base64 Audio | Base64 encoded audio string in opus format (when using base64 source). |
| Video Source | Source of video data: Binary data or Base64 encoded string (for Video message type). |
| Video Binary Property | Name of binary property containing video data (when using binary source). |
| Base64 Video | Base64 encoded video string (H.264 codec, AAC audio) (when using base64 source). |
| Document Source | Source of document data: Binary data or Base64 encoded string (for Document message type). |
| Document Binary Property | Name of binary property containing document data (when using binary source). |
| Base64 Document | Base64 encoded document string (when using base64 source). |
| File Name | Name of the document file (required for Document message type). |
| Sticker Source | Source of sticker data: Binary data or Base64 encoded string (for Sticker message type). |
| Sticker Binary Property | Name of binary property containing sticker data (when using binary source). |
| Base64 Sticker | Base64 encoded sticker in WebP format (when using base64 source). |
| Latitude | Latitude coordinate (required for Location message type). |
| Longitude | Longitude coordinate (required for Location message type). |
| Location Name | Name or label of the location (optional for Location message type). |
| Contact Name | Full name of the contact (required for Contact message type). |
| VCard | VCard data string representing the contact details (required for Contact message type). |
| Content | Main content text of the template message (required for Template message type). |
| Footer | Footer text for the template message (optional). |
| Buttons | Collection of buttons for the template message. Each button has display text and type (Quick Reply, URL, Call). URL and Call types require additional parameters (URL or phone number). |
| Button Text | Text for the list button (required for List message type). |
| Description | Description text of the list (required for List message type). |
| Top Text | Header text shown above the list (required for List message type). |
| Footer Text | Footer text shown below the list (optional for List message type). |
| List Items | Collection of items in the list. Each item requires a title and row ID; description is optional. |
| Poll Question | Question text for the poll (required for Poll message type). |
| Poll Options | Comma-separated list of options for the poll (required for Poll message type). |
| Additional Options | Optional collection including custom message ID and reply-to message context (message ID and participant JID) to reply to a specific message. |
Output
The node outputs an array of JSON objects representing the response from the Wuzapi WhatsApp API for each sent message. The output includes metadata about the execution and the API response data.
If the message involves media, the node processes binary data internally but does not output binary data itself.
Dependencies
- Requires connection to the Wuzapi WhatsApp API via an API key credential configured in n8n.
- Uses helper functions to prepare media data from binary or base64 inputs.
- The node expects input data to contain binary properties when sending media from binary sources.
Troubleshooting
- Binary Property Not Found: If you select a binary source for media but the specified binary property does not exist in the input data, the node will throw an error like
Binary property "xyz" not found. Ensure the previous node outputs the expected binary data under the correct property name. - Invalid Base64 Data: Providing malformed base64 strings may cause errors or failed message sending. Verify that base64 strings include proper data URL prefixes and are correctly encoded.
- Missing Required Fields: Some message types require mandatory fields (e.g., phone number, message body, file name for documents). Omitting these will cause errors.
- Polls Only for Groups: Poll messages require a group ID as the target. Using a phone number instead may result in failure.
- API Errors: Errors returned by the Wuzapi API (e.g., authentication failures, rate limits) will be propagated. Check your API credentials and usage limits.
Links and References
- Wuzapi WhatsApp API Documentation (example link, replace with actual)
- WhatsApp Business API Overview
- n8n Documentation - Creating Custom Nodes