N8N Tools - Uazapi icon

N8N Tools - Uazapi

Complete Uazapi integration - Premium WhatsApp API with advanced messaging and automation

Actions37

Overview

This node integrates with a premium WhatsApp API service to send interactive WhatsApp messages featuring quick reply buttons. It allows users to send a text message accompanied by multiple quick reply buttons that recipients can tap to respond easily. This is particularly useful for automating customer support, surveys, or any scenario where you want to guide the recipient’s response with predefined options.

For example, a business could send a message like "How can we help you today?" with buttons labeled "Order Status", "New Order", and "Speak to Agent". The recipient taps one button, triggering a specific workflow based on their choice.

Properties

Name Meaning
Phone Number WhatsApp number of the recipient including country code (e.g., 5511999999999).
Message Text The main text message displayed above the quick reply buttons.
Buttons A collection of quick reply buttons, each with:
- Button Text: The label shown on the button.
- Button ID: A unique identifier for the button used to identify which button was pressed.
Additional Fields Optional extra settings:
- Reply to Message ID: ID of a message to reply to (for threaded conversations).
- Delay (seconds): Time delay before sending the message.
- Disable Link Preview: Whether to disable link previews in the message.
- Mention Users: Comma-separated phone numbers to mention/tag in the message.

Output

The node outputs a JSON object containing the response from the WhatsApp API after sending the quick reply message. This typically includes details about the sent message such as message ID, status, and any metadata returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "messageId": "string",
  "status": "sent",
  "details": { /* additional API response data */ }
}

Dependencies

  • Requires an active connection to the premium WhatsApp API service.
  • Needs configuration of API credentials including:
    • An API key credential for authentication.
    • API token and instance ID for the WhatsApp instance.
  • The node sends requests through a proxy endpoint hosted at https://n8ntools.io/api/v1/proxy/uazapi.
  • Proper network access to the API endpoints is necessary.

Troubleshooting

  • Common Issues:

    • Invalid phone number format: Ensure the phone number includes the country code without symbols or spaces.
    • Missing or incorrect API credentials: Verify that the API key, token, and instance ID are correctly configured.
    • Button IDs must be unique per message; duplicate IDs may cause errors.
    • Network connectivity issues to the proxy or WhatsApp API endpoints.

  • Error Messages:

    • "Unknown resource": Occurs if the resource parameter is invalid; ensure "message" is selected.
    • API authorization errors: Check that the API token and key are valid and not expired.
    • Validation errors from the API regarding missing required fields like phone number or buttons.

  • Resolution Tips:

    • Double-check all required fields are filled.
    • Validate button collections have at least one button with both text and ID.
    • Use the "Delay" field cautiously to avoid timing conflicts.
    • Enable "Continue On Fail" in n8n to handle errors gracefully during batch processing.

Links and References

Discussion