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 "Delete Group" operation allows users to delete a WhatsApp group by providing its unique group identifier.

Common scenarios where this node is beneficial include:

  • Automating group management tasks such as removing obsolete or inactive groups.
  • Integrating WhatsApp group deletion into larger workflows, for example, cleaning up groups after an event ends.
  • Managing group lifecycle programmatically without manual intervention in the WhatsApp client.

Practical example:

  • A marketing automation workflow that creates temporary WhatsApp groups for campaigns and deletes them automatically once the campaign finishes.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to delete. Format: <group ID>@g.us (e.g., 120363123456789@g.us). This is required to specify which group to delete.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the group was successfully deleted or provide error information if the deletion failed.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is expected to be purely JSON-based.

Dependencies

  • Requires an API key credential for authenticating with the WSAPI WhatsApp API.
  • The base URL for the API must be configured in the node credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Providing an invalid or incorrectly formatted Group ID (must end with @g.us).
    • Attempting to delete a group that does not exist or to which the authenticated user has no access.
    • Network or authentication errors due to incorrect API credentials or base URL configuration.
  • Error messages:

    • "The resource "groups" is not known!" — indicates an invalid resource selection; ensure "Group" resource is selected.
    • "The operation "delete" is not implemented yet!" — would indicate missing implementation, but this should not occur here as delete is supported.
    • Errors returned from the API will be passed through; check the message for details like permission denied or group not found.
  • Resolutions:

    • Verify the Group ID format and correctness.
    • Confirm API credentials and base URL are correctly set.
    • Ensure the authenticated user has permissions to delete the specified group.

Links and References

Discussion