Package Information
Available Nodes
Documentation
N8N Tools - Uazapi
Complete Uazapi integration - Premium WhatsApp API with advanced messaging, media handling, and business automation features.
🎯 Launch Special - Showcase Pricing!
This node features promotional credit rates to demonstrate the power and affordability of N8N Tools platform. Experience premium WhatsApp automation at incredibly low costs!
Features
- Premium WhatsApp API: Full-featured WhatsApp Business integration
- Advanced Messaging: Text, templates, quick replies, interactive lists
- Rich Media Support: Images, documents, audio, video, and stickers
- Contact Management: Send contacts, check numbers, profile management
- Group Operations: Create, manage, and moderate WhatsApp groups
- Instance Management: QR codes, status monitoring, profile settings
- Webhook Integration: Real-time event handling and notifications
- Business Features: Template messages, interactive buttons, location sharing
Installation
npm install n8n-nodes-n8ntools-uazapi
Requirements
- Uazapi Account: Premium WhatsApp API service
- API Token: Generate from Uazapi dashboard
- Instance ID: Your WhatsApp Business instance identifier
Credentials
Configure Uazapi API credentials in N8N:
- N8N Tools API Key: Your N8N Tools API key for billing and usage tracking
- Get it from: N8N Tools Dashboard - API Keys
- Required for all operations (enables credit-based billing)
- API URL: Uazapi API endpoint
- Production:
https://api.uazapi.com - Testing:
https://free.uazapi.dev
- Production:
- API Token: Your Uazapi API token from dashboard
- Instance ID: Your WhatsApp instance identifier
Credit System
This node operates on N8N Tools' credit-based billing system with promotional pricing:
- Basic Messaging: 1 credit per text message
- Media Messages: 1 credit per media message (all formats)
- Template Messages: 2 credits per template message
- Interactive Messages: 2 credits per quick reply/list message
- Group Operations: 1-2 credits per operation
- Contact Operations: 1 credit per operation
- Instance Management: 1 credit per operation
- Real-time Tracking: Monitor usage in your N8N Tools dashboard
🎉 Special Launch Pricing: Extremely affordable rates to showcase N8N Tools capabilities!
💡 Why These Low Rates?
This pricing demonstrates that N8N Tools can offer premium automation services at accessible costs. Perfect for:
- Testing & Development: Try advanced WhatsApp features without high costs
- Small Businesses: Affordable customer communication automation
- Agencies: Showcase client solutions with minimal overhead
- Learning: Explore WhatsApp API capabilities hands-on
All requests are securely proxied through N8N Tools infrastructure for billing, monitoring, and enhanced reliability.
Operations
Message Management
- Send Text: Send text messages with formatting support
- Send Template: Send WhatsApp Business template messages
- Send Quick Reply: Send messages with interactive buttons
- Send List: Send interactive list messages for selections
- Send Location: Share location coordinates with names
- Get Messages: Retrieve message history and conversations
- Mark as Read: Mark messages as read for better UX
Media Operations
- Send Image: Send images with optional captions
- Send Document: Send PDF, Word, Excel files with names
- Send Audio: Send voice messages and audio files
- Send Video: Send videos with optional captions
- Send Sticker: Send custom stickers and emojis
- Upload Media: Upload files to Uazapi servers
- Get Media URL: Get download URLs for received media
Contact Management
- Send Contact: Share contact information (vCard format)
- Get Contact Info: Retrieve contact details and status
- Check Number: Verify if number exists on WhatsApp
- Get Profile Photo: Download contact profile pictures
- Block Contact: Block unwanted contacts
- Unblock Contact: Unblock previously blocked contacts
Group Operations
- Create Group: Create new WhatsApp groups with participants
- Get Group Info: Retrieve group details and participant list
- Update Group: Modify group name, description, and settings
- Add Participant: Add new members to existing groups
- Remove Participant: Remove members from groups
- Promote Admin: Grant admin privileges to participants
- Demote Admin: Remove admin privileges from members
- Leave Group: Exit from WhatsApp groups
Instance Management
- Get Status: Check WhatsApp connection status
- Get QR Code: Generate QR code for new connections
- Restart Instance: Restart WhatsApp instance connection
- Logout: Disconnect from WhatsApp account
- Set Profile: Update business profile information
- Get Chats: List all active conversations
Webhook Configuration
- Set Webhook: Configure URL to receive events
- Get Webhook: View current webhook configuration
- Delete Webhook: Remove webhook integration
Usage Examples
Send Text Message
{
"resource": "message",
"operation": "sendText",
"phoneNumber": "5511999999999",
"messageText": "Hello! Welcome to our service. How can we help you today?",
"additionalFields": {
"delay": 2,
"disableLinkPreview": false
}
}
Send Quick Reply Buttons
{
"resource": "message",
"operation": "sendQuickReply",
"phoneNumber": "5511999999999",
"messageText": "Please choose an option:",
"buttons": {
"button": [
{"text": "Support", "id": "support_btn"},
{"text": "Sales", "id": "sales_btn"},
{"text": "Information", "id": "info_btn"}
]
}
}
Send Interactive List
{
"resource": "message",
"operation": "sendList",
"phoneNumber": "5511999999999",
"messageText": "Our Services",
"listItems": {
"item": [
{"title": "Web Design", "description": "Custom website creation", "id": "web_design"},
{"title": "App Development", "description": "Mobile app solutions", "id": "app_dev"},
{"title": "SEO Services", "description": "Search engine optimization", "id": "seo"}
]
}
}
Send Image with Caption
{
"resource": "media",
"operation": "sendImage",
"phoneNumber": "5511999999999",
"mediaUrl": "https://example.com/image.jpg",
"caption": "Check out our latest product! 🚀"
}
Send Document
{
"resource": "media",
"operation": "sendDocument",
"phoneNumber": "5511999999999",
"mediaUrl": "https://example.com/catalog.pdf",
"filename": "Product_Catalog_2024.pdf"
}
Create WhatsApp Group
{
"resource": "group",
"operation": "createGroup",
"groupName": "Customer Support Team",
"participants": "5511888888888,5511777777777,5511666666666"
}
Send Location
{
"resource": "message",
"operation": "sendLocation",
"phoneNumber": "5511999999999",
"latitude": -23.5505,
"longitude": -46.6333,
"locationName": "São Paulo Office"
}
Check WhatsApp Number
{
"resource": "contact",
"operation": "checkNumber",
"phoneNumber": "5511999999999"
}
Set Webhook for Events
{
"resource": "webhook",
"operation": "setWebhook",
"webhookUrl": "https://yourapp.com/webhook/uazapi"
}
Message Types
Text Messages
- Plain text with WhatsApp formatting (bold, italic,
strikethrough) - Emoji support and Unicode characters
- Link detection with automatic previews
- Mention support (@contact)
Interactive Messages
- Quick Replies: Up to 3 buttons per message
- List Messages: Up to 10 items with titles and descriptions
- Template Messages: Pre-approved business templates
Media Messages
- Images: JPEG, PNG (max 5MB)
- Documents: PDF, DOC, XLS, PPT (max 100MB)
- Audio: MP3, AAC, OGG (max 16MB)
- Video: MP4, AVI, MOV (max 16MB)
- Stickers: WebP format with transparency
Business Features
Template Messages
- Pre-approved message templates for businesses
- Support for variables and dynamic content
- Compliance with WhatsApp Business policies
- Lower costs for template messages
Interactive Elements
- Quick reply buttons for streamlined responses
- List messages for product catalogs
- Location sharing for store locations
- Contact sharing for business cards
Group Management
- Create branded business groups
- Moderate discussions and participants
- Broadcast to multiple groups simultaneously
- Admin controls and participant management
Webhook Events
Real-time notifications for:
- Incoming messages and media
- Message delivery status updates
- User interactions with buttons/lists
- Group participant changes
- Instance status changes
Authentication Types
Bearer Token Authentication
Uazapi uses Bearer token authentication with instance-specific access:
- API Token: Personal or business account token
- Instance ID: Specific WhatsApp Business instance
- Secure Headers: All requests include authentication headers
Instance Management
- Multiple instances per account
- Individual QR code generation
- Separate webhook configurations
- Independent status monitoring
Rate Limiting
Uazapi enforces rate limits to ensure service stability:
- Messaging: 100 messages per minute per instance
- Media: 20 media messages per minute
- API Calls: 500 requests per minute
- Webhooks: 1000 events per minute
Monitor your usage and implement appropriate retry logic for production applications.
Error Handling
The node provides comprehensive error handling:
- Connection Errors: Instance disconnection notifications
- Rate Limiting: Automatic retry with backoff
- Invalid Numbers: Number validation and existence checking
- Media Errors: File size and format validation
- Permission Errors: Group and contact permission checks
Webhook Integration
Event Types
{
"message": "Incoming text/media message",
"message_status": "Message delivery status",
"button_reply": "Quick reply button interaction",
"list_reply": "List selection response",
"group_participant": "Group member changes"
}
Webhook Payload Example
{
"instance": "your-instance-id",
"event": "message",
"data": {
"id": "message-id",
"from": "5511999999999",
"body": "Hello!",
"type": "text",
"timestamp": 1640995200
}
}
Troubleshooting
Common Issues
Instance Not Connected
- Check QR code status
- Verify WhatsApp account is active
- Restart instance if needed
Messages Not Sending
- Verify phone number format (include country code)
- Check account balance and limits
- Validate message content and media files
Webhook Not Receiving Events
- Verify webhook URL is accessible
- Check SSL certificate validity
- Test endpoint with webhook testing tools
Media Upload Failures
- Check file size limits (varies by type)
- Verify supported file formats
- Ensure media URL is accessible
Support
- Documentation: Uazapi Docs
- API Reference: Uazapi API
- Issues: GitHub Issues
- N8N Tools Support: Dashboard Help
Business Use Cases
Customer Support
- Automated response to common questions
- Ticket creation and status updates
- Multi-agent support with group management
- File sharing for troubleshooting
Marketing Campaigns
- Bulk messaging with personalization
- Interactive product catalogs
- Location-based promotions
- Event notifications and reminders
E-commerce Integration
- Order confirmations and tracking
- Abandoned cart recovery messages
- Product recommendations
- Customer feedback collection
Appointment Booking
- Appointment confirmations
- Reminder notifications
- Rescheduling and cancellations
- Calendar integration via webhooks
This comprehensive Uazapi integration enables businesses to leverage WhatsApp's full potential for customer communication, marketing, and automation while maintaining compliance with WhatsApp Business policies.