WhatsApp GatewayInstall

Summary

Send a media file to a specified WhatsApp recipient by providing a public URL. The gateway downloads the media from this URL and sends it through the designated WhatsApp session.

Inputs

• Session (Name or ID) (required) — The WhatsApp session name or ID to send the media from.
• To (required) — The recipient's phone number including country and area code (e.g., DDI+DDD+number) or full JID.
• Media URL (required) — Public URL of the media file to send; the gateway will download this file to send it.
• Additional Fields — Optional parameters for the media such as caption, file name, mimetype, and media type (audio, document, image, sticker, or video).
• Cold (First Contact) — Boolean flag indicating if this message is a first permissioned contact (cold). This must be false for AI/agent replies.
• Idempotency Key — Optional strong deduplication key to avoid resending the same media on retries.
• Continue on Quarantine — If true, handles HTTP 423 (quarantined session) by returning a blocked reason instead of erroring, enabling conditional workflow branching and retries.

Output shape

a single record representing the send operation result.

If 'Continue on Quarantine' is enabled, the node returns a JSON object with 'blocked' and 'reason' properties on a quarantined session instead of throwing an error. Other HTTP errors will fail the node execution.

Examples

Example 1: Send a PDF document

Set 'Session' to the WhatsApp session name, 'To' with recipient's phone number, 'Media URL' with the public link to the PDF, and optionally specify 'File Name' and 'Mimetype' in Additional Fields.

Links

• n8n community nodes installation guide