Getting started
Quickstart
Connect a number and send your first WhatsApp message.
This quickstart assumes you already have a ChatKazi account.
Connect a WhatsApp number
In the dashboard, open Whatsapp Sessions and connect a WhatsApp number. You can connect with a QR code or a pairing code.
If you are building your own onboarding flow, use the session endpoints documented in Sessions.
Create an API key
Open API Keys in the dashboard and create a key for your integration.
Store the key on your server as CHATKAZI_API_KEY.
Check connected sessions
Terminal
curl "$CHATKAZI_BASE_URL/sessions" \
-H "x-api-key: $CHATKAZI_API_KEY"
You should see at least one session with state set to connected.
Send a text message
Terminal
curl -X POST "$CHATKAZI_BASE_URL/messages/text" \
-H "x-api-key: $CHATKAZI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "default",
"to": "254712345678",
"text": "Hello from ChatKazi."
}'
Minimal backend example
send-message.js
import { chatkazi } from './chatkazi.js'
await chatkazi('/messages/text', {
method: 'POST',
body: JSON.stringify({
sessionId: 'default',
to: '254712345678',
text: 'Your order has been confirmed.'
})
})
Phone number format
Send phone numbers in international format without spaces or the + sign.
254712345678
Session selection
If you have one connected WhatsApp number, use default as sessionID or omit sessionId.
If you have multiple connected numbers, send with the session that should own the conversation:
{
"sessionId": "nairobi_shop",
"to": "254712345678",
"text": "Your pickup is ready."
}