WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation retrieves detailed information about a specific WhatsApp group using the WARest WhatsApp REST API. It is useful for scenarios where you need to fetch metadata or status about a group, such as its name, description, participants, or settings. For example, it can be used to monitor group details in a customer support chat or community management context.

Use Case Examples

  1. Fetch group info by providing the session ID and the group's unique identifier (Group ID).
  2. Use the retrieved group info to display group metadata in a dashboard or trigger workflows based on group attributes.

Properties

Name Meaning
Session The WhatsApp session identifier to use for the API call. It can be selected from a list of active sessions or entered manually.
Group ID The unique identifier of the WhatsApp group to retrieve information for. This is typically the group's JID ending with @g.us or the raw group ID.

Output

JSON

  • json - The detailed information about the WhatsApp group returned by the API, including metadata such as group name, description, participants, and settings.

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 provided is valid and active; otherwise, the API call will fail.
  • Verify the Group ID is correctly formatted as a JID ending with @g.us or as a raw group ID.
  • Check that the API credentials (API key and base URL) are correctly configured and have the necessary permissions to access group information.
  • Common error messages may include 'Operation not implemented' if the operation name is incorrect, or authentication errors if credentials are invalid.

Discussion