WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation sends a GIF or video message via the WARest WhatsApp REST API. It supports sending GIFs/videos either by providing a URL/path/data URI or by using binary data from a specified binary property. Additional options include adding a caption and compressing the media before sending. This node is useful for automating the sending of animated media content in WhatsApp chats, such as promotional GIFs, reaction videos, or animated stickers.

Use Case Examples

  1. Sending a promotional GIF to a customer chat by specifying the session, recipient, and GIF URL.
  2. Sending a GIF stored in binary form within the workflow to a group chat with an optional caption.

Properties

Name Meaning
Session Identifier of the WhatsApp session to use for sending the GIF. Can be selected from a list or entered manually.
Recipient / Chat (to) Phone number or JID of the recipient or chat to send the GIF to. Can be a comma-separated list.
Binary File Boolean flag to enable sending the GIF from a binary property instead of a URL or path.
GIF/Video URL, local path, or data URI of the GIF/video to send. Required if not using binary mode.
GIF/Video Binary Property Name of the binary property containing the GIF/video data when binary mode is enabled.
Caption Optional caption text to include with the GIF message.
Compress Media Boolean flag to enable compression of the GIF before sending.

Output

JSON

  • json - The JSON response from the WARest API containing details about the sent GIF 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 the binary property name is correct and contains valid GIF data.
  • The recipient field must be a valid phone number or JID; invalid formats will cause errors.
  • If compressing media, large files might take longer to process or fail if exceeding size limits.

Links

Discussion