Applications
- Vobiz Applications API — Bundle Answer URL, Hangup URL, and Message webhook URLs into reusable Vobiz Applications that control inbound call routing and VobizXML flow
- The Application Object — Explore every field of the Vobiz Application object - answer_url, hangup_url, message_url, HTTP methods, SIP URI, and fallback behavior for call..
- Create an Application — Create a Vobiz voice application by registering your answer_url and hangup_url webhooks - the first step to handling inbound calls and messages
- Retrieve an Application — Retrieve a single Vobiz voice application by app_id - inspect its webhook URLs, HTTP methods, fallback configuration, and current number assignments
- Update an Application — Update an existing Vobiz voice application - modify webhook URLs, HTTP methods, app name, or SIP URI to change how inbound calls and messages are..
- Delete an Application — Permanently delete a Vobiz voice application by app_id - removes all webhook configuration and disassociates attached phone numbers and SIP endpoints
- List All Applications — List all voice applications on your Vobiz account - paginated results with full configuration for each app_id, including webhook URLs and attached..
- Attach Number to Application — Link a Vobiz phone number to a voice Application so incoming calls and messages on that number are routed to the Application’s configured webhooks
- Detach Number from Application — Remove the link between a phone number and a voice application
Endpoints
- Vobiz Endpoint API — Manage SIP endpoints on Vobiz for making and receiving calls from IP phones, mobile SIP clients, softphones, and any SIP-compliant device
- The Endpoint Object — Schema reference for the Vobiz SIP Endpoint object: username, SIP URI, registration status, application binding, call permissions, and live..
- Create an Endpoint — Provision a new SIP endpoint on Vobiz to register IP phones, softphones, or AI voice agents - assign a SIP URI, credentials, and call permissions in..
- Retrieve an Endpoint — Fetch a Vobiz SIP endpoint by ID - returns live registration status, SIP contact, expiry, user agent string, and attached application details for..
- Update an Endpoint — Modify a Vobiz SIP endpoint - rotate its password, update the alias, swap the attached application, or toggle voice and video permissions; no..
- Delete an Endpoint — Permanently remove a SIP endpoint from your Vobiz account, immediately unregistering all devices and making the SIP URI permanently unavailable..
- List all endpoints — Retrieve all SIP endpoints on your Vobiz account with pagination - filter by username or alias, check registration status, and audit application..
Call Management
- Call Management Overview — Manage voice calls globally with Vobiz telephony platform - make, transfer, hang up, record, and monitor calls across 130+ countries via a unified..
- The Call Object — Explore every field of the Vobiz Call object - UUID, status, direction, duration, hangup cause, STIR/SHAKEN verification, and per-call billing rate
- Make an Outbound Call — Initiate an international outbound call to any PSTN number or SIP endpoint across 130+ countries, with bulk dialing, AMD, and recording in one API..
- Machine Detection (Call API) — Detect answering machines and voicemail on outbound calls with Vobiz AMD - configure sync or async mode, silence timeout, callbacks, and tuned..
- Transfer a Call (Call API) — Redirect an active call to a new XML instruction URL mid-session using Vobiz - transfer the A-leg, B-leg, or full session for dynamic IVR call..
- Hang Up a Call — Terminate an active Vobiz call by UUID - hang up the A-leg, B-leg, or full bridged session instantly with a DELETE request that triggers CDR..
- Retrieve a live call — Fetch real-time state, direction, duration, and per-leg metadata for a single active Vobiz call by UUID using a GET request with status=live
- Retrieve all live calls — List UUIDs of every active call on your Vobiz account in real time - power monitoring dashboards, concurrent capacity audits, and bulk operations
- Retrieve a queued call — Fetch details of a single pending Vobiz call by UUID before it connects - inspect destination, timestamps, and queue state via GET with status=queued
- Retrieve all queued calls — List UUIDs for all pending outbound calls on your Vobiz account waiting to connect - returns up to 20 queued calls per request for full queue..
- Record calls
- Record calls — Record specific portions of active Vobiz calls with mp3 or wav format, optional speech-to-text transcription, and completion callback delivery
- Start recording a call — Begin recording an active Vobiz call in MP3 or WAV format with optional auto-transcription, multiple concurrent recordings, and callback on..
- Stop recording a call — Stop one or all active recordings on a Vobiz call - finalize the audio file, trigger the callback URL, and make the recording available for download
- Play audio
- Play audio on calls — Play audio files into active Vobiz calls for hold music, IVR prompts, announcements, and dynamic in-call media without interrupting other legs
- Play audio on a call — Stream MP3 or WAV audio files to participants on an active Vobiz call - play single or multiple files in sequence, loop hold music, and target..
- Stop playing audio on a call — Interrupt audio playback on an active Vobiz call instantly - stop hold music, end looping files, or cancel announcements when an agent becomes..
- Speak text
- Speak text on calls — Convert text to speech and play it into active Vobiz calls using the built-in TTS engine with 29-language support and selectable voices
- Speak text on a call — Convert text to speech on any active Vobiz call - choose from 29 languages including Hindi, and WOMAN or MAN voice, for dynamic in-call messages
- Stop speaking text during a call — Halt active text-to-speech playback on a Vobiz call - interrupt looping messages on DTMF input or when an agent joins, without affecting the call..
- DTMF
- DTMF — Send DTMF tones programmatically to an active call to automate IVR navigation, enter access codes, or drive automated phone menus
- Send digits on an active call — Send DTMF keypad tones on any active Vobiz call to automate IVR navigation, enter access codes, and control phone systems programmatically at scale
Conferences
- The Conference Object — Explore the Vobiz Conference object schema - member arrays, mute/deaf states, runtime, call UUID, and join-time fields for multi-party voice calls..
- Retrieve a Conference — Fetch live details of a named Vobiz conference via GET - runtime, member count, mute/deaf states, call UUIDs, and join times for multi-party calls..
- List All Conferences — Retrieve the names of all ongoing conferences on your account, so you can look up details or perform operations on specific rooms
- Hang Up a Conference — Terminate an active Vobiz conference by name via DELETE - instantly disconnects all participants and stops any in-progress recordings across 130+..
- Hang Up All Conferences — Immediately disconnect every participant across all ongoing conferences on your account in a single request
- Conference Members
- Conference Members — Control individual Vobiz conference members - mute, deaf, kick, hang up, and play audio or text to a single participant without affecting others
- Play Audio to a Member — Inject a private MP3 or WAV audio file to targeted Vobiz conference members via POST - whisper announcements or hold music to one participant or all
- Stop Playing Audio to a Member — Interrupt in-progress audio playback for one or more Vobiz conference members via DELETE - stop whisper files or hold music mid-stream across 130+..
- Deaf a Member — Block incoming audio for conference participants via POST - deafen one member, a comma-separated list, or all members in a Vobiz multi-party call..
- Undeaf a Member — Restore incoming audio for deafened Vobiz conference members via DELETE - re-enable one participant, a list of IDs, or all members to hear the call..
- Mute a Member — Silence outgoing audio for conference participants via POST - mute one member, a comma-separated list, or all members in a Vobiz multi-party call..
- Unmute a member — Restore outgoing audio for muted Vobiz conference members via DELETE - unmute one participant, a list of IDs, or all members in a multi-party call..
- Kick a member — Remove a conference participant via POST while continuing their XML flow - play a post-disconnect message or redirect them across Vobiz’s global..
- Hang up a member — Terminate a conference member’s call via DELETE - disconnect one participant, a list of IDs, or all members from a Vobiz multi-party voice call..
- Conference Recording
- Conference recording — Start and stop Vobiz conference recordings in MP3 or WAV format and handle asynchronous API responses
- Start conference recording — Start recording a Vobiz conference via POST - capture all participants in MP3 or WAV format, set a callback URL, and meet compliance requirements..
- Stop conference recording — Stop an active Vobiz conference recording and handle the empty success response
Audio Streams
- Vobiz Audio Streams API: Real-Time Call Audio — Fork live call audio to a WebSocket server in real time with the Vobiz Audio Streams API - for AI voice agents, transcription, and sentiment analysis
- The Stream Object — Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end..
- Start an Audio Stream — Fork live call audio over a WebSocket connection to your AI pipeline in near real time - configure codec, track direction, and bidirectional mode per..
- Retrieve an Audio Stream — Fetch full details for a specific Vobiz audio stream by stream ID - status, WebSocket URL, codec, track direction, bidirectional mode, and start/end..
- List all Audio Streams — List all audio streams - both active and stopped - associated with a Vobiz call UUID, including each stream’s status, codec, track direction, and..
- Stop a Specific Audio Stream — Stop a single Vobiz audio stream by stream ID without affecting other active forks on the same call - triggers a Stream stopped status callback on..
- Stop all Audio Streams — Stop every active audio stream running on a Vobiz call in one DELETE request - ideal for pipeline cleanup at call end or before transferring to a new..
Voice Campaign Manager
- Campaign Manager API Overview — Create and run outbound voice campaigns with reusable agents, CSV contact lists, caller-ID pools, retries, scheduling, capacity controls, and signed..
- Campaign API authentication — Authenticate customer-facing Campaign Manager requests with API keys or a JWT, and understand how internal service endpoints are protected
- Agents
- Create a campaign agent — Create a reusable Campaign Manager agent that defines the answer URL, hangup URL, and static SIP headers used for every call in a campaign
- List campaign agents — Retrieve every non-archived Campaign Manager agent on your account with limit and offset pagination
- Retrieve a campaign agent — Fetch a single Campaign Manager agent by ID, including its answer and hangup webhook configuration and static SIP headers
- Update a campaign agent — Partially update a Campaign Manager agent
- Delete a campaign agent — Soft-delete a Campaign Manager agent. Agents with active campaigns are rejected until those campaigns finish, are cancelled, or are archived
- Campaigns
- Campaign Manager: Create a Campaign — Create an outbound voice campaign with concurrency, timezone, caller-ID strategy, scheduling, daily calling window, and retry policy
- Campaign Manager: List Campaigns — List active or archived outbound voice campaigns on your account with limit and offset pagination
- Campaign Manager: Retrieve a Campaign — Fetch a single campaign with its status, computed health, outcome counters, caller-ID configuration, schedule, and pause reason
- Campaign Manager: Update a Campaign — Partially update a draft or ready campaign — concurrency, caller-ID settings, schedule, daily window, retries, and webhook URL
- Lifecycle controls
- Start a campaign — Launch a ready campaign immediately. Starting clears any scheduled_at value and begins dialling within the account concurrency limit
- Pause a campaign — Pause a running campaign. New dials stop, in-flight calls finish, and the campaign requires an explicit resume
- Resume a campaign — Return a paused campaign to running and immediately re-enqueue its pending contacts
- Cancel a campaign — Permanently stop a running or paused campaign
- Archive a campaign — Soft-delete a non-running campaign to remove it from active lists while preserving its contacts, CDRs, and statistics
- Contacts and results
- Upload campaign contacts — Upload a contacts CSV to a campaign. A valid upload moves the campaign from draft to ready and detects custom columns as SIP headers
- List campaign contacts — Browse a campaign’s contacts with limit and offset pagination, filter by contact status, or search for a specific number
- List campaign call attempts — Retrieve the per-attempt call log for a campaign, joining campaign call records with CDR data, using page and per_page pagination
- Download campaign results — Export campaign contact outcomes as CSV, including partial exports while the campaign is still running
- Caller-ID pool
- Add caller pool numbers — Add one or more caller-ID numbers to a pool campaign so calls rotate across them under the campaign’s rotation strategy and limits
- List caller pool numbers — List the caller-ID numbers in a pool campaign with per-number usage statistics and eligibility status
- Update a caller pool number — Rename a pool number or disable it so it is excluded from caller-ID rotation without losing its call history
- Remove a caller pool number — Remove a caller-ID number from a pool campaign
- Capacity and lookup
- Get account capacity — Inspect live account concurrency, available capacity, utilisation, and the running campaigns consuming it
- Look up a campaign call — Resolve a call UUID to its campaign and contact, and confirm that a campaign owns a given call
- Campaign webhook events — Receive and verify signed voice campaign and contact lifecycle events
XML Overview
- How VobizXML Works: Event-Driven Call Flows — Discover the event-driven cycle powering Vobiz Voice XML
- Getting Started with VobizXML: Build Your First App — Build your first Vobiz voice application from scratch
- VobizXML Best Practices for Reliable Voice Apps — Proven patterns for robust Vobiz XML apps - fast webhook responses, audio caching, fallback flows, CallUUID logging, and scalable IVR architecture..
Stream
- Stream XML Element: Real-Time WebSocket Audio — Fork live call audio to a WebSocket server in real time with Vobiz Stream
- Audio formats: 8, 16, and 24 kHz — Choose and configure supported 8, 16, and 24 kHz audio formats for inbound Vobiz streams and outbound WebSocket playback
- Initiate a Stream — Establish a WebSocket connection to Vobiz Stream and begin streaming raw audio from an active call - covers handshake, codecs, and authentication
- Stream Events Overview — Use the Vobiz Stream WebSocket connection to send events from your application to control playback, mark checkpoints, and signal interruption
- Checkpoint Event — Send a checkpoint event via Vobiz Stream WebSocket when queued audio events are ready - used to synchronize playback with downstream processing logic
- Clear Stream — The Vobiz clearAudio Stream event interrupts audio previously sent via playAudio - useful for instantly stopping TTS when the caller starts speaking
- Play audio event — Send raw L16 or μ-law audio from your WebSocket application to Vobiz for playback on a live call
- Stop Event — Send a stop event on a Vobiz Stream WebSocket to end the stream from your application
Dial
- Dial XML element — Bridge the current call to PSTN numbers or SIP users with Vobiz Dial, with answer and connected-call limits, real-time events, and a final result..
- Number XML element — Dial an E.164 PSTN destination inside the Vobiz Dial element, optionally sending DTMF after answer or during early media
- User XML element — Dial a SIP URI or registered Vobiz WebRTC/SIP user inside Dial, with optional DTMF and X-VH metadata
- Sequential dialing — Attempt PSTN destinations in sequence by returning the next Dial instruction from the previous Dial action URL
- Simultaneous dialing — Attempt several PSTN destinations concurrently with sibling Number elements and handle the winning and LOSE_RACE callback outcomes
- Answer confirmation settings — Configure confirmSound and confirmKey on the Vobiz Dial element while confirmKey connection enforcement remains unverified
- Custom caller tone — Return Play, Speak, or Wait instructions from dialMusic while Vobiz connects a Dial destination
- Dial status reporting — Handle real-time Dial lifecycle events through callbackUrl and receive one final Dial result through action
- Transferred calls end to end — How a transferred Vobiz call behaves - its two call legs, webhook order, how to correlate the legs, how recording spans the transfer, and how each is..
Gather
- Gather XML Element: DTMF & Speech Input — Collect caller input via DTMF or speech recognition (ASR) in a live call
- Detecting speech inputs — Gather’s automatic speech recognition (ASR) on Vobiz accepts spoken input as well as DTMF - configure language, hints, and timeout per gather call
- Pricing for speech recognition — Speech recognition pricing on Vobiz Gather is billed by the duration of speech analyzed - learn how seconds are counted and how to control your spend
- Supported languages — Reference list of BCP-47 language codes Vobiz Gather supports for speech recognition - including en-IN, Hindi, and major global locales for IVR..
Speak
- Speak XML Element: Text-to-Speech on Live Calls — Convert text to speech in a live call with the Vobiz Speak element
- Play a message — Example of the Vobiz Speak XML element - when an inbound call is directed to this document, the Speak verb plays a TTS message to the caller
- Play in a loop — Example of the Vobiz Speak XML element with looping - tells Vobiz to say the word Wow three times in a row using the loop attribute on the Speak verb
- SSML — Use Speech Synthesis Markup Language (SSML) inside the Vobiz Speak XML element to control pronunciation, pauses, emphasis, and prosody of TTS output
Play
- Play XML Element: Play Audio Files to Callers — Stream MP3 or WAV audio from a remote URL to a caller with the Vobiz Play element
- Play music — Example of the Vobiz Play XML element - fetches and plays the audio file Trumpet.mp3 to the active caller on an incoming or outbound call leg
Record
- Record XML Element: Call & Conference Recording — Record calls or conferences with the Vobiz Record element and get a URL at your callback endpoint
- Record a voicemail — This example shows how to record a voicemail message
- Stream with Record — Use the Vobiz Record and Stream XML elements together to simultaneously record a call to file and stream raw audio to your WebSocket in real time
Redirect
- Redirect XML Element: Dynamic Call Flow Routing — Transfer call control to a new URL with the Vobiz Redirect element
- Transfer a Call with Redirect XML — Use the Vobiz Redirect XML element after a Speak verb to transfer control of a call to a different URL that returns fresh XML for the next flow step
Hangup
- Hangup XML Element: End or Reject Calls — End or reject a call at any point with the Vobiz Hangup element
- Hang up call after a minute — Schedule a hangup on a Vobiz call after one minute using the Hangup XML element - example plays a final message before the call is terminated
Wait
- Wait XML Element: Pauses & Machine Detection — Pause a call silently for a set duration with the Vobiz Wait element
- Basic wait — Example of the Vobiz Wait XML element - demonstrates how to insert a seven-second silent pause between two lines of TTS during a Vobiz call flow
- Beep detection — You can use the Wait element to aid leaving voice mails on answering machines by adding an extra parameter called beep and setting it to true
- Delayed call answer — Example of the Vobiz Wait XML element - demonstrates how to delay answering an inbound call by 10 seconds before any other XML verb executes
- Machine Detection with Wait XML — Use the silence parameter on the Vobiz Wait element with machine_detection to distinguish a human pickup from voicemail before continuing the call..
PreAnswer
- PreAnswer XML Element: Early Media Before Answer — Answer incoming calls in early media mode with the Vobiz PreAnswer element
- Notify callers — Use the Vobiz PreAnswer XML element to notify the caller that the current call costs $2 a minute before fully answering and billing the call
Conference
- Conference XML Element: Multi-Party Call Rooms — Connect callers to a named conference room with the Vobiz Conference element
- Conference Attributes — Full reference for every attribute on the Vobiz Conference XML element - control muting, beeps, participant limits, hold music, and recording
- Conference callbacks — Handle participant enter and exit callbacks and wait-audio requests from Vobiz conferences
Request
- VobizXML Request: Webhook Parameters & Call Payload — Vobiz sends a synchronous HTTP request with call parameters to your endpoint on each call event
- Call status — Vobiz sends a call status to request URLs under the CallStatus key
- Event — Vobiz generates call events when the state of a call changes - your application receives them as HTTP requests so it can update state and trigger..
- SIP headers — Receive X-VH custom headers from inbound SIP calls or pass application metadata through Dial and User callbacks
Response & DTMF
- Response XML Element: Root of Call Instructions — Every Vobiz XML document must wrap call instructions in a single Response root element
- DTMF XML Element: Send Tones on Live Calls — Send DTMF tones programmatically on a live call with the Vobiz DTMF element