Get started
Quickstart
Link a number, create a key and send a WhatsApp message. Three steps.
1. Connect a WhatsApp number
Create an account and open WhatsApp numbers in your workspace. Add a number and scan the QR code with the phone that owns it, the same way you link WhatsApp Web. When the status reads connected, copy the connection ID. It starts with conn_. Once you have an API key, GET /v1/connections lists your numbers with their IDs and statuses.
2. Create an API key
Open Developer API and create a key. Give it only the scopes it needs. The full key is shown once, so store it as a secret on your server. Never ship it in a browser or a mobile app.
| Scope | Allows |
|---|---|
messages:send | POST /v1/messages |
messages:read | GET /v1/messages/{id} |
otp:send | POST /v1/otp/send |
otp:verify | POST /v1/otp/verify |
webhooks:manage | Create, list and delete webhook endpoints under /v1/webhooks |
3. Send a message
export OXTRO_API_KEY="wa_live_..."
curl https://api.getoxtro.com/v1/messages \
-H "Authorization: Bearer $OXTRO_API_KEY" \
-H "Idempotency-Key: order-4821-confirmation" \
-H "Content-Type: application/json" \
-d '{
"connection_id": "conn_123",
"to": "+213555123456",
"text": "Your order ORD-4821 has been confirmed."
}'The API answers 202 Accepted as soon as the message is queued:
{
"id": "msg_123",
"status": "queued",
"queued_at": "2026-10-10T09:41:07.000Z"
}The message goes out through a queue a moment later. To see whether it was delivered, look it up by ID or subscribe to webhooks.