Actions9
Overview
The "ZuckZapGo User" node interacts with the ZuckZapGo WhatsApp API to retrieve and manage user information and presence data. It supports multiple operations such as checking if users have WhatsApp, getting detailed user info, fetching avatars, managing presence status, retrieving business profiles, and more.
This node is useful in scenarios where you need to integrate WhatsApp user data into workflows, for example:
- Verifying if a list of phone numbers are registered on WhatsApp.
- Fetching profile pictures or business details of contacts.
- Managing your own WhatsApp presence or status programmatically.
- Mapping between phone numbers and local IDs (LIDs) used internally by WhatsApp.
Practical examples:
- Automatically check a batch of customer phone numbers to see who can be contacted via WhatsApp.
- Retrieve and display user avatars in a CRM system.
- Update your WhatsApp status message from an external system.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform. Options include: Check Users, Get Avatar, Get Business Profile, Get Contacts, Get LID From Phone, Get My Status, Get Phone From LID, Get Privacy Settings, Get User Info, List LID Mappings, Set My Status, Set Presence, Update Push Name. |
| Phone Numbers/LIDs | Comma-separated list of phone numbers or Local IDs (@lid) to check or get info for. Required for "check" and "info" operations. Example: 5491155553934,5491155553935,5491155554335@lid |
| Target | Phone number, Group ID (@g.us), Newsletter ID (@newsletter), or LID (@lid) to get avatar for. Required for "avatar" operation. |
| Preview | Boolean indicating whether to get a thumbnail (true) or full picture (false) for avatar retrieval. |
| Save as Binary | Boolean indicating whether to save the avatar image as binary data within the workflow. |
| Binary Property Name | Name of the binary property to store the avatar image if saving as binary. |
| Phone Number or JID | Phone number or JID to get Local ID (LID) for. Required for "getLID" operation. |
| Local ID (LID) | Local ID to get phone number for. Required for "getPhoneFromLID" operation. |
| Presence Type | Global presence status to set. Options: Available (online), Unavailable (offline). Required for "presence" operation. |
| Phone Number/JID | Phone number or JID to get business profile for. Required for "businessProfile" operation. |
| Push Name | New display name (push name) to set. Required for "updatePushName" operation. |
| Status Message | Status message to set. Required for "setMyStatus" operation. |
Output
The node outputs JSON data corresponding to the selected operation:
- For "Get User Info" and "Check Users", it returns detailed user information or presence status for each phone number or LID provided.
- For "Get Avatar", it returns a URL or base64 data of the user's profile picture. If "Save as Binary" is enabled, the avatar image is saved as binary data under the specified binary property name.
- Other operations return relevant JSON objects such as contact lists, LID mappings, privacy settings, or confirmation of status updates.
If binary data output is enabled (e.g., avatar images), the binary field contains the image data with MIME type and file extension metadata.
Dependencies
- Requires an active connection to the ZuckZapGo WhatsApp API.
- Needs an API key credential configured in n8n for authentication.
- Uses internal helper functions for phone number validation and API requests.
- No additional external dependencies beyond the API service.
Troubleshooting
- Invalid phone number format: Ensure phone numbers are correctly formatted and validated before input; otherwise, the API may reject them.
- API authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
- Avatar download issues: When saving avatars as binary, ensure the returned data is a valid base64 string or accessible URL. If the URL starts with "http", use an HTTP Request node to download the image.
- Operation not supported error: Confirm that the selected operation matches the available options and required parameters are provided.
- Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON.
Links and References
- ZuckZapGo WhatsApp API Documentation (hypothetical link for reference)
- n8n documentation on Creating Custom Nodes
- General WhatsApp API usage guides and best practices.