n8n-nodes-n8ntools-yupchat
v1.1.1
Published
N8N Tools - Yup.chat: Send messages and manage communications through Yup.chat multi-channel platform
Maintainers
Readme
N8N Tools - Yup.chat
Send messages and manage communications through Yup.chat multi-channel platform. This N8N community node provides integration with WhatsApp, SMS, RCS, and Omni messaging channels.
✨ Features
- 📱 Multi-Channel Support: WhatsApp, SMS, RCS, and Omni channels
- 📤 Message Sending: Send messages through all supported channels
- 📥 Data Retrieval: Get contacts, rooms, and message information
- 📋 Template Management: Create and manage WhatsApp templates
- 🔒 Secure Authentication: Basic HTTP authentication with Yup.chat API
- 💰 Cost Tracking: Usage monitoring and budget controls
🚀 Quick Start
Installation
Install this node in your N8N instance:
Via Community Nodes (Recommended)
- Go to Settings > Community Nodes in your N8N interface
- Click Install a community node
- Enter
n8n-nodes-n8ntools-yupchat - Click Install
Via npm
npm install n8n-nodes-n8ntools-yupchatSetup Credentials
- Sign up at Yup.chat and get your API credentials
- In N8N, create new Yup.chat API credentials
- Enter your Base URL:
https://api.yup.chat - Enter your API key
📋 Available Resources
SMS Messages
- Send: Send text or template-based SMS messages
- Get Many: Retrieve SMS message history with filters
WhatsApp Messages
- Send: Send text or template WhatsApp messages
- Get Many: Retrieve WhatsApp conversation history
RCS Messages
- Send: Send rich RCS messages (text, media, cards, carousels)
Templates
- Create WhatsApp Template: Create new WhatsApp message templates
- List WhatsApp Templates: Retrieve existing templates
- Delete WhatsApp Template: Remove templates
Rooms
- List Omni Rooms: Retrieve Omni channel rooms
- List Room Messages: Get messages from specific rooms
Contacts
- List Contacts: Retrieve contact information
💡 Usage Examples
Send SMS Message
// Configuration
Resource: "SMS"
Operation: "Send"
To: "5511999999999"
Message Type: "text"
Message Text: "Hello from N8N!"
// Output
{
"success": true,
"resource": "sms",
"operation": "send",
"messageId": "sms_123456789",
"status": "queued",
"creditsUsed": 1
}Send WhatsApp Template
// Configuration
Resource: "WhatsApp"
Operation: "Send"
To: "5511999999999"
Message Type: "template"
Template ID: "welcome_template"
Template Parameters: ["John Doe"]
// Output
{
"success": true,
"resource": "whatsapp",
"operation": "send",
"messageId": "wa_123456789",
"status": "queued",
"creditsUsed": 1
}Create WhatsApp Template
// Configuration
Resource: "Templates"
Operation: "Create"
Template Name: "welcome_template"
Template Body: "Hello {{1}}, welcome to our service!"
Template Type: "TRANSACTIONAL"
Template Parameters: ["name"]
// Output
{
"success": true,
"resource": "templates",
"operation": "create",
"templateId": "tmpl_123456789",
"status": "created",
"creditsUsed": 1
}⚙️ Configuration Options
Authentication
- API URL: Your N8N Tools API URL (default: https://api.n8ntools.io)
- API Key: Your N8N Tools API key
Message Parameters
- To: Recipient phone number in E.164 format (5511999999999)
- From: Sender identifier (optional, depends on channel)
- Message Type: text, template, media (depends on channel)
- Message Content: Text content or template parameters
Template Parameters
- Template Name: Unique identifier for the template
- Template Body: Template content with placeholders
- Template Type: TRANSACTIONAL or MARKETING
- Template Parameters: Array of parameter names
🛠️ Example Workflows
Customer Onboarding
[New User Signup] → [YupChat: Create WhatsApp Template] → [YupChat: Send Welcome Message] → [Track Engagement]Order Notification
[Order Completed] → [YupChat: Send SMS Notification] → [Update Order Status]Support Ticket Response
[Support Ticket Created] → [YupChat: Send WhatsApp Template] → [Agent Assignment]🚨 Error Handling
The node provides comprehensive error handling with detailed messages:
{
"error": "Invalid phone number format",
"success": false,
"resource": "sms",
"operation": "send",
"details": {
"issue": "Phone number must be in E.164 format",
"field": "to",
"value": "invalid_number"
}
}💸 Pricing & Limits
- SMS Messages: 1 credit per message
- WhatsApp Messages: 1 credit per message
- RCS Messages: 2 credits per message
- Templates: 1 credit per template
- API Rate Limits: Based on your N8N Tools subscription plan
📈 Performance Tips
- Batch Operations: Send multiple messages in sequence for bulk operations
- Template Reuse: Create templates once and reuse for multiple sends
- Error Handling: Implement retry logic for transient failures
- Rate Limiting: Respect API rate limits to avoid blocking
🆘 Support
- Documentation: docs.n8ntools.io
- API Reference: api.yup.chat/docs
- Community: Discord
- Email: [email protected]
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by N8N Tools
