WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

WhatsApp Numbers → Get Numbers

AI-generated

Overview

The "Get Numbers" operation under the "WhatsApp Numbers" resource allows users to retrieve a list of WhatsApp numbers managed via the WaliChat API. This node is useful for scenarios where you need to programmatically access and filter WhatsApp numbers based on various criteria such as their IDs, operational status, session status, or search terms. For example, it can be used to fetch all operative WhatsApp numbers currently online or to paginate through a large list of numbers with specific filters applied.

Practical examples include:

  • Fetching all active WhatsApp numbers to display in a dashboard.
  • Retrieving numbers with session errors to trigger alerts or remediation workflows.
  • Searching for a specific number by alias or phone number for targeted messaging or management.

Properties

Name Meaning
Filters A collection of filters to narrow down the WhatsApp numbers returned:
- WhatsApp Number IDs Filter by specific WhatsApp number IDs (multiple values allowed).
- Status Filter by the operational 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 (pagination size). Default is 50.
- Page Number The page number to retrieve, starting from 0 (for pagination).

Output

The node outputs an array of JSON objects representing WhatsApp numbers that match the specified filters. Each object contains details about a WhatsApp number such as its ID, status, session status, phone number, alias, and other metadata as provided by the WaliChat API.

If binary data were involved (not indicated here), it would typically represent media files or attachments related to the numbers, but this operation focuses solely on JSON data describing WhatsApp numbers.

Dependencies

  • Requires an API key credential for authenticating with the WaliChat WhatsApp API.
  • The node depends on the WaliChat service being accessible and properly configured.
  • Pagination parameters require correct handling to navigate through large datasets.

Troubleshooting

  • Empty results: If no numbers are returned, verify that the filters are correctly set and that matching numbers exist in the WaliChat system.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Pagination issues: Make sure the page number and size are within valid ranges; requesting pages beyond available data will result in empty responses.
  • Invalid filter values: Using unsupported status or session status values may cause errors or no results.
  • API rate limits: Excessive requests might be throttled by the WaliChat API; implement retry logic or reduce request frequency if needed.

Links and References

Discussion