Avisa API

Overview

The node integrates with the Avisa API to perform various messaging and contact-related operations. Specifically, for the Contact resource with the Check Number operation, it checks whether a given phone number is registered on WhatsApp.

This functionality is useful in scenarios where you want to verify if a phone number can receive WhatsApp messages before attempting to send any communication. For example, businesses can use this to validate customer numbers in their CRM or during onboarding processes to ensure they only send messages to valid WhatsApp users.

Practical example:

• Before sending promotional messages, check if the customer's phone number is registered on WhatsApp to avoid message failures and improve delivery rates.

Properties

Output

The output JSON contains the result of the number check with the following structure:

• success (boolean): Indicates if the request was successful.
• isWhatsAppNumber (boolean): True if the number is registered on WhatsApp; false otherwise.
• Additional fields returned by the API may be included.
• In case of an invalid WhatsApp number (e.g., status code 400), the output will indicate isWhatsAppNumber: false along with the status code and any error details.
• If an error occurs, the output includes success: false, isWhatsAppNumber: false, and an error message describing the issue.

No binary data is output by this operation.

Dependencies

• Requires an API key credential for authenticating with the Avisa API.
• The base URL for the API is configured via the credentials.
• The node makes HTTP POST requests to the endpoint /actions/checknumber on the Avisa API server.
• Proper network access to the Avisa API service is required.

Troubleshooting

• Common issues:

  • Invalid or missing API authentication token will cause authorization errors.
  • Providing a phone number not in international format may lead to validation errors.
  • Network connectivity problems can cause request failures.

• Error messages:

  • HTTP 400 response indicates an invalid WhatsApp number; the node returns isWhatsAppNumber: false with details.
  • HTTP 401 response indicates unauthorized access due to invalid API credentials.
  • Other errors return success: false with an error message describing the problem.

• Resolution tips:

  • Ensure the API key credential is correctly set up and has necessary permissions.
  • Verify the phone number format matches the international standard (e.g., +1234567890).
  • Check network connectivity and firewall settings allowing outbound requests to the Avisa API.

Links and References

• Avisa API Documentation (Replace with actual link if available)