WAMANAGER

Image Message

Example of an image message on WhatsApp

Image messages are messages that display a single image and an optional caption.

cURL

curl -X POST '<BASE_URL>/api/whatsapp/image' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
  "contacts": [
    "<WHATSAPP_USER_PHONE_NUMBER>"
  ],
  "caption": "Check out this photo!",
  "url": "https://example.com/image.jpg"
}'

Parameters

Parameter	Type	Description	Example
ACCESS_TOKEN	String Required	Whatsapp external api authorization token provided by business account.	ERYHCDIRMWORYFFEXESJDKR6SAZABA
CONTACTS	Array Required	Array of WhatsApp user phone numbers with country code.	["<WHATSAPP_USER_PHONE_NUMBER>"]
MEDIA_URL	Boolean Required	URL of the image media asset hosted on your public server.	https://example.com/image.jpg
MEDIA_CAPTION_TEXT	String Optional	Media asset caption text. Maximum 1024 characters.	Check out this photo!

Supported Image Formats

Images must be 8-bit, in RGB or RGBA color space.

Image Type	Extension	MIME Type	Max Size
JPEG	.jpeg	image/jpeg	5 MB
PNG	.png	image/png	5 MB

Video Message

Example of a video message on WhatsApp

Video messages display a thumbnail preview of a video image with an optional caption. When the WhatsApp user taps the preview, it loads the video and displays it to the user.

cURL

curl -X POST '<BASE_URL>/api/whatsapp/video' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
  "contacts": [
    "<WHATSAPP_USER_PHONE_NUMBER>"
  ],
  "caption": "Check out this video!",
  "url": "https://example.com/video.mp4"
}'

Parameters

Parameter	Type	Description	Example
ACCESS_TOKEN	String Required	Whatsapp external api authorization token provided by business account.	ERYHCDIRMWORYFFEXESJDKR6SAZABA
CONTACTS	Array Required	Array of WhatsApp user phone numbers with country code.	["<WHATSAPP_USER_PHONE_NUMBER>"]
MEDIA_URL	Boolean Required	URL of the video media asset hosted on your public server.	https://example.com/video.mp4
MEDIA_CAPTION_TEXT	String Optional	Media asset caption text. Maximum 1024 characters.	Check out this video!

Supported Video Formats

Only H.264 video codec and AAC audio codec supported. Single audio stream or no audio stream only.

Video Type	Extension	MIME Type	Max Size
MP4 Video	.mp4	video/mp4	16 MB
3GPP	.3gp	video/3gpp	16 MB

Document Message

Example of a document message on WhatsApp

Document messages are messages that display a document icon, linked to a document, that a WhatsApp user can tap to download.

cURL

curl -X POST '<BASE_URL>/api/whatsapp/document' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
  "contacts": [
    "<WHATSAPP_USER_PHONE_NUMBER>"
  ],
  "caption": "Your order confirmation (PDF)",
  "url": "https://example.com/order.pdf",
  "filename": "order.pdf"
}'

Parameters

Parameter	Type	Description	Example
ACCESS_TOKEN	String Required	Whatsapp external api authorization token provided by business account.	ERYHCDIRMWORYFFEXESJDKR6SAZABA
CONTACTS	Array Required	Array of WhatsApp user phone numbers with country code.	["<WHATSAPP_USER_PHONE_NUMBER>"]
MEDIA_URL	Boolean Required	URL of the document media asset hosted on your public server.	https://example.com/order.pdf
MEDIA_FILENAME	String Optional	Media asset file name.	order.pdf
MEDIA_CAPTION_TEXT	String Optional	Media asset caption text. Maximum 1024 characters.	Your order confirmation (PDF)

Supported Document Formats

Document Type	Extension	MIME Type	Max Size
Text	.txt	text/plain	100 MB
Microsoft Excel	.xls	application/vnd.ms-excel	100 MB
Microsoft Excel	.xlsx	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet	100 MB
Microsoft Word	.doc	application/msword	100 MB
Microsoft Word	.docx	application/vnd.openxmlformats-officedocument.wordprocessingml.document	100 MB
Microsoft PowerPoint	.ppt	application/vnd.ms-powerpoint	100 MB
Microsoft PowerPoint	.pptx	application/vnd.openxmlformats-officedocument.presentationml.presentation	100 MB
PDF	.pdf	application/pdf	100 MB

Audio Message

Example of an audio message on WhatsApp

Audio Messages are used to share voice notes or sound files (MP3, OGG, etc.).

cURL

curl -X POST '<BASE_URL>/api/whatsapp/audio' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
  "contacts": [
    "<WHATSAPP_USER_PHONE_NUMBER>"
  ],
  "url": "https://example.com/audio.mp3"
}'

Parameters

Parameter	Type	Description	Example
ACCESS_TOKEN	String Required	Whatsapp external api authorization token provided by business account.	ERYHCDIRMWORYFFEXESJDKR6SAZABA
CONTACTS	Array Required	Array of WhatsApp user phone numbers with country code.	["<WHATSAPP_USER_PHONE_NUMBER>"]
MEDIA_URL	Boolean Required	URL of the audio media asset hosted on your public server.	https://example.com/audio.mp3

Supported Audio Formats

Audio Type	Extension	MIME Type	Max Size
AAC	.aac	audio/aac	16 MB
AMR	.amr	audio/amr	16 MB
MP3	.mp3	audio/mpeg	16 MB
MP4 Audio	.m4a	audio/mp4	16 MB
OGG Audio	.ogg	audio/ogg (OPUS codecs only; base audio/ogg not supported; mono input only)	16 MB

Sticker Message

Example of a sticker message on WhatsApp

Sticker Messages let you send WebP sticker files.

cURL

curl -X POST '<BASE_URL>/api/whatsapp/sticker' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
  "contacts": [
    "<WHATSAPP_USER_PHONE_NUMBER>"
  ],
  "url": "https://example.com/sticker.webp"
}'

Parameters

Parameter	Type	Description	Example
ACCESS_TOKEN	String Required	Whatsapp external api authorization token provided by business account.	ERYHCDIRMWORYFFEXESJDKR6SAZABA
CONTACTS	Array Required	Array of WhatsApp user phone numbers with country code.	["<WHATSAPP_USER_PHONE_NUMBER>"]
MEDIA_URL	Boolean Required	URL of the sticker media asset hosted on your public server.	https://example.com/sticker.webp

Supported Sticker Formats

Sticker Type	Extension	MIME Type	Max Size
Animated sticker	.webp	image/webp	500 KB
Static sticker	.webp	image/webp	100 KB