UazAPI

Overview

The node integrates with the UazAPI service, providing comprehensive automation capabilities for WhatsApp through over 90 endpoints. Specifically, the Instance - Connect operation allows users to connect a named WhatsApp instance to the UazAPI platform, which generates a QR code for pairing the WhatsApp client.

This operation is useful when you want to programmatically establish a connection between your WhatsApp instance and the UazAPI service, enabling further automated interactions such as sending messages, managing groups, or running campaigns.

Practical example:
You have a WhatsApp instance named "minha-instancia" and want to initiate its connection process to receive a QR code for scanning. You can use this node operation to trigger that connection request, optionally specifying a phone number to assist in pairing.

Properties

Output

The output JSON contains the response from the UazAPI endpoint /instance/connect. This typically includes data related to the connection status and the QR code needed for pairing the WhatsApp instance.

Example output structure (simplified):

{
  "qrCode": "base64-encoded-string-or-URL",
  "status": "pending",
  "message": "Scan the QR code to connect"
}

The exact fields depend on the UazAPI response but generally provide the QR code and connection status.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for authenticating requests to the UazAPI service.
• The base URL for the UazAPI must be configured in the credentials.
• Network access to the UazAPI endpoints is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing instance name will cause the API call to fail.
  • Incorrect or expired API authentication token may result in authorization errors.
  • Network connectivity problems can prevent reaching the UazAPI server.
  • If the phone number is provided incorrectly, pairing might not work as expected.

• Error messages:

  • Authorization errors usually indicate invalid API credentials; verify and update them.
  • Validation errors may occur if required parameters like instance name are missing or malformed.
  • Timeout or network errors suggest connectivity issues; check firewall and internet access.

Links and References

• UazAPI Official Documentation (replace with actual link if available)
• WhatsApp Business API concepts for understanding instance connections and QR code pairing.