Wassenger icon

Wassenger

Interact with Wassenger WhatsApp API
Join our community

Actions148

Overview

This node interacts with the Wassenger WhatsApp API to retrieve contacts associated with a specific campaign. It allows filtering and sorting of campaign contacts based on various criteria such as phone number, contact name, target group ID, delivery status, and message IDs. This is useful for users who want to analyze or manage contacts involved in WhatsApp campaigns, track message delivery statuses, or paginate through large sets of campaign contacts.

Practical examples:

  • Fetch all contacts from a campaign that have a "delivered" status to verify successful message delivery.
  • Search campaign contacts by phone number or group WhatsApp ID to find specific recipients.
  • Retrieve paginated results sorted by most recent first to display campaign contact lists in a dashboard.

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 kind of target: either "Phone" or "Group".
- Status Filter by delivery status of messages: "Pending", "Processing", "Delivered", or "Failed".
- ACK Status Filter by acknowledgment status of message delivery: "Pending", "Sent", "Delivered", "Read", or "Failed".
- WhatsApp Message IDs Filter contacts by one or more WhatsApp message IDs.
- Results Page Size Number of results to return per page (default 20).
- Page Number The page number to retrieve, starting from 0.
- Sort Sort order of results: "Recent First" (date descending) or "Oldest First" (date ascending).

Output

The node outputs an array of JSON objects representing the campaign contacts matching the specified filters. Each object contains details about a contact within the campaign, including identifiers, delivery status, acknowledgment status, and related metadata.

If binary data were involved (not indicated here), it would typically represent media files or attachments related to contacts or messages, but this operation focuses on JSON data only.

Dependencies

  • Requires an active connection to the Wassenger WhatsApp API via an API key credential configured in n8n.
  • No additional external dependencies are needed beyond the Wassenger API access.
  • Proper permissions on the Wassenger account to read campaign and contact data are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will result in errors or empty results.
    • Incorrect filter values (e.g., invalid status or ACK status options) may cause the API to reject the request.
    • Pagination parameters out of range might lead to no results being returned.
    • Network or authentication failures if the API key is invalid or expired.

  • Error messages:

    • Errors indicating "Campaign not found" suggest the provided Campaign ID does not exist or is inaccessible.
    • Authentication errors indicate problems with the API key credential setup.
    • Validation errors on filters usually mean unsupported filter values were used; check the allowed options carefully.

To resolve these, verify the Campaign ID, ensure correct filter usage, and confirm API credentials are valid and have sufficient permissions.

Links and References

Discussion