API reference · WhatsApp

Send a message

Send text, media or a location from your linked WhatsApp number.

POST/v1/whatsapp/send

Bearer API key
Rate limit 120 / min
Returns 201 Created
Needs the WhatsApp permission · 1 credit per message

POST /v1/whatsapp/send

curl https://api.talks.africa/v1/whatsapp/send \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+254712345678",
    "message_type": "text",
    "content": "Your order is on the way"
  }'

{
  "id": "wa_7hq2xa",
  "status": "queued",
  "to": "+254712345678",
  "message_type": "text"
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Body parameters

tostringrequired
Recipient in international format.
message_typestringoptional
text, image, document or location.
contentstringoptional
Text, or a caption for media.
media_urlstringoptional
From POST /v1/whatsapp/media.
latitudestringoptional
For location messages.
longitudestringoptional
For location messages.
scheduled_atstringoptional
Send later.

Response fieldsResponse

id
Message ID
status
queued, sent, delivered, read or failed
upstream_message_id
WhatsApp message ID

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?