TelVox · Connect · Docs

Developer docs

TelVox Connect is the programmable voice API from TelVox. Place and receive calls, control them with the XML or JSON your webhook returns, record them, and get status callbacks in your own code. These docs cover the concepts, a make-your-first-call quickstart, task guides and the API reference.

API stability

Connect is live. The API is v0.x, so field names may change before v1. The samples in these docs are written against the live API.

The auth model, in brief

Server-side requests send your API key (it starts with sk_live_) as a Bearer token in the Authorization header. The base URL is https://connect.telvox.dev/api. We set up your account with you. After that you create API keys yourself in the dashboard, and each key is shown once. Send Accept: application/json on every request so errors come back as JSON. See Authentication & API keys for the full model.

POST/api/calls

curl -X POST https://connect.telvox.dev/api/calls \
  -H "Authorization: Bearer $TELVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "from": "+918045670100",
    "to": "+919876500199",
    "url": "https://your.app/voice/answer",
    "statusCallback": "https://your.app/voice/status",
    "statusCallbackEvent": ["initiated"]
  }'

201 createdinitiated

Start here

New to Connect? These three get you from zero to a ringing phone.

Quickstart

Make your first call end to end: create an API key in the dashboard, host a webhook that returns XML, POST to /api/calls with a url, and handle the status callback.

Open

Authentication & API keys

How requests are authenticated: one sk_live_ API key, sent as a Bearer token.

Open

Make your first call

A single POST to /api/calls places an outbound call. Inbound calls hit the webhook URL set on the number, so your app decides what happens next.

Open

Concepts

The mental model behind the API: how auth, call control and webhooks fit together.

Authentication & API keys

One sk_live_ key sent as a Bearer token, creating and deleting keys in the dashboard, and keeping the key on your server.

Open

Call-control markup

The webhook loop and the markup your app returns: TwiML-style XML (Say, Play, Gather, Dial, Record and more), plus a smaller JSON form.

Open

Webhooks & callbacks

Status callbacks across the call lifecycle, sent as JSON with Twilio-style field names. They are sent once and are not signed.

Open

Guides, reference & SDK status

Go deeper: task guides, the per-resource API reference, and what to use while there are no SDKs.

Guides

Task-oriented how-tos: build an IVR, track calls by number, send outbound notifications, put agents in the browser, record for QA.

Open

API reference

Base URL, auth, errors, and the endpoints that exist today: Calls, recording controls, recording fetch and SIP trunks.

Open

SDK status

There are no TelVox SDKs or CLI yet. Call the REST API with any HTTP client. Twilio helper libraries do not work against it.

Open