WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

WhatsApp Numbers → Get Number by ID

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API, specifically allowing users to retrieve detailed information about WhatsApp numbers managed within the system. The "Get Number by ID" operation fetches data for a specific WhatsApp number using its unique identifier.

Common scenarios where this node is beneficial include:

  • Retrieving configuration or status details of a particular WhatsApp number.
  • Fetching associated metadata such as linked agents, catalogs, or quick replies for that number.
  • Integrating WhatsApp number details into workflows for monitoring or reporting purposes.

Practical example:

  • A customer support workflow might use this node to get the current state and settings of a WhatsApp number before routing incoming messages to appropriate agents or queues.

Properties

Name Meaning
WhatsApp Number ID The unique identifier of the WhatsApp number to retrieve. This is required.
Include Options Additional options to customize the response:
- Include Select extra related information to include in the response. Options are: Agents, Catalog, Quick Replies.
- Exclude Select information to exclude from the response. Options are: Session, Profile, Stats, Queue.

Output

The node outputs a JSON object containing detailed information about the specified WhatsApp number. Depending on the selected include/exclude options, the output may contain:

  • Basic number details (ID, status, etc.).
  • Associated agents managing the number.
  • Business catalog linked to the number.
  • Quick replies configured for the number.
  • Optionally excluded sections like session info, profile data, statistics, or queue details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the WaliChat WhatsApp API via an API key credential.
  • Proper configuration of the API key credential in n8n is necessary.
  • The node depends on internal methods to load available WhatsApp numbers dynamically for selection.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp Number ID will cause the operation to fail.
    • Network or authentication errors if the API key is incorrect or expired.
    • Requesting to include or exclude unsupported options may result in incomplete or unexpected data.
  • Error messages:

    • Errors returned from the API typically include descriptive messages; ensure the WhatsApp Number ID exists and is accessible.
    • Authentication failures require checking the API key credential setup.
    • If the node throws an error about loading devices, verify connectivity and permissions.

Links and References

Discussion