Overview
This node, named "Uzapi Business," interacts with the Uzapi Business API to facilitate WhatsApp-related operations. Specifically, for the "Pairing Code" operation, it generates a pairing code linked to a given phone number and associates it with a specified webhook URL. This is useful when integrating WhatsApp messaging capabilities into workflows, allowing users to link their WhatsApp business account via a pairing process.
Practical examples include:
- Automatically generating a pairing code for a new WhatsApp business phone number.
- Setting up a webhook URL to receive events or messages from the WhatsApp account through n8n.
- Streamlining onboarding processes where WhatsApp integration is required.
Properties
| Name | Meaning |
|---|---|
| Número de Telefone | The phone number (including country code, e.g., 5511999998888) for which to generate the pairing code. |
| Webhook URL | The public HTTPS URL of your n8n webhook endpoint that will receive events related to this pairing. |
Output
The node outputs JSON data representing the result of the pairing code generation operation. This typically includes information such as the generated pairing code and any relevant metadata returned by the Uzapi Business API.
No binary data output is indicated in the source code.
Dependencies
- Requires an API key credential for authenticating with the Uzapi Business API.
- Needs network access to the Uzapi Business API endpoints.
- The user must provide a valid public HTTPS webhook URL to receive callbacks or events.
- The node depends on internal utility modules and an API client bundled within the node's package.
Troubleshooting
Common issues:
- Invalid or missing phone number format may cause the API to reject the request.
- Incorrect or unreachable webhook URL can prevent event delivery.
- Missing or invalid API credentials will lead to authentication errors.
- Network connectivity problems can cause timeouts or failures.
Error messages:
"Operation \"pairingCode\" não implementada"indicates the requested operation is not implemented; ensure the operation name is correct.- Authentication errors suggest checking the provided API key or token.
- Validation errors usually relate to incorrect input properties like phone number or webhook URL.
To resolve these issues, verify all inputs, ensure credentials are correctly configured, and confirm network accessibility.
Links and References
- Uzapi Business API Documentation (example placeholder, replace with actual URL)
- n8n Webhook Documentation
- General WhatsApp Business API guides for understanding pairing and webhook setup.