N8N Tools - Uazapi icon

N8N Tools - Uazapi

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

Actions37

Overview

This node integrates with the Uazapi WhatsApp API, providing a comprehensive set of operations to manage WhatsApp messaging, media, contacts, groups, instance settings, and webhooks. Specifically, the Instance - Get QR Code operation retrieves the QR code needed to connect or authenticate a WhatsApp instance.

Use cases for this node include automating WhatsApp communications, managing contacts and groups, sending various message types (text, media, templates), and controlling the WhatsApp instance lifecycle. The Get QR Code operation is particularly useful when setting up or reconnecting a WhatsApp instance, as scanning the QR code with the WhatsApp mobile app establishes the connection.

Example scenario: Automatically retrieve the QR code for your WhatsApp instance to display it in a dashboard or send it via email for manual scanning during setup.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request. Includes:
- Reply to Message ID: ID of a message to reply to
- Delay (seconds): Delay before sending the message
- Disable Link Preview: Whether to disable link previews in messages
- Mention Users: Comma-separated phone numbers to mention in the message

Note: For the Instance - Get QR Code operation, only the "Additional Fields" collection is relevant, but typically no additional fields are required.

Output

The node outputs a JSON object containing the response from the Uazapi API endpoint /v1/instance/qr. This response includes the QR code data necessary to connect the WhatsApp instance. The exact structure depends on the API but generally contains:

  • A string or data representing the QR code (e.g., base64 image or URL)
  • Status information about the instance connection

No binary data output is produced by this operation.

Example output snippet:

{
  "qrCode": "<base64-encoded-qr-code-or-url>",
  "status": "pending"
}

Dependencies

  • Requires an active Uazapi API credential with:
    • API key
    • API token
    • API base URL
    • Instance ID
  • The node sends authenticated HTTP requests to the Uazapi service.
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Common issues:
    • Invalid or expired API token: Ensure the API token is current and correctly configured.
    • Incorrect instance ID: Verify the instance ID matches the WhatsApp instance you want to manage.
    • Network connectivity problems: Confirm that the n8n server can reach the Uazapi endpoints.
  • Error messages:
    • "Unknown resource": Occurs if the resource parameter is incorrect; ensure "instance" is selected.
    • API authorization errors: Check API key and token validity.
    • Timeout or connection errors: Check network and firewall settings.
  • To resolve errors, verify all credentials and parameters, and consult Uazapi API documentation for specific error codes.

Links and References

Discussion