WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation sends a sticker message via the WARest WhatsApp REST API. It allows users to send a sticker to a specified recipient or chat by providing a session ID and the sticker content, which can be supplied either as a URL/path/data URI or as binary data. Additional options include compressing the media and setting message-related fields such as replying to a message or marking the message as forwarded. This node is useful for automating sticker sending in WhatsApp conversations, for example, in customer support or marketing scenarios.

Use Case Examples

  1. Sending a sticker to a customer chat by specifying the session and recipient phone number, using a sticker URL.
  2. Sending a sticker from binary data stored in the workflow, enabling dynamic sticker content based on workflow logic.

Properties

Name Meaning
Session Identifier of the WhatsApp session to use for sending the sticker. Can be selected from a list or entered manually.
Recipient / Chat (to) Phone number or JID of the recipient chat where the sticker will be sent. Can be a comma-separated list.
Binary File Boolean flag to enable sending the sticker from a binary property instead of a URL or path.
Sticker URL, path, or data URI of the sticker image or GIF to send. Required if not using binary mode.
Sticker Binary Property Name of the binary property containing the sticker data when binary mode is enabled.
Compress Media Boolean flag to enable compression of the sticker media before sending.
Additional Fields Optional additional message fields such as presence indicator (typing/recording), reply to a specific message ID, and marking the message as forwarded.

Output

JSON

  • json - The JSON response from the WARest API after sending the sticker message, containing details about the sent message.

Dependencies

  • Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

  • Ensure the session ID is valid and active; otherwise, the API call will fail.
  • If using binary mode, verify that the specified binary property exists and contains valid image data.
  • The recipient field must be a valid phone number or JID; invalid formats will cause errors.
  • If compress media is enabled, large stickers might be compressed, which could affect quality.
  • Common error messages include missing required parameters (sessionId, to, sticker) or invalid session state. Verify all required inputs are provided and correct.

Discussion