WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

This node integrates with the WSAPI WhatsApp API to manage WhatsApp groups, specifically allowing you to update group participants. It is useful in scenarios where you need to programmatically add or remove members from a WhatsApp group, such as automating group membership management for customer support teams, community groups, or event coordination.

For example, you can use this node to:

  • Add new participants to an existing WhatsApp group.
  • Remove participants by updating the list of phone numbers.
  • Synchronize group membership based on external data sources.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to update. Format: group ID + @g.us (e.g., 120363123456789@g.us).
Participants Phone numbers of the group participants to set/update, provided as a comma-separated string with country codes (e.g., 1234567890,0987654321).

Output

The node outputs JSON data representing the result of the update operation on the WhatsApp group participants. This typically includes confirmation of the updated participant list or status messages returned by the WSAPI WhatsApp API.

If the operation involves any binary data (not indicated here), it would be included accordingly, but this node primarily deals with JSON responses related to group participant updates.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for the WSAPI must be set in the credentials configuration.

Troubleshooting

  • Invalid Group ID format: Ensure the Group ID follows the required format (groupID@g.us). Incorrect formatting will cause errors.
  • Incorrect phone number format: Phone numbers must include country codes and be comma-separated without spaces.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Check connectivity to the WSAPI endpoint and ensure the base URL is correct.
  • Operation not implemented error: If the node throws an error about the operation not being implemented, verify that the "Update Participants" operation is supported and spelled correctly.

Links and References


If you need further details on other operations or resources, feel free to ask!

Discussion