WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node integrates with the WSAPI WhatsApp API, enabling automation and interaction with WhatsApp chats. Specifically, the "Mark as Read" operation for the "Chat" resource allows users to mark a particular WhatsApp chat as read programmatically. This is useful in scenarios where you want to automate message management workflows, such as acknowledging messages automatically after processing them or syncing read status across systems.

Practical examples include:

  • Automatically marking customer support chats as read once a ticket is created.
  • Syncing read status from an external CRM system back to WhatsApp.
  • Automating chat cleanup processes by marking old chats as read.

Properties

Name Meaning
Chat ID The unique identifier of the WhatsApp chat to mark as read. For individual contacts, this is the phone number plus @s.whatsapp.net. For groups, it is the group ID plus @g.us. Examples: 1234567890@s.whatsapp.net (individual), 120363123456789@g.us (group).

Output

The node outputs JSON data representing the result of the "Mark as Read" operation. Typically, this will confirm whether the chat was successfully marked as read or provide error details if the operation failed.

If the node supports binary data output (not indicated here), it would represent any media or files returned by the API, but for this operation, the output is purely JSON confirming the action's success or failure.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or incorrectly formatted Chat ID: Ensure the chat identifier matches the expected format (phone@s.whatsapp.net for individuals, groupID@g.us for groups).
    • Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
    • Network or connectivity problems: Confirm that the base URL is reachable and correct.

  • Error messages:

    • "The resource "chat" is not known!": Indicates an invalid resource selection; ensure "Chat" is selected.
    • "The operation "markChatAsRead" is not implemented yet!": Suggests the operation name might be misspelled or unsupported; verify the operation parameter.
    • API response errors typically include descriptive messages; check the error message returned in the output JSON for guidance.

Links and References

Discussion