WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

The node provides integration with the WSAPI WhatsApp API, enabling various operations on WhatsApp resources such as chats, messages, contacts, groups, and more. Specifically, for the Chat resource and the Mute Chat operation, this node allows users to enable or disable notifications for a particular WhatsApp chat.

This is useful in scenarios where you want to programmatically control notification settings for individual or group chats, for example:

  • Automatically muting promotional or support group chats during certain hours.
  • Unmuting important chats when a user becomes available.
  • Managing notification preferences at scale for multiple chats via automation workflows.

Properties

Name Meaning
Chat ID The unique identifier of the WhatsApp chat. For individual contacts, it is the phone number followed by @s.whatsapp.net. For groups, it is the group ID followed by @g.us. Example: 1234567890@s.whatsapp.net (individual) or 120363123456789@g.us (group).
Muted Boolean flag to enable or disable chat notifications. true mutes notifications for the chat; false enables them.

Output

The node outputs JSON data representing the result of the mute/unmute operation on the specified chat. The exact structure depends on the WSAPI response but typically includes confirmation of the action taken or details about the chat's updated state.

No binary data output is indicated for this operation.

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 must be set in the credentials configuration.

Troubleshooting

  • Invalid Chat ID: If the chat ID format is incorrect or does not exist, the API may return an error. Ensure the chat ID matches the expected pattern (phone@s.whatsapp.net for individuals, groupid@g.us for groups).
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly set up.
  • Permission Issues: The WSAPI account used must have permission to modify chat settings. Lack of permissions can lead to errors.
  • Network Issues: Connectivity problems between n8n and the WSAPI endpoint can cause timeouts or request failures.
  • Operation Not Implemented: If the node throws an error indicating the operation is not implemented, ensure you are using a compatible version of the node and WSAPI.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions.

Discussion