WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to retrieve information about a WhatsApp group invite. Specifically, the "Get Invite Info" operation under the "Group" resource allows users to input a WhatsApp group invite code and fetch details related to that invite.

Common scenarios where this node is beneficial include:

  • Validating or previewing WhatsApp group invites before joining or sharing.
  • Automating workflows that require fetching metadata about WhatsApp groups via their invite codes.
  • Integrating WhatsApp group invite info retrieval into broader communication or CRM systems.

For example, a user can extract the invite code from a WhatsApp group link (the part after https://chat.whatsapp.com/), provide it as input, and get back structured information about that group invite such as group name, description, or other metadata exposed by the API.

Properties

Name Meaning
Invite Code The WhatsApp group invite code to get information about. Extract this code from the invite link URL (the part after https://chat.whatsapp.com/). Example: AbCdEfGhIjKlMnOpQrStUvWxYz. This property is required.

Output

The node outputs JSON data containing the information retrieved about the WhatsApp group invite corresponding to the provided invite code. The exact structure depends on the WSAPI response but typically includes details such as:

  • Group name
  • Description
  • Invite expiration or validity status
  • Number of participants or other metadata

If the API supports binary data for this operation (not indicated in the source), it would be summarized accordingly; however, based on the static analysis, the output is JSON only.

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 is taken from the credential configuration.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Invalid Invite Code: If the invite code is incorrect or malformed, the API may return an error or empty result. Ensure the invite code is correctly extracted from the WhatsApp invite link.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is properly set up in n8n.
  • Network Issues: Connectivity problems to the WSAPI endpoint can cause request failures. Check network access and the base URL configuration.
  • Operation Not Implemented: If the node throws an error indicating the operation is not implemented, ensure you are using the latest version of the node and that the "Get Invite Info" operation is supported.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

Discussion