API Documentation

Everything you need to integrate WhatsApp messaging into your application.

Quick Start

Send your first message

curl -X POST \
  https://api.yoursite.com/api/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "+237XXXXXXXXX", "message": "Hello!"}'

Authentication

All API requests require authentication using a Bearer token. Generate your API key from the dashboard.

Authorization: Bearer your_api_key_here

API Endpoints

Sessions

POST/api/v1/sessions

Create a new WhatsApp session

GET/api/v1/sessions

List all your sessions

GET/api/v1/sessions/{id}

Get session details

GET/api/v1/sessions/{id}/stream

SSE stream for QR code updates

PATCH/api/v1/sessions/{id}

Update session name

DELETE/api/v1/sessions/{id}

Delete a session

Messages

POST/api/v1/messages

Send a text message

POST/api/v1/messages/media

Send an image or video

POST/api/v1/messages/audio

Send audio or voice note

GET/api/v1/messages

List sent messages

GET/api/v1/messages/{id}

Get message status

API Keys

POST/api/v1/keys

Create a new API key

GET/api/v1/keys

List all your API keys

DELETE/api/v1/keys/{id}

Revoke an API key

Send Text Message

Request

POST /api/v1/messages

{
  "to": "+237612345678",
  "message": "Hello from WhatsApp API!"
}

Response (202)

application/json

{
  "id": "uuid",
  "toPhone": "+237612345678",
  "type": "text",
  "status": "pending"
}

Send Image or Video

Request

POST /api/v1/messages/media

{
  "to": "+237612345678",
  "mediaUrl": "https://example.com/image.jpg",
  "mediaType": "image",
  "caption": "Check this out!"
}

Supported Formats

🖼️ ImagesJPEG, PNG, WebP, GIF (16MB)

🎬 VideosMP4, 3GPP, MOV, WebM (64MB)

Send Audio or Voice Note

Request

POST /api/v1/messages/audio

{
  "to": "+237612345678",
  "audioUrl": "https://example.com/voice.ogg",
  "ptt": true
}

PTT (Push to Talk)

ptt: true→ Voice Note 🎙️

ptt: false→ Audio File 🎵

Formats: MP3, OGG, AAC, WAV, Opus (max 16MB)

Session Management

1. Create Session

POST /api/v1/sessions
{ "session_key": "my-session" }

2. Scan QR Code

Connect to the SSE stream to receive QR code updates:

GET /api/v1/sessions/{id}/stream
Events: qr, connected, error

3. Send Messages

Once connected, you can send messages using the Messages endpoints.

Rate Limits

Plan	Sessions	Messages/day
Free	10	100
Pro	Unlimited	10,000

Error Codes

401 UnauthorizedInvalid or missing API key

404 Not FoundSession or resource not found

409 ConflictSession not connected

429 Too Many RequestsRate limit exceeded

Ready to get started?

Create your free account and start sending WhatsApp messages in minutes.

Create Free Account