Actions37
- Message Actions
- Media Actions
- Contact Actions
- Group Actions
- Instance Actions
- Webhook Actions
Overview
This node provides a comprehensive integration with the Uazapi WhatsApp API, enabling users to send and manage WhatsApp messages, media, contacts, groups, instance settings, and webhooks. It supports a wide range of operations such as sending text messages, templates, quick replies, lists, locations, images, documents, audio, videos, stickers, managing contacts and groups, retrieving message history, marking messages as read, and configuring webhooks.
Common scenarios where this node is beneficial include automating customer communication via WhatsApp, managing contact lists and groups for marketing or support purposes, sending rich interactive messages (buttons, lists), and integrating WhatsApp messaging into broader workflows.
Practical examples:
- Sending a personalized text message or template to a customer.
- Uploading and sending an image or document to a user.
- Creating and managing WhatsApp groups for team collaboration.
- Retrieving message history for analytics or auditing.
- Setting up webhook URLs to receive real-time WhatsApp events.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters including: • Reply to Message ID (ID of message to reply to) • Delay (seconds) before sending message • Disable Link Preview (boolean) • Mention Users (comma-separated phone numbers to mention) |
| Phone Number | WhatsApp number with country code (e.g., 5511999999999) |
| Message Text | Text content of the message to send (used in various message types like text, quick reply, list header) |
| Buttons | Quick reply buttons with text and unique IDs (for "Send Quick Reply" operation) |
| List Items | Items for interactive list messages, each with title, description, and unique ID (for "Send List") |
| Latitude | Latitude coordinate (for sending location messages) |
| Longitude | Longitude coordinate (for sending location messages) |
| Location Name | Optional name of the location (for sending location messages) |
| Media URL | URL or base64 string of media file (image, document, audio, video, sticker) |
| Caption | Optional caption for media messages (image, video) |
| Filename | Optional filename for document messages |
| Group ID | WhatsApp group identifier (for group-related operations) |
| Group Name | Name for creating a new WhatsApp group |
| Participants | Comma-separated phone numbers for adding/removing/promoting/demoting group participants |
| Webhook URL | URL to receive webhook events |
Output
The node outputs JSON data representing the response from the Uazapi API for the requested operation. The structure varies depending on the operation but generally includes details about the sent message, retrieved data, or status confirmation.
If the operation involves media upload or download, the output may include URLs or identifiers related to the media files.
Binary data is not directly output by this node; media is handled via URLs or base64 strings passed as input.
Dependencies
- Requires an API key credential for authenticating with the Uazapi WhatsApp API.
- Needs configuration of API URL, API token, and instance ID credentials.
- Uses an external proxy service at
https://n8ntools.io/api/v1/proxy/uazapito forward requests. - Requires internet access to communicate with Uazapi endpoints.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect phone number format may result in errors or undelivered messages.
- Using unsupported media URLs or invalid base64 strings can cause media sending failures.
- Exceeding rate limits or quota on the Uazapi service may lead to request rejections.
Error messages:
- Authentication errors typically indicate invalid API tokens or keys; verify credentials.
- "Unknown resource" error means the selected resource is not recognized; ensure correct resource selection.
- Validation errors often relate to missing required fields like phone number or message text; check input parameters.
- Network or proxy errors suggest connectivity problems; verify network and proxy configurations.
To handle errors gracefully, enable the "Continue On Fail" option to process subsequent items even if some fail.
Links and References
- Uazapi Official Documentation (for detailed API usage)
- WhatsApp Business API Overview
- n8n Documentation (for general node usage and workflow building)