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 Link" operation retrieves the invite link for a specified WhatsApp group. This is useful when you want to programmatically obtain the invitation URL that can be shared with others to join a particular WhatsApp group.

Common scenarios:

  • Automating the distribution of group invite links via other communication channels.
  • Managing multiple WhatsApp groups and retrieving their invite links dynamically.
  • Integrating WhatsApp group management into broader workflows or CRMs.

Example:
You have a marketing automation workflow where new customers are added to a WhatsApp group. Using this node's "Get Invite Link" operation, you can fetch the invite link and send it automatically via email or SMS.

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 link to retrieve.

Output

The output JSON contains the data returned by the WSAPI WhatsApp API for the invite link request. Typically, this includes the invite link URL and possibly metadata about the group or the invite status.

If the node supports binary data output (not explicitly shown here), it would represent any media or files associated with the response, but for this operation, the main output is JSON containing the invite link information.

Dependencies

  • Requires an API key credential for authenticating with the WSAPI WhatsApp API.
  • The node expects the base URL of the WSAPI service to be configured in the credentials.
  • No additional external dependencies beyond the WSAPI service and its authentication.

Troubleshooting

  • Invalid Group ID format: Ensure the Group ID is correctly formatted as groupID@g.us. An incorrect format will likely cause the API call to fail.
  • Authentication errors: Verify that the API key credential is valid and has the necessary permissions to access group information.
  • Group not found or no invite link available: The group may not exist or the user/account may not have permission to retrieve the invite link. Check group membership and permissions.
  • Network or API errors: Confirm that the WSAPI base URL is reachable and the service is operational.

Common error messages might include:

  • "The resource 'groups' is not known!" — indicates a misconfiguration of the resource parameter.
  • "The operation 'getInviteLink' is not implemented yet!" — suggests the operation name is misspelled or unsupported.
  • API response errors indicating invalid credentials or insufficient permissions.

Resolving these typically involves verifying input parameters, credentials, and network connectivity.

Links and References

Discussion