Overview
This node, named "UZapi Business," integrates with the UZapi Business API to send various types of WhatsApp messages. It is designed to automate sending messages through WhatsApp Business accounts using the WhatsApp Cloud API via UZapi as a service layer.
Common scenarios where this node is beneficial include:
- Automating customer support messages.
- Sending notifications or alerts to users.
- Broadcasting marketing campaigns with rich media content.
- Sharing location, contacts, or interactive message templates for enhanced user engagement.
For example, you can use this node to send a text message with a delay simulating typing, or send an image with a caption to a specified phone number.
Properties
| Name | Meaning |
|---|---|
| Delay Typing (ms) | Time in milliseconds to simulate typing before sending the message. |
| Delay Message (ms) | Delay in milliseconds before sending the message. |
| Número (com DDI) | Destination phone number including country code, e.g., 5511999998888. |
| Message Type | Type of WhatsApp message to send. Options: Text, Image, Audio, Video, Document, Sticker, Location, Contacts, Template, Interactive. |
| Texto | Text body of the message (used when Message Type is Text). |
| Link do arquivo | Public URL or file path for media files (used for Image, Audio, Video, Document, Sticker). |
| Caption | Caption text for images, videos, or documents. |
| Filename | File name for document type messages (e.g., manual.pdf). |
| Latitude | Latitude coordinate for location messages. |
| Longitude | Longitude coordinate for location messages. |
| Location Name | Name of the location for location messages. |
| Location Address | Full address for location messages. |
| Contacts JSON | JSON array of contacts following the API schema (for Contacts message type). |
| Template Name | Name of the registered template (for Template message type). |
| Language Code | Language code for the template, e.g., pt_BR. |
| Template Components | JSON object defining components of the template such as header, body, and buttons. |
| Interactive Object | Complete JSON object for interactive messages including buttons, lists, or replies. |
Output
The node outputs an array of JSON objects representing the responses from the UZapi Business API after sending each message. Each output item corresponds to one input item processed and contains details about the message sent, such as message ID, status, or error information if applicable.
If binary data is involved (e.g., media files), it is handled by referencing URLs or paths rather than embedding binary content directly.
Dependencies
- Requires an API key credential for authenticating with the UZapi Business API.
- The node depends on the external UZapi Business API endpoint (baseUrl) configured in credentials.
- Uses the WhatsApp Cloud API message types and formats as supported by UZapi.
- No additional environment variables are explicitly required beyond the API credential.
Troubleshooting
- Operation not implemented error: If the selected operation is not recognized, ensure the operation name matches exactly one of the supported operations (e.g., "sendtext").
- Invalid phone number format: The destination number must include the country code without spaces or special characters.
- Media file access issues: For media messages, ensure the provided URL or file path is publicly accessible or correctly referenced.
- Template errors: When sending template messages, verify that the template name, language code, and components conform to those registered in your WhatsApp Business account.
- Delays not working as expected: Check that delay values are numeric and reasonable; very high delays may cause timeouts.
- API authentication failures: Confirm that the API key credential is valid and has necessary permissions.
Links and References
- WhatsApp Cloud API Documentation
- UZapi Business API Documentation (assumed based on context)
- n8n Node Development Guide