Overview
The "UZapi Business" node integrates with the UZapi Business API, which is designed for WhatsApp Business interactions. Specifically, the "Connect To Pairing Code" operation allows users to generate a QR code or pairing code to link their WhatsApp Business account with the UZapi service. This facilitates automated messaging and call handling through WhatsApp.
Common scenarios where this node is beneficial include:
- Automating WhatsApp Business account setup by generating pairing codes programmatically.
- Managing WhatsApp Business instances in bulk or as part of larger automation workflows.
- Configuring automatic call rejection and missed call responses on WhatsApp Business accounts.
Practical example:
- A business wants to onboard multiple WhatsApp Business numbers into their CRM system automatically. Using this node, they can generate pairing codes for each number and configure call handling preferences without manual intervention.
Properties
Name | Meaning |
---|---|
App Version | The version of the app to instantiate; currently only "latest" is supported. |
Phone Number (com DDI) | Your WhatsApp phone number in E.164 format (e.g., 5511999998888). |
Auto Reject Calls | Whether to automatically reject incoming calls (true/false). |
Answer Missed Call | Message to send for missed calls (text string). |
Resources | JSON configuration specifying CPU and memory requests and limits for the instance. |
Output
The node outputs JSON data representing the result of the pairing code connection operation. This typically includes information such as the generated QR code or pairing code details, status messages, and any relevant metadata returned by the UZapi Business API.
If binary data (such as an image of the QR code) is returned, it would be included in the output's binary field, allowing downstream nodes to process or display the QR code image.
Dependencies
- Requires an API key credential for authenticating with the UZapi Business API.
- The node depends on the external UZapi Business API endpoint specified by the base URL in credentials.
- Proper network access to the UZapi API service is necessary.
- No additional environment variables are explicitly required beyond the API authentication.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect phone number format (not in E.164) may lead to errors from the API.
- Network connectivity problems can prevent successful API calls.
- Resource configuration values that are too low might cause instance instantiation failures.
Error messages:
"Operation \"<operation>\" não implementada"
indicates the requested operation is not implemented in the node; ensure you select a valid operation.- Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
- Validation errors related to phone number formatting require correcting the input to E.164 standard.
Links and References
- WhatsApp Business API Documentation
- UZapi Business Official Site (for API details and support)
- n8n Documentation on Creating Custom Nodes