WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

User Status → Get User Status

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API to retrieve user status information related to WhatsApp numbers. Specifically, the "Get User Status" operation fetches statuses published by WhatsApp users, allowing filtering and sorting based on various criteria such as message flow direction, delivery status, content type, date ranges, and more.

Common scenarios where this node is beneficial include:

  • Monitoring the status updates sent or scheduled by specific WhatsApp numbers.
  • Filtering statuses by delivery acknowledgment (e.g., pending, delivered, read).
  • Searching for statuses containing certain text or media filenames.
  • Paginating through large sets of status messages.
  • Analyzing inbound vs outbound status messages for reporting or automation.

Practical example:

  • A business wants to track all image-type statuses sent from their WhatsApp number that have been delivered but not yet read, to trigger follow-up actions.
  • Another use case is retrieving scheduled statuses to be published in the future for planning marketing campaigns.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) whose user statuses you want to query.
Filters A collection of optional filters to narrow down the returned statuses:
  Flow Filter statuses by message flow direction: Inbound or Outbound.
  My Status Only Return only statuses published by your own WhatsApp number (boolean).
  Scheduled Only Return only statuses that are scheduled to be published in the future (boolean).
  Delivery Status Filter statuses by delivery acknowledgment status. Options: Pending, Sent, Delivered, Read, Failed.
  WhatsApp IDs Filter statuses by one or multiple WhatsApp IDs (WID).
  Search Search statuses by partial text content, contact name, or media filename (string).
  Chat ID Filter statuses by chat WhatsApp ID (string).
  Phone Number Return statuses sent from a given phone number or WhatsApp WID (string).
  Reference Filter statuses by exact match of the reference field (string).
  Type Filter statuses by entry kind/type. Options: Text, Image, Video.
  Begin From Message ID Return newest statuses starting from the given message ID (string).
  End At Message ID Return oldest statuses starting from the given message ID (string).
  Created After Return statuses created after the given date/time.
  Created Before Return statuses created before the given date/time.
  Sort Sort statuses by date. Options: Recent First (date descending), Oldest First (date ascending).
  Results Page Size Number of results per page (number). Default is 20.
  Page Number Page number to return, starting from 0 (number).

Output

The node outputs an array of JSON objects representing user statuses matching the specified filters. Each object contains details about a single user status, including metadata such as:

  • Status content (text, image, video)
  • Delivery acknowledgment state
  • Associated WhatsApp IDs and phone numbers
  • Timestamps (creation date, scheduled publish date)
  • Reference fields and chat identifiers

If binary data is included (e.g., images or videos in statuses), it would typically be represented separately in the output's binary property, though this is not explicitly detailed here.

Dependencies

  • Requires an active connection to the WaliChat WhatsApp API via an API key credential configured in n8n.
  • The node depends on the WaliChat API endpoints for user status retrieval.
  • Proper permissions and valid WhatsApp numbers must be set up in the WaliChat account to access user statuses.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp number ID will result in no data or errors.
    • Incorrect API key or expired credentials will cause authentication failures.
    • Using incompatible filter combinations may yield empty results.
    • Pagination parameters out of range can lead to empty pages.

  • Error messages:

    • Authentication errors: Verify the API key credential is correctly configured and active.
    • Not found or invalid device ID: Confirm the WhatsApp number ID exists and is accessible.
    • Rate limiting or API quota exceeded: Check WaliChat API usage limits and adjust request frequency.

Resolving these usually involves checking credentials, verifying input parameters, and ensuring the WaliChat account has the necessary access rights.

Links and References

Discussion