Skip to main content

Sending a WhatsApp Message

Send rich WhatsApp content to your users with automatic fallback to SMS when WhatsApp is not available.
WhatsApp messages require the recipient to have WhatsApp installed and active. If WhatsApp is not available, you can configure automatic fallback to SMS.
You can also send a simple WhatsApp message without attachments:

Typing Indicators

Show typing indicators to create a more interactive messaging experience. Start typing indicator:
Stop typing indicator:

Reactions

Parameters

whatsapp.send(params)

string
required
The recipient’s phone number in E.164 format (e.g., “+1234567890”).
string
required
The message content to send via WhatsApp.
string
Optional leased phone number to use as the sender. Must be a number you have leased from Contiguity.
object
Fallback configuration for when WhatsApp is not available.
string[]
Array of attachment URLs to include with the message. Supports images and other media.

Response

string
Unique identifier for the sent WhatsApp message, used for tracking delivery status.
object
Request metadata including ID, timestamp, and API version.

whatsapp.typing(params)

string
required
The recipient’s phone number in E.164 format (e.g., “+1234567890”).
string
required
The typing indicator action. Options: "start" to show typing, "stop" to hide typing.
string
Optional leased phone number to use as the sender.

whatsapp.react(action, params)

string
required
"add" or "remove".
string
required
Emoji string (e.g. "👍").
string
Message ID, or use to + from + message.

Response (send / react)

string
Message ID (send/react).
object
Request metadata: id, timestamp, api_version, object.