WSAPI icon

WSAPI

Interact with WSAPI WhatsApp API

Overview

This node enables sending a sticker message via WhatsApp using the WSAPI WhatsApp API. It is designed to send stickers to individual contacts or groups by specifying their WhatsApp IDs. This operation is useful in scenarios where automated workflows need to send visual, expressive content (stickers) as part of customer engagement, notifications, or chatbots.

Practical examples:

  • Sending a welcome sticker automatically when a new user joins a group.
  • Responding with a specific sticker based on user input in a chatbot.
  • Broadcasting promotional stickers to a list of contacts.

Properties

Name Meaning
To The recipient's WhatsApp ID. For individual 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).
Media URL The publicly accessible HTTP or HTTPS URL of the sticker media file to send. Must be a direct link to the sticker image file.
Advanced Options Additional optional settings:
- Mentions: Comma-separated phone numbers (without @) to mention in the message.
- Reply To Message ID: ID of a message to reply to.
- Is Forwarded: Whether the message is forwarded.
- View Once: Whether the media should disappear after being viewed (only for images and videos, not applicable here).

Output

The node outputs JSON data representing the result of the send sticker operation. This typically includes metadata about the sent message such as message ID, status, timestamps, and any relevant response from the WhatsApp API confirming successful delivery or errors.

If the node supports binary data output (not explicitly shown here), it would represent media content or attachments related to the message, but for sending stickers, the primary output is JSON metadata.

Dependencies

  • Requires an active connection to the WSAPI WhatsApp API service.
  • Needs an API key credential configured in n8n for authentication with the WSAPI endpoint.
  • The "Media URL" must point to a publicly accessible HTTP/HTTPS location hosting the sticker file.
  • Proper formatting of WhatsApp contact or group IDs is necessary.

Troubleshooting

  • Invalid Recipient ID: If the "To" field is incorrectly formatted (missing country code, wrong suffix), the API will reject the request. Ensure the format matches number@s.whatsapp.net for contacts or groupid@g.us for groups.
  • Media URL Issues: The sticker URL must be directly accessible without authentication and in a supported format. Broken links or unsupported formats will cause failures.
  • Permission Errors: Missing or invalid API credentials will prevent sending messages. Verify that the API key is correctly set up in n8n credentials.
  • Message Reply Failures: If "Reply To Message ID" does not exist or is invalid, the API may return an error.
  • Forwarded Flag Misuse: Setting "Is Forwarded" incorrectly might affect message handling; use only if forwarding is intended.
  • View Once Option: Although available in advanced options, it does not apply to stickers and will be ignored.

Links and References

Discussion