WhatsApp API

WhatsApp messages from your code.

One REST API for text, media, templates and Flows. Every message is tracked to delivery.

500 requests a minute
Playground spends no credit
Pay from a wallet

POST/send/message

curl -X POST "https://api.chatbotsafrica.com/api/v1.0/send/message" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "YOUR_API_KEY",
    "destination": "233241234567",
    "message": "Hello! Thanks for reaching out to us."
  }'

Response200

{
  "success": true,
  "channel": "whatsapp",
  "message": {
    "whatsapp_id": "233241234567",
    "message_id": "wamid.HBgLMjMzMjQxMjM0NTYV...",
    "status": 200,
    "api_type": "Text Message",
    "message_status": "sent"
  }
}

Lands on the customer’s phone Hello! Thanks for reaching out to us. 09:41

Reference

Everything you can send.

19 endpoints behind one key. Full parameters, and a playground that sends nothing real, are in the docs.

Open the full reference

Messages

Everything a customer can receive in a chat.

POST/send/message
Text. A plain text message.
POST/send/image
Image. An image from a public URL, with an optional caption.
POST/send/document
Document. A PDF, DOCX or other file from a public URL.
POST/send/audio
Audio. An audio clip from a public URL.
POST/send/video
Video. A video from a public URL, with an optional caption.
POST/send/sticker
Sticker. A WebP sticker from a public URL.
POST/send/location
Location. A pinned location.
POST/send/contact
Contact card. One or more contacts in WhatsApp’s native format.
POST/send/list/message
List. An interactive list of selectable options.
POST/send/quick/reply
Quick reply. A message with tappable reply buttons.
POST/send/flow/message
WhatsApp Flow. Launch a Flow, like a booking form, inside the chat.
POST/send/reply/message
Direct reply. A threaded reply to a message the customer sent.

Templates

For messages you start, outside the 24-hour window.

POST/send/message/template
Send a template. A Meta-approved template, with its variables filled in.
GET/send/template/list
List templates. Every approved template on your chatbot, with buttons and replies.

Media

Pick up what customers send you.

POST/get/media/url
Retrieve media. Look up a file by the media ID from an inbound webhook.
GET/media/download
Download media. Download the image, document, audio or video a customer sent.

Reports and account

Know what happened, and what is left to spend.

GET/delivery/report
Delivery report. Delivery status and billing details for one message.
GET/wallet/balance
Wallet balance. Your current credit balance.

Contacts

Keep consent on record.

POST/send/opt/contact
Opt in or out. Record a contact’s consent for business-initiated messages.

Get started

From key to first message.

01
Create a chatbot
Set one up in your dashboard and submit it for approval. Approval usually takes about a day.
02
Copy your API key
Once approved, the key sits in your chatbot’s settings. It is the only credential you need, so there is no separate token to fetch.
03
Send a message
POST to the base URL with the key, a destination number and your message. You get back a message ID to track it with.

What teams send

Messages your business already sends.

Order updates

Send a Meta-approved template with the customer’s name and order number filled in, the moment the status changes.

"template_id": 42,
"type": "text",
"placeholder": ["Kwame", "ORD-4821"]

/send/message/template

Invoices and receipts

Attach a PDF from a URL and name it, so the receipt is in the chat before the customer asks.

/send/document

Bookings that stay in the chat

Launch a WhatsApp Flow so customers pick a slot on a form without leaving the conversation.

/send/flow/message

Consent and delivery

Record who has opted in or out, then look up any message by its ID to see whether it landed and what it cost.

GET /delivery/report
  ?apikey=YOUR_API_KEY
  &message_id=wamid.HBgLMjMz...

/delivery/report

FAQ

API questions, answered.

Anything else? Email info@chatbotsafrica.com and we usually reply within one working day.

How do I get an API key?

Create a chatbot in your dashboard and submit it for approval, which usually takes about 24 hours. Once it is approved, the key is on your chatbot’s settings page.

Can I try it without sending real messages?

Yes. The API docs include a mock playground. Every endpoint has a Send Mock Request button that shows the exact request and response shape, without spending credit or sending a WhatsApp message.

How am I charged?

Sending endpoints draw on your wallet credit, and you can check the balance with one call. For message rates or volume pricing, contact us and we will go through your use case.

When do I need a message template?

WhatsApp only allows free-form messages within 24 hours of a customer’s last message. To start a conversation, or to write after that window, send an approved template. List the ones on your chatbot with the templates endpoint.

Is there a rate limit?

Yes, 500 requests a minute. Requests that are missing a field or have an invalid one return a 422 with a list of what to fix.

Does it cover Instagram and Messenger?

WhatsApp is the main API. The same docs also list text, image and quick-reply endpoints for Messenger and Instagram, which need a chatbot on that channel with an account connected.

Ready to send your first message?

Create a chatbot, copy your key and try a call in the playground before you spend anything.

Get an API key Read the docs Talk to us about volume