Call Management Overview
Comprehensive control over voice calls, including making calls, call control operations, recording, playing audio, text-to-speech, and DTMF digit sending.
Introduction
A Call object is created when an outbound call is initiated or when an inbound call is received. You can use a Call object to interact with ongoing calls, retrieve details about completed calls, and transfer ongoing calls, thereby building custom call flows.
Base URL
https://api.vobiz.ai/apiEndpoint
https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/Authentication
Authentication Required:
- • X-Auth-ID: Your account ID (e.g., {Auth_ID})
- • X-Auth-Token: Your account Auth Token
Example Request Headers
Call Operations
Make a Call
Initiate an outbound call to a PSTN number or SIP endpoint.
View Documentation →Machine Detection
Detect answering machines on outbound calls with synchronous or asynchronous detection modes.
View Documentation →Retrieve a Call
Get the call detail record (CDR) of a specific call using its call UUID.
View Documentation →Transfer a Call
Transfer an ongoing call to fetch and execute XML from a different URL. Transfer A-leg, B-leg, or both.
View Documentation →Hang Up a Call
Hang up an ongoing call or cancel a queued outbound call.
View Documentation →Retrieve All Calls
Get a list of all completed calls with filtering options. Supports pagination with limit and offset.
View Documentation →Retrieve a Live Call
Get details of a specific ongoing call in real-time using its call UUID.
View Documentation →Retrieve All Live Calls
Get a list of all ongoing calls (v1). Returns an array of call UUIDs for currently active calls.
View Documentation →Retrieve a Queued Call
Get details of a specific queued outbound call that has not yet been initiated using its call UUID.
View Documentation →Retrieve All Queued Calls
Get a list of all queued outbound calls. Returns up to 20 queued calls per request.
View Documentation →Record Calls
Record call audio in MP3 or WAV format with automatic transcription support. Start and stop recording during active calls.
View Documentation →Play Audio on Calls
Play audio files during active calls. Support for single or multiple audio files, looping, and selective playback to caller or callee.
View Documentation →Speak Text on Calls
Convert text to speech and play during active calls. Support for 29 languages with multiple voice options.
View Documentation →DTMF
Send DTMF digits during active calls for IVR navigation and menu selection.
View Documentation →