WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

Campaigns → Get Campaign Contacts

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API to retrieve contacts associated with a specific campaign. It allows users to fetch detailed contact information filtered by various criteria such as phone number, group ID, delivery status, and message IDs. This is particularly useful for marketing teams or customer support agents who want to analyze or act upon the contacts involved in a WhatsApp campaign.

Practical examples:

  • Fetch all contacts from a campaign that have a "delivered" message status to follow up on successful deliveries.
  • Retrieve contacts filtered by a specific target group to analyze engagement within that segment.
  • Paginate through large contact lists of a campaign to process them in batches.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign whose contacts you want to retrieve.
Filters A collection of optional filters to narrow down the contacts returned:
- Search Search contacts by phone number, contact name, or target group ID.
- Target Filter contacts by their target identifiers, which can be phone numbers or WhatsApp group IDs. Multiple values allowed.
- Kind Filter by the type of target: either "Phone" or "Group". Multiple selections possible.
- Status Filter contacts by delivery status. Options include: Pending, Processing, Delivered, Failed. Multiple selections possible.
- ACK Status Filter contacts by delivery acknowledgment status. Options include: Pending, Sent, Delivered, Read, Failed. Multiple selections possible.
- WhatsApp Message IDs Filter contacts by specific WhatsApp message IDs. Multiple values allowed.
- Results Page Size Number of results to return per page. Defaults to 20.
- Page Number The page number to retrieve, starting from 0. Useful for paginating through large result sets.
- Sort Sort order of the results by date. Options are "Recent First" (date descending) or "Oldest First" (date ascending). Defaults to "Recent First".

Output

The node outputs an array of JSON objects representing the contacts retrieved from the specified campaign. Each object contains details about a contact matching the filter criteria, including but not limited to:

  • Contact identifiers (phone number, group ID)
  • Delivery status and acknowledgment status
  • Associated WhatsApp message IDs
  • Other metadata related to the campaign contact

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the WaliChat WhatsApp API.
  • An API key credential must be configured in n8n to authenticate requests.
  • Proper permissions on the WaliChat account to access campaign and contact data.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will cause the request to fail.
    • Using filters with incorrect formats or unsupported values may result in empty responses or errors.
    • Pagination parameters out of range might return no results.

  • Error messages:

    • Errors related to authentication usually indicate missing or invalid API credentials; verify the API key setup.
    • "Campaign not found" or similar errors suggest the provided Campaign ID does not exist or is inaccessible.
    • Network or timeout errors imply connectivity issues with the WaliChat API endpoint.

To resolve these, ensure the Campaign ID is correct, filters are properly formatted, and API credentials are valid and have sufficient permissions.

Links and References

Discussion