WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API
Join our community

Actions50

Overview

This node interacts with the WSAPI WhatsApp API to manage WhatsApp chats programmatically. Specifically, the Archive Chat operation allows users to move a chat either into the archived folder or restore it back to the main chat list. This is useful for organizing conversations by hiding less active or completed chats without deleting them.

Common scenarios:

  • Automatically archiving chats after a conversation ends to keep the main chat list clean.
  • Restoring archived chats when new messages arrive or when the user wants to revisit a conversation.
  • Managing chat visibility in bulk workflows, such as customer support ticketing systems or sales pipelines.

Practical example:

  • A customer support workflow that archives chats once a ticket is resolved.
  • A personal automation that archives group chats during weekends and restores them on weekdays.

Properties

Name Meaning
Chat ID The unique identifier of the WhatsApp chat. For individual contacts, this is the phone number plus @s.whatsapp.net. For groups, it is the group ID plus @g.us. Example: 1234567890@s.whatsapp.net or 120363123456789@g.us.
Archived Boolean flag indicating whether to archive (true) or restore (false) the chat from the archive folder.

Output

The node outputs JSON data representing the result of the archive/unarchive action on the specified chat. The exact structure depends on the WSAPI response but typically includes confirmation of the chat's updated archived status.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or incorrectly formatted Chat ID (e.g., missing @s.whatsapp.net or @g.us suffix).
    • Insufficient permissions or invalid API key leading to authentication errors.
    • Network connectivity issues preventing access to the WSAPI endpoint.

  • Error messages:

    • "The resource "chat" is not known!" — indicates a misconfiguration of the resource parameter; ensure "Chat" is selected.
    • "The operation "archiveChat" is not implemented yet!" — suggests the operation name might be misspelled or unsupported; verify operation selection.
    • API errors returned from WSAPI will typically include descriptive messages; check the error details for guidance.

  • Resolutions:

    • Verify the Chat ID format matches WhatsApp requirements.
    • Confirm API credentials are valid and have necessary permissions.
    • Check network settings and WSAPI service availability.

Links and References

Discussion