WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to perform various messaging-related operations. Specifically, the "Mark as Read" operation under the Message resource marks a specified WhatsApp message thread (contact or group) as read. This is useful in automation workflows where you want to programmatically acknowledge messages without manual intervention.

Common scenarios:

  • Automatically marking incoming messages as read after processing them.
  • Managing message states in customer support automation.
  • Synchronizing message read status between systems.

Example:
You receive messages from customers via WhatsApp and want to mark them as read once your workflow has logged or responded to them, ensuring no duplicate handling.

Properties

Name Meaning
To The WhatsApp contact ID or group ID whose messages should be marked as read. For contacts, this is the phone number followed by @s.whatsapp.net (e.g., 1234567890@s.whatsapp.net). For groups, it is the group ID followed by @g.us (e.g., 120363123456789@g.us). The phone number must include the country code but exclude the plus sign.

Output

The node outputs JSON data representing the result of the "Mark as Read" operation. Typically, this will confirm whether the action was successful or provide details about the updated message state.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Invalid "To" format: Ensure the contact or group ID is correctly formatted with the country code and domain suffix (@s.whatsapp.net for contacts, @g.us for groups).
  • Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
  • Network issues: Confirm that the base URL is reachable and the WSAPI service is operational.
  • Operation not implemented error: If the node throws an error indicating the operation is not implemented, ensure you have selected the correct resource and operation combination.

Links and References

Discussion