WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to perform various operations related to WhatsApp groups. Specifically, the "Get Group" operation retrieves detailed information about a particular WhatsApp group using its unique identifier.

Common scenarios where this node is beneficial include:

  • Fetching metadata or details of a WhatsApp group for monitoring or reporting.
  • Integrating WhatsApp group data into other systems or workflows.
  • Automating management tasks by retrieving current group information before performing updates.

For example, you might use this node to get the name, description, participants, and other attributes of a WhatsApp group identified by its group ID.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group in the format groupID@g.us (e.g., 120363123456789@g.us). This is required to specify which group to retrieve information about.

Output

The output JSON contains the detailed information of the requested WhatsApp group. This typically includes fields such as:

  • Group ID
  • Group name
  • Description
  • List of participants
  • Group creation date
  • Other metadata related to the group

If the node supports binary data output (not explicitly shown here), it would represent media or files associated with the group, but for the "Get Group" operation, the output is primarily structured JSON data describing the group.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API key credential configured in n8n to authenticate requests to the WSAPI endpoint.
  • The base URL for the WSAPI must be set in the credentials configuration.

Troubleshooting

  • Invalid Group ID Format: Ensure the Group ID follows the correct format (<groupID>@g.us). An incorrect format will likely cause the API to return an error.
  • Group Not Found: If the specified group does not exist or the bot/user does not have access, the node may throw an error indicating the group could not be found.
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems to the WSAPI endpoint can cause timeouts or failures; check network settings and endpoint availability.
  • Unhandled Operation Error: If the operation is not implemented or recognized, the node will throw an error stating so.

Links and References

Discussion