Send every message type
Template, text, media, sticker, location, contacts, interactive and reaction messages all go
through one endpoint, with the same body as the WhatsApp Cloud API:
POST /v1/{phone_number_id}/messages.
Hello WhatsApp API documentation
Send WhatsApp Business messages from your own systems. One API key, one endpoint for every message type, delivery status you can poll.
What you can do with the Integration API
Section titled “What you can do with the Integration API”Track delivery
Every send returns a message id. Poll GET /v1/messages/{id} to follow it from queued
through sent, delivered and read.
Manage templates
List, create, edit, sync and bulk-create the WhatsApp message templates your business uses to start conversations, scoped by WhatsApp Business Account.
Upload media
Upload images, video, audio, documents and stickers once and reuse the returned media_id
in your sends.
Base URL
Section titled “Base URL”Your API base URL is shown in the dashboard under
Integrations. The examples in these docs use it through a HELLO_API_URL shell variable.
Every endpoint lives under /v1 and authenticates with an API key sent as a Bearer token. See
Authentication.
Start here
Section titled “Start here”QuickstartVerify your key, send your first template message and check its status.
How sending worksQueued vs. synchronous sends, the 24-hour customer-service window and phone number format.
Message typesA copy-paste example for each of the eight message types.
ErrorsEvery error code the Integration API returns and what to do about it.
Endpoints
Section titled “Endpoints”| Method | Path | Purpose |
|---|---|---|
GET |
/v1/ping |
Check that your API key works |
POST |
/v1/{phone_number_id}/messages |
Send a message of any type, or mark one as read |
GET |
/v1/messages/{id} |
Get a message and its delivery status |
GET |
/v1/{waba_id}/templates |
List message templates |
POST |
/v1/{waba_id}/templates |
Create a message template |
DELETE |
/v1/{waba_id}/templates |
Delete every language of a template name |
POST |
/v1/{waba_id}/templates/sync |
Pull templates from WhatsApp |
POST |
/v1/{waba_id}/templates/bulk |
Create or edit many templates |
GET |
/v1/templates/{template_id} |
Get one message template |
POST |
/v1/templates/{template_id} |
Edit one message template |
DELETE |
/v1/templates/{template_id} |
Delete one template language |
POST |
/v1/media/upload |
Upload media and get a media_id |