WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to perform various operations related to WhatsApp groups. Specifically, the Get Invite Requests operation retrieves the list of pending invite requests for a specified WhatsApp group. This is useful for administrators or bots managing group membership, allowing them to see who has requested to join a group before approving or rejecting those requests.

Practical examples:

  • Automatically fetching and processing pending invite requests to notify group admins.
  • Integrating with other systems to log or audit group join requests.
  • Building custom workflows that approve or reject invite requests based on external criteria.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group in the format groupID@g.us (e.g., 120363123456789@g.us). This specifies which group's invite requests to retrieve.

Output

The node outputs JSON data representing the invite requests for the specified group. Each item in the output array corresponds to an individual invite request, typically including details such as the requester’s contact information and the status of their request.

If the node supports binary data output (not indicated here), it would represent media or files associated with the invite requests, but this operation primarily returns structured JSON data.

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

  • Common issues:

    • Invalid or missing Group ID format: Ensure the Group ID includes the suffix @g.us.
    • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network or connectivity problems: Confirm that the WSAPI base URL is reachable from the n8n environment.

  • Error messages:

    • "The resource "groups" is not known!": Indicates the resource parameter was incorrect or unsupported.
    • "The operation "getInviteRequests" is not implemented yet!": Suggests the operation name might be misspelled or not available in the current version.
    • API response errors will typically include HTTP status codes and messages; check the WSAPI documentation for specific meanings.

Links and References

Discussion