Wassenger icon

Wassenger

Interact with Wassenger WhatsApp API

Actions148

Overview

This node interacts with the Wassenger WhatsApp API, specifically to retrieve information about WhatsApp numbers associated with the user's account. The "Get Numbers" operation under the "WhatsApp Numbers" resource allows users to filter and fetch details of WhatsApp numbers based on various criteria such as IDs, status, session status, or search terms.

Common scenarios where this node is beneficial include:

  • Managing multiple WhatsApp numbers linked to a business or service.
  • Monitoring the operational status and session state of WhatsApp numbers.
  • Searching for specific numbers by phone number, alias, or ID.
  • Paginating through large sets of WhatsApp numbers for reporting or synchronization purposes.

Practical example:

  • A customer support team wants to list all operative WhatsApp numbers currently online to assign incoming chats efficiently.
  • An admin wants to retrieve all disabled WhatsApp numbers to audit and possibly reactivate them.

Properties

Name Meaning
Filters Collection of filters to narrow down the WhatsApp numbers retrieved. Includes:
- WhatsApp Number IDs Filter by specific WhatsApp number IDs (multiple values allowed).
- Status Filter by the status of the WhatsApp numbers. Options: Operative, Pending, Disabled, Removed.
- Session Status Filter by the session status of the WhatsApp numbers. Options: Authorize, Online, Timeout, Offline, Error.
- Search Term Search WhatsApp numbers by phone number, alias, or ID using a text string.
- Results Page Size Number of results to return per page (default 50).
- Page Number Page number to retrieve, starting from 0 (default 0).

Output

The output is an array of JSON objects, each representing a WhatsApp number matching the specified filters. Each object contains detailed information about a WhatsApp number, including but not limited to its ID, phone number, alias, status, and session status.

If the node supports binary data output (not indicated explicitly in the provided code), it would typically represent media or files related to WhatsApp numbers, but here the focus is on JSON data describing the numbers.

Dependencies

  • Requires an API key credential for authenticating with the Wassenger WhatsApp API.
  • The node depends on the Wassenger API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Using invalid filter values (e.g., non-existent WhatsApp number IDs) may result in empty responses.
    • Pagination parameters out of range might return no results or errors.
  • Error messages:

    • Authentication errors typically indicate problems with the API key; verify the credential setup.
    • Network or API errors may occur if the Wassenger service is unreachable; check connectivity.
    • If the node throws errors related to unsupported operations, ensure the correct Resource ("WhatsApp Numbers") and Operation ("Get Numbers") are selected.

Links and References

Discussion