WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

Chats → Get Group Participants

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API to retrieve participants of a WhatsApp group chat. It is useful for scenarios where you need to manage or analyze group membership, such as identifying admins, filtering participants by contact status, or paginating through large groups.

Practical examples include:

  • Fetching all admins in a specific WhatsApp group to send targeted messages.
  • Filtering group participants who are saved contacts in your WhatsApp agenda.
  • Paginating through group members when dealing with very large groups.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which to fetch the group participants. This identifies the WhatsApp account used for the operation.
Chat ID The unique identifier of the chat group (e.g., 44736205357600000000@g.us for a group). Specifies which group’s participants to retrieve.
Filters Collection of filters to narrow down the participant list:
- Search Text to search participants by name, phone number, or WhatsApp ID.
- Phone Numbers Filter participants by one or more phone numbers.
- Role Filter participants by their role in the group. Options: Admin, Owner, Participant.
- Only Contacts Boolean flag to filter only participants that are saved contacts in the WhatsApp agenda.
- Include Contact Info Optionally include detailed contact information for each participant if available.
- Results Page Size Maximum number of results to return per page (pagination size).
- Page Number Page number to retrieve, starting from 0 (for pagination).

Output

The output is an array of JSON objects representing the filtered group participants. Each participant object typically includes:

  • Participant identifiers (such as WhatsApp ID and phone number).
  • Role within the group (admin, owner, participant).
  • Contact information if requested and available (e.g., name, profile details).

If the "Include Contact Info" option is selected, additional contact details are included in each participant's data.

No binary data output is indicated for this operation.

Dependencies

  • Requires a valid API key credential for authenticating with the WaliChat WhatsApp API.
  • The node depends on the WaliChat API service being accessible.
  • The "WhatsApp Number" property must correspond to a configured and active WhatsApp device/account in WaliChat.
  • Pagination parameters require correct handling to navigate through large participant lists.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp Number (device) ID will cause failures in fetching participants.
    • Incorrect Chat ID format or non-existent group ID will result in errors or empty results.
    • Overly restrictive filters may return no participants.
    • Pagination parameters out of range may cause empty pages or errors.
  • Error messages:

    • Errors related to authentication usually indicate missing or invalid API credentials.
    • "Chat not found" or similar errors suggest incorrect Chat ID.
    • Network or API downtime errors require checking WaliChat service status.
  • Resolutions:

    • Verify the WhatsApp Number is correctly set and active.
    • Confirm the Chat ID corresponds to an existing group.
    • Adjust filters to be less restrictive if no results are returned.
    • Ensure API credentials are valid and have necessary permissions.

Links and References

  • WaliChat API Documentation (example placeholder, replace with actual URL if known)
  • WhatsApp Group Chat IDs format explanation: phoneNumber@g.us indicates a group chat.
  • n8n documentation on pagination and filtering best practices.

Discussion