Skip to content
Docs

API reference

One resource per page below. Every endpoint is relative to the base URL and needs a bearer token; request and response bodies are JSON.

Base URL

https://api.sautipbx.com/api

Auth header (every request)

Authorization: Bearer sk_live_...

Conventions

Section titled “Conventions”
  • Types. string, integer, boolean, object (JSON object), array. A type marked nullable may be null.
  • Timestamps are ISO-8601 strings in UTC (e.g. 2026-07-05T10:00:00Z). Money is a decimal string in KES (e.g. "12.50"), never cents.
  • Identifiers. Every resource has a stable uuid. Calls also carry a human-friendly sid (e.g. call_9Xk2).
  • Errors return the matching HTTP status with a body { "detail": "..." }: see Errors for the full table.
  • Idempotency. Endpoints that place a call or spend money accept an Idempotency-Key header. See Rate limits & idempotency.

Resources

Section titled “Resources”
CallsOriginate, hang up, list and fetch call records.
NumbersAcquire, release and configure DIDs.
RecordingsList, download and delete call recordings.
Phone tokensShort-lived credentials for browser and mobile softphones.
End-usersThe identities behind softphones and their extensions.
Account & webhooksAccount info, default webhook URL and signing secret.
API keysCreate, list and revoke bearer credentials.
WalletBalance and transaction history, in KES.
Stream tokenMint a token for the realtime event WebSocket.
Events & codesThe full event and terminal reason code catalogue.

Health check

Section titled “Health check”

A lightweight, unauthenticated status probe for your uptime monitor:

Terminal window
curl https://api.sautipbx.com/api/health/

Returns 200 { "status": "ok" } when healthy, or 503 { "status": "degraded" }. No Authorization header needed.

Interactive schema

Section titled “Interactive schema”

Every endpoint is also generated live from the running API as an OpenAPI schema, with a browsable “try it out” explorer. Useful for poking at a request shape without leaving your browser.

Open the interactive explorerSwagger-style explorer generated from the running API.
Download openapi.jsonThe raw OpenAPI schema.