Overview
This node allows sending various types of WhatsApp messages through the ZuckZapGo WhatsApp API. It supports a wide range of message formats including text, images, audio, video, documents, stickers, locations, contacts, templates with buttons, interactive buttons, lists, polls (for groups), and links with automatic previews.
Common scenarios for this node include automating customer support messages, broadcasting multimedia content, conducting polls in WhatsApp groups, sharing contact cards or locations, and sending interactive messages with buttons or lists to engage users.
For example:
- Sending a promotional image with a caption to a customer.
- Sharing a location pin during an event coordination.
- Conducting a poll in a group chat to gather opinions.
- Sending a template message with quick reply buttons for user feedback.
Properties
| Name | Meaning |
|---|---|
| Message Type | Type of message to send. Options: Text, Image, Audio, Video, Document, Sticker, Location, Contact, Template, Buttons, List, Poll, Link. |
| Recipient | Phone number, Group ID (@g.us), Newsletter ID (@newsletter), or LID (@lid) identifying the message recipient. |
| Message | Text content of the message (used for Text and Buttons message types). |
| Link URL | URL to send with automatic preview generation (used for Link message type). |
| Caption (linkCaption) | Optional text accompanying the link (Link message type). |
| Image Source | Source of the image: Binary data from previous node, Base64 encoded string, or URL (Image message type). |
| Binary Property (image) | Name of binary property containing the image data (when using binary source). |
| Base64 Image | Base64 encoded image string with data URL prefix (Image message type). |
| Image URL | URL to the image file (Image message type). |
| Caption (image/video) | Caption text for image or video messages. |
| Audio Source | Source of the audio: Binary data, Base64 encoded string, or URL (Audio message type). |
| Binary Property (audio) | Name of binary property containing the audio data (when using binary source). |
| Base64 Audio | Base64 encoded audio in opus format (Audio message type). |
| Audio URL | URL to the audio file (Audio message type). |
| Video Source | Source of the video: Binary data, Base64 encoded string, or URL (Video message type). |
| Binary Property (video) | Name of binary property containing the video data (when using binary source). |
| Base64 Video | Base64 encoded video (H.264 codec, AAC audio) (Video message type). |
| Video URL | URL to the video file (Video message type). |
| Document Source | Source of the document: Binary data, Base64 encoded string, or URL (Document message type). |
| Binary Property (document) | Name of binary property containing the document data (when using binary source). |
| Base64 Document | Base64 encoded document (Document message type). |
| Document URL | URL to the document file (Document message type). |
| File Name | Name of the document file (required for Document message type). |
| Sticker Source | Source of the sticker: Binary data, Base64 encoded string, or URL (Sticker message type). |
| Binary Property (sticker) | Name of binary property containing the sticker data (when using binary source). |
| Base64 Sticker | Base64 encoded sticker in WebP format (Sticker message type). |
| Sticker URL | URL to the sticker file (Sticker message type). |
| Latitude | Latitude coordinate (Location message type). |
| Longitude | Longitude coordinate (Location message type). |
| Location Name | Name of the location (optional, Location message type). |
| Contact Name | Full name of the contact (Contact message type). |
| VCard | VCard data for the contact card (Contact message type). |
| Content | Main content of the template message (Template message type). |
| Footer | Footer text for the template message (Template message type). |
| Buttons (templateButtons) | Collection of buttons for the template message. Each button has Display Text and Type (Quick Reply, URL, Call). URL and Phone Number are required depending on button type. |
| Button Text | Text for the list button (List message type). |
| Description | Description of the list (List message type). |
| Top Text | Header text shown above the list (List message type). |
| Footer Text | Text shown below the list (List message type). |
| List Items | Collection of list items, each with Title, optional Description, and Row ID (unique identifier) (List message type). |
| Poll Question | Question text for the poll (Poll message type, groups only). |
| Poll Options | Comma-separated list of poll options (Poll message type). |
| Additional Options | Collection of additional settings: - Message ID (custom or auto-generated) - Presence Simulation (milliseconds to simulate typing or recording, max 30000) - Message Duration (expiration time) - View Once (image/video/audio only) - Link Preview (text only) - Context Information (forwarded, mentions, replies) |
Output
The node outputs JSON data representing the response from the ZuckZapGo WhatsApp API after sending the message. The output includes details about the sent message such as message IDs and status.
If an error occurs and "Continue On Fail" is enabled, the output will contain an error object with the error message.
Binary data is not output by this node; it only sends media data but does not return media content.
Dependencies
- Requires connection to the ZuckZapGo WhatsApp API.
- Requires an API key credential configured in n8n for authentication with the ZuckZapGo service.
- Uses helper functions to prepare media data from binary buffers.
- The node expects input binary data when sending media from previous nodes if the source is set to binary.
Troubleshooting
- Binary Property Not Found: If the selected binary property does not exist in the input data, the node throws an error indicating the missing property. Ensure that the binary data exists and the property name matches exactly.
- Invalid URLs: For URL-based media sources, ensure URLs are valid and accessible.
- Presence Simulation Limits: Presence simulation time must be between 0 and 30000 milliseconds.
- Message Duration Values: Only specific durations are accepted (No expiration, 24 hours, 7 days, 90 days).
- Required Fields Missing: Some message types require mandatory fields (e.g., File Name for documents, Contact Name and VCard for contacts). Make sure these are provided.
- API Errors: Errors returned from the ZuckZapGo API will be surfaced. Check API credentials and network connectivity.
- Mentioned Users Format: When mentioning users, provide comma-separated JIDs in the correct format.
Links and References
- ZuckZapGo WhatsApp API Documentation (replace with actual URL)
- WhatsApp Message Types Reference
- n8n Documentation on Creating Custom Nodes