WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation lists the participants of a specified WhatsApp group using the WARest WhatsApp REST API. It is useful for scenarios where you need to retrieve and manage the members of a WhatsApp group, such as for monitoring group membership, automating group management tasks, or integrating group participant data into other workflows.

Use Case Examples

  1. Retrieve the list of participants in a customer support group to analyze active members.
  2. Fetch group participants to automate sending targeted messages or notifications to group members.

Properties

Name Meaning
Session Identifier of the WhatsApp session to use for the API call. It can be selected from a list of available sessions or entered manually.
Group ID The unique identifier (JID) of the WhatsApp group whose participants are to be listed. It typically ends with '@g.us' or can be a raw ID.

Output

JSON

  • json - Array of group participant objects returned by the API, each representing a participant's details.

Dependencies

  • Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

  • Ensure the session ID is valid and active; invalid or expired sessions will cause errors.
  • Verify the group ID is correct and corresponds to an existing WhatsApp group.
  • Check API credentials and base URL configuration to avoid authentication or connection errors.
  • If the API returns an error, inspect the error message for details such as permission issues or rate limits.

Links

Discussion