telvox
API keys

TelVox · Connect · Guides

Guides

Task-oriented how-tos for common voice workflows, each built on a real TelVox capability. This page is an index: it points you at the capability and concept docs that cover each task today. Full tutorials are on the way.

API stability

Connect is live. The API is v0.x, so field names may change before v1. This index links each task to its capability page. To start now, see the Quickstart.

Browse by task

Build an IVR menu

Greet a caller with Say, collect a keypress with Gather and route with Dial, all from the XML your webhook returns. For a simple menu with no code, turn on the one-level keypress IVR for the number in the dashboard.

Call control & IVR
Set up call tracking

Claim a number for each campaign in the dashboard, point each one at your webhook, and attribute inbound calls by the To number in the webhook body.

Numbers
Send outbound voice notifications

Place outbound calls from your code to deliver a message, then follow each call on your statusCallback. A single POST to /api/calls starts the call, and the XML your url returns plays the message with Say or Play.

Voice API
Put agents on calls in the browser

Create a WebRTC agent seat. Your server fetches the seat's SIP-over-WSS credentials and TURN servers with your API key, and a browser SIP library such as JsSIP signs in with them.

SIP & WebRTC
Record a call for QA

Record with the record attribute on Dial, follow the recording status callback, and fetch the WAV from GET /api/recordings/{name} with your API key. Pause, resume or stop a live recording through the API.

Recording
Look up your own data mid-call

Gather posts the caller's keypress to your action URL. Your server looks up the account in your own systems and replies with the next XML, such as a Dial to the right team.

Call control & IVR

Related

  • Call-control markup: the webhook loop and the XML behind the IVR and lookup guides.
  • Webhooks & callbacks: the status and recording callbacks the notification and recording guides react to.
  • API reference: the endpoints, fields and statuses behind the guides above.