Overview
The ZuckZapGo Chat node enables various chat-related operations using the ZuckZapGo WhatsApp API. It is designed to interact with WhatsApp messages and chats programmatically, allowing users to automate tasks such as editing or deleting messages, downloading media, marking messages as read, reacting to messages, and setting typing or recording presence indicators.
This node is beneficial in scenarios where automated message management is needed, for example:
- Editing a previously sent message to correct typos or update information.
- Downloading media files from received messages for processing or storage.
- Marking multiple messages as read after processing them.
- Sending emoji reactions to messages to acknowledge or respond quickly.
- Indicating typing or recording status to improve chat interactivity.
Practical Example
- A customer support automation workflow could use this node to edit a sent message if additional information becomes available.
- A media monitoring system might download images or videos shared in chats for analysis.
- A chatbot could mark messages as read once processed to keep the conversation state synchronized.
Properties
| Name | Meaning |
|---|---|
| Message ID | ID of the message to delete (for Delete Message operation). |
| Message ID | ID of the message to edit (for Edit Message operation). |
| Phone Number | Phone number or "me:" prefix indicating your own message (for Edit Message operation). |
| New Message | New content text to replace the existing message body (for Edit Message operation). |
| Media Type | Type of media to download: Audio, Document, Image, or Video (for Download Media operation). |
| Media URL | URL of the media file to download (for Download Media operation). |
| Direct Path | Optional direct path to the media file (for Download Media operation). |
| Media Key | Encryption key for the media file (for Download Media operation). |
| Mime Type | MIME type of the media file (e.g., image/jpeg) (for Download Media operation). |
| File SHA256 | SHA256 hash of the media file (for Download Media operation). |
| File Length | Size of the media file in bytes (for Download Media operation). |
| Additional Fields | Optional extra fields for media download, including encrypted file SHA256 and binary property name. |
| Message IDs | Comma-separated list of message IDs to mark as read (for Mark as Read operation). |
| Chat JID | JID of the chat containing the messages (for Mark as Read operation). |
| Sender JID | JID of the message sender (optional for Mark as Read operation). |
| Phone Number | Phone number or "me:" prefix for your own message (for React to Message operation). |
| Reaction | Emoji character(s) to react with; leave empty to remove reaction (for React to Message). |
| Message ID | ID of the message to react to, prefixed with "me:" for own messages (for React to Message). |
| Phone Number | Phone number to set presence for (for Set Presence operation). |
| State | Presence state to set: Typing (composing) or Not Typing (paused) (for Set Presence). |
| Media Type | Type of media being composed: None or Audio (for Set Presence operation). |
Output
The node outputs JSON data representing the response from the ZuckZapGo WhatsApp API for each operation performed. The structure varies depending on the operation:
- For Edit Message, the output contains confirmation or details about the edited message.
- For Delete Message, it confirms deletion success.
- For Download Media, the node outputs the downloaded media as binary data attached to the item under a configurable binary property (default
"data"). The binary data includes:- Base64-encoded media content.
- MIME type.
- File extension inferred from MIME type.
- Filename constructed as
downloaded-media.<extension>.
- For Mark as Read, React to Message, and Set Presence, the output contains status or confirmation responses.
If an error occurs during execution, the node can output an error object with the error message if configured to continue on failure.
Dependencies
- Requires connection to the ZuckZapGo WhatsApp API via an API key credential configured in n8n.
- Uses the internal helper function to make authenticated HTTP POST requests to the API endpoints.
- No other external dependencies are required.
Troubleshooting
Common Issues:
- Invalid or missing message IDs will cause API errors when trying to edit, delete, react, or mark messages.
- Incorrect phone number format may lead to failures identifying the target message or chat.
- Missing or incorrect media keys, URLs, or hashes will prevent successful media downloads.
- Insufficient permissions or expired API credentials will result in authentication errors.
Error Messages:
- Errors returned by the API are surfaced as error messages in the node output.
- If "Continue On Fail" is disabled, the node execution stops on the first error.
- To resolve errors, verify all required parameters, ensure valid API credentials, and confirm that message IDs and phone numbers exist and are correctly formatted.
Links and References
- ZuckZapGo WhatsApp API Documentation (Replace with actual URL if available)
- WhatsApp Messaging Concepts
- n8n Documentation on Creating Custom Nodes