WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

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.

Practical scenarios include:

  • Automating the distribution of group invite links in marketing or community management workflows.
  • Integrating WhatsApp group invites into CRM systems or customer support platforms.
  • Managing multiple WhatsApp groups and retrieving their invite links dynamically without manual intervention.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group, formatted as group ID + @g.us (e.g., 120363123456789@g.us). This identifies the target group for which the invite link will be retrieved.

Output

The node outputs JSON data containing the invite link information for the specified WhatsApp group. The exact structure depends on the WSAPI response but typically includes fields such as the invite link URL and possibly metadata about the invite.

If the node supports binary data output (not explicitly shown here), it would represent any media or file content related to the group invite, but for this operation, the output is primarily JSON with invite link details.

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 are indicated beyond the WSAPI service.

Troubleshooting

  • Common Issues:

    • Invalid or incorrectly formatted Group ID (must end with @g.us).
    • Missing or invalid API authentication token.
    • Network connectivity issues to the WSAPI endpoint.
    • The specified group does not exist or the authenticated user lacks permission to access it.
  • Error Messages:

    • "The resource "groups" is not known!" — indicates an internal misconfiguration; ensure the resource parameter is correctly set to "groups".
    • "The operation "getInviteLink" is not implemented yet!" — suggests the operation name might be misspelled or unsupported; verify the operation parameter.
    • API errors returned from WSAPI (e.g., unauthorized, not found) will be passed through; check API credentials and group ID validity.

To resolve these, verify input parameters, ensure valid credentials, and confirm network access to the WSAPI service.

Links and References

Discussion