Complete guide to integrate WhatsApp Automation API
Before using the API, you need to install the Chrome Extension to connect WhatsApp Web with the API server.
Download Chrome Extension:
Download wauto-ext.zipchrome://extensions/
in the address bar
wauto-ext
folder that was extracted
Tips:
Make sure the API server is running before opening WhatsApp Web.
Use the
/status
endpoint to verify the connection.
All API endpoints require an API key passed in the
Authorization header:
Get your API key from the Dashboard after signing up.
GET /status
Check if the extension is connected. No authentication required.
GET /health
Check if the WhatsApp bridge is ready.
POST /send-text
| Parameter | Type | Required | Description |
|---|---|---|---|
number |
string | Yes | Phone number with country code (e.g. 5521999999999) |
text |
string | Yes | Message text to send |
POST /send-audio
| Parameter | Type | Required | Description |
|---|---|---|---|
number |
string | Yes | Phone number |
audioBase64 |
string | Yes | Base64-encoded audio |
audioMime |
string | No | MIME type (default: audio/ogg) |
audioName |
string | No | Filename |
POST
/send-audio-url — Same but provide
audioUrl instead of base64.
POST /send-image
| Parameter | Type | Required | Description |
|---|---|---|---|
number |
string | Yes | Phone number |
imageBase64 |
string | Yes | Base64-encoded image |
imageMime |
string | No | MIME type (default: image/jpeg) |
caption |
string | No | Image caption |
POST
/send-image-url — Same but provide
imageUrl instead of base64.
POST /call
Make a voice call and play custom audio. Requires Pro plan.
| Parameter | Type | Required | Description |
|---|---|---|---|
number |
string | Yes | Phone number |
audioBase64 |
string | Yes | Base64-encoded audio to play |
audioMime |
string | No | MIME type (default: audio/mpeg) |
timeout |
number | No | Call timeout in seconds |
POST /call-url —
Same but provide audioUrl instead of base64.
POST /hangup
Hang up the current call.
POST /schedule
Schedule a message or call for future delivery. Requires Pro plan.
| Parameter | Type | Required | Description |
|---|---|---|---|
action |
string | Yes | sendText, sendAudio, sendImage, or call |
params |
object | Yes | Action parameters (number, text, etc.) |
scheduledAt |
string | Yes | ISO 8601 datetime |
repeat |
object | No | { count, intervalMs } for recurring |
GET /schedules
List all scheduled jobs. Optional filter: ?status=pending
GET
/schedule/:id — Get one schedule
PUT
/schedule/:id — Update a pending schedule
DELETE
/schedule/:id — Cancel a schedule
DELETE
/schedules/clear — Remove completed/failed/cancelled
| HTTP Code | Error | Description |
|---|---|---|
| 401 | Invalid API key | API key not found or invalid |
| 402 | Insufficient credits | Not enough credits for this action |
| 403 | Plan restriction | Action not available on your plan |
| 429 | Rate limited | Too many requests per minute |
| 500 | Extension error | Error forwarding to WhatsApp |
| 503 | Extension offline | No extension connected |
| Action | Credits |
|---|---|
| Send Text | 1 |
| Send Audio | 2 |
| Send Image | 2 |
| Voice Call | 5 |
| Health Check | 0 |
| Hangup | 0 |