Wassenger icon

Wassenger

Interact with Wassenger WhatsApp API
Join our community

Actions148

Overview

This node interacts with the Wassenger WhatsApp API to retrieve chat contacts associated with a specified WhatsApp number. It is useful for scenarios where you need to fetch and filter contact lists from a WhatsApp device, such as managing customer contacts, segmenting users by type or labels, or integrating WhatsApp contact data into other workflows.

Practical examples include:

  • Fetching all business contacts from a specific WhatsApp number.
  • Searching contacts by name or email.
  • Filtering contacts created or updated within a certain date range.
  • Retrieving contacts with specific metadata or labels for targeted messaging campaigns.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which to retrieve contacts.
Filters A collection of optional filters to narrow down the contacts list:
- Search Search contacts by name, phone, email, etc.
- Contact Type Filter contacts by type: Personal, Business, User (both personal and business), Group, Channel, Private.
- Has Filter contacts that have Email, Chat, or both.
- Has Chat Deprecated boolean filter for contacts with or without a WhatsApp chat (use "Has" instead).
- Country Filter contacts by country codes (e.g., US, GB, IN). Includes an extensive list of countries.
- Labels Filter contacts by chat labels. Use * to include any labeled chat.
- Exclude Labels Exclude contacts with specific labels. Use * to exclude any labeled chat.
- Include Items Include related entities in the response, e.g., "Chat".
- Metadata Key Filter contacts with specific metadata keys.
- Metadata Value Filter contacts with specific metadata values.
- Created After Filter contacts created after this date/time.
- Created Before Filter contacts created before this date/time.
- Updated After Filter contacts updated after this date/time.
- Updated Before Filter contacts updated before this date/time.
- Last Message After Filter contacts with last message after this date/time.
- Last Message Before Filter contacts with last message before this date/time.
- Results Page Size Number of results per page (pagination). Default is 20.
- Page Number Page number for pagination (starting from 0).
- Sort Sort order for results. Options include: Name A-Z, Name Z-A, Recently Created, Oldest Created, Recently Updated, Oldest Updated.

Output

The node outputs a JSON array of contact objects matching the specified filters. Each contact object typically contains details such as contact name, phone number, type (personal, business, group, etc.), labels, metadata, creation and update timestamps, and possibly related chat information if requested.

If the "Include Items" property includes "Chat", the output will also contain related chat entities linked to each contact.

The node does not output binary data.

Dependencies

  • Requires an active connection to the Wassenger WhatsApp API.
  • Needs an API key credential configured in n8n for authentication with the Wassenger service.
  • The node depends on the availability of the WhatsApp number (device) configured in Wassenger.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp number ID: Ensure the device ID is correct and accessible.
    • API authentication errors: Verify the API key credential is valid and has necessary permissions.
    • No contacts returned: Check filter criteria; overly restrictive filters may yield no results.
    • Pagination misconfiguration: Ensure page number and size are set correctly to navigate through results.

  • Error messages:

    • Authentication failures usually indicate invalid API credentials.
    • "Resource not found" or similar errors may mean the WhatsApp number/device does not exist or is inactive.
    • Rate limiting errors from the API require waiting or adjusting request frequency.

Links and References

Discussion