WSAPI Message

Send and manage WhatsApp messages via WSAPI

Overview

This node enables sending WhatsApp messages using the WSAPI service, specifically focusing on the Send Sticker operation within the Message resource. It allows users to send stickers to individual contacts or groups on WhatsApp by specifying either a URL or Base64-encoded sticker data. The node supports additional options such as marking the sticker as animated and including advanced message options like mentions, replying to specific messages, or marking the message as forwarded.

Common scenarios:

  • Sending custom or branded stickers to customers in automated WhatsApp campaigns.
  • Sharing fun or expressive content in group chats or customer support conversations.
  • Automating sticker replies based on user interactions or triggers.

Practical example:

  • A marketing automation workflow sends a promotional sticker to a list of customers after they complete a purchase.
  • A chatbot sends an animated sticker as a reaction to certain keywords detected in user messages.

Properties

Name Meaning
Recipient WhatsApp ID of the recipient (phone number with @s.whatsapp.net for contacts, or group ID with @g.us for groups).
Sticker Source Source type of the sticker to send. Options: URL, Base64.
Sticker URL URL of the sticker image (required if Sticker Source is URL).
Sticker Base64 Base64 encoded sticker data (required if Sticker Source is Base64).
MIME Type MIME type of the sticker. Only option available: image/webp.
Is Animated Boolean flag indicating whether the sticker is animated (true or false).
Advanced Options Collection of optional advanced settings:
- Mentions Comma-separated list of WhatsApp IDs to mention in the message. These can be referenced in text as @1234567890@s.whatsapp.net.
- Reply To Message ID ID of the message this sticker is replying to.
- Is Forwarded Boolean flag to mark the message as forwarded.

Output

The node outputs JSON data representing the response from the WSAPI service after sending the sticker message. This typically includes metadata about the sent message such as message ID, status, timestamps, and any server acknowledgments.

No binary data output is produced by this operation.


Dependencies

  • Requires connection to the WSAPI WhatsApp messaging service.
  • Needs an API key credential and instance ID configured in n8n credentials for authentication.
  • The node makes HTTP POST requests to the WSAPI endpoint /messages/sticker.

Troubleshooting

  • Invalid recipient format: Ensure the recipient WhatsApp ID is correctly formatted with @s.whatsapp.net for individual contacts or @g.us for groups.
  • Missing required fields: If the sticker source is URL, the Sticker URL must be provided; if Base64, the Sticker Base64 data must be supplied.
  • Authentication errors: Verify that the API key and instance ID credentials are correctly set up and valid.
  • Unsupported MIME type: Only image/webp is supported for stickers; other types will cause errors.
  • Network issues: Check connectivity to the WSAPI service endpoint.
  • Advanced options misuse: Mentions should be valid WhatsApp IDs separated by commas; invalid IDs may cause message delivery failures.

If the node throws errors related to these points, review the input parameters and credentials accordingly.


Links and References


Note: Internal credential names and exact API details are abstracted for security and clarity.

Discussion