Skip to main content
A complete, always-current index of the Vobiz documentation: 430 pages, grouped exactly as they appear in the sidebar, each with a one line summary.
Machine-readable versions of this index: sitemap.xml for crawlers, llms.txt for AI agents, and llms-full.txt for the full text of every page in one file. Agents can also query the docs live over the MCP server or install the agent skills.

​
Documentation

​
Getting Started

​
Core Concepts

​
Best Practices

​
Using Vobiz Platform

​
Compliance (India)

  • India Calling Regulations — Regulatory requirements, eligibility rules, and compliance setup for domestic voice calling within India on Vobiz - DLT, KYC, and TRAI guidelines
  • India Number KYC — Verify your identity or business to start renting Indian phone numbers
  • UCC & NDNC Compliance — NDNC/DND registry, UCC complaints, and TRAI enforcement for Indian voice numbers - how Vobiz enforces the Do Not Call list and what to do when a..

​
FAQ

  • Vobiz FAQ – Billing, API Limits, SIP Trunking & Integrations — Quick answers on Vobiz accounts, billing, concurrency limits, SIP trunking, AI voice integrations, and global compliance
  • Can I connect my trial number for inbound calls? — Vobiz trial numbers are outbound-only - understand why inbound routing is restricted on trial accounts and the exact steps to unlock it on a verified..
  • Why am I receiving SIP response codes 480 or 486? — SIP 480 and 486 errors on Vobiz indicate the callee is unavailable or busy - learn what triggers each code, how to read CDRs, and how to debug..
  • Why am I receiving a 429 error? — A Vobiz 429 Too Many Requests error means you have hit a concurrency or CPS limit - find out which limit is breached and the exact steps to fix it
  • What is Concurrency? — Concurrency on Vobiz defines how many calls run simultaneously on your account - understand channel limits, what triggers a 429 error, and how to..
  • What is CPS (Calls Per Second)? — CPS on Vobiz controls how fast you can initiate calls, independent of concurrency - learn how CPS rate limiting works and how to pace outbound..
  • Can I purchase additional Concurrency or CPS? — Upgrade your Vobiz concurrency and CPS limits through the dashboard to scale outbound campaigns and handle thousands of simultaneous calls..
  • Do you provide 140, 160, and 92 series numbers? — Vobiz provisions 140, 160, and 92-series numbers for India - learn the TRAI-regulated use case for each series, mobile pickup rate advantages, and..
  • What integrations do you support? — Vobiz natively supports LiveKit, Pipecat, Retell AI, ElevenLabs, VAPI, and SIP PBX systems - connect any AI voice agent or WebRTC stack to the global..
  • Is call transfer supported? — Vobiz supports three call transfer methods - Dial XML, REST API live transfer, and SIP REFER (RFC 3515) - covering warm transfers, cold transfers..
  • Do you support IVR? — Build fully programmable IVR menus on Vobiz using Gather, Speak, Play, and SIP transfer XML - supporting DTMF input, speech recognition, and dynamic..
  • What documents are required for verification? — Complete Vobiz KYC verification with GST certificate for organizations or Aadhaar and PAN for individuals - required before purchasing live numbers..
  • How can I contact support? — Contact the Vobiz engineering and success teams via email for API integration help, network debugging, capacity upgrades, and billing - with tips for..
  • Domestic Calling in India — Use Vobiz domestic calling for IN-to-IN traffic to get lower latency, guaranteed local caller ID, INR billing, and better audio quality than..

​
Tools

  • CPS & Cost Calculator — Estimate Calls Per Second, simultaneous concurrency, and capacity requirements for your voice campaigns
  • Vobiz Visual XML Builder – Compose Voice Call Flows — Compose Vobiz Voice XML visually - pick verbs, reorder them, and configure attributes with a live preview
  • Stream Events Visualizer — Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, and stop events
  • Dial XML Transfer Visualizer — Step through a Vobiz call transfer: a caller reaches your AI agent, Dial rings a human on standby, and the human accepts or rejects
  • Gather XML Input Visualizer — Walk a Gather from prompt to action URL. Press the dial pad, watch which of the four terminators wins - numDigits, finishOnKey, digitEndTimeout or..
  • Vobiz MCP Server — Connect Claude, Cursor, VS Code, and other AI clients directly to the Vobiz documentation through the Model Context Protocol (MCP)
  • Vobiz Agent Skills — Install the Vobiz agent skills into Claude Code, Codex, and 40+ other coding agents with one command, so your AI assistant knows how to drive the..
  • Vobiz Documentation Sitemap — Every page in the Vobiz documentation, grouped as it appears in the sidebar, with a one line summary of each

​
API Reference

​
Regular APIs

​
Account

  • Vobiz Account API – Manage Balance, Credentials & Concurrency — Manage your Vobiz account via REST API - retrieve balance, concurrency limits, CPS, auth credentials, and billing mode for prepaid or postpaid plans..
  • The Account Object — Explore every field in the Vobiz Account object - auth_id, pricing tier, CPS limits, concurrency caps, IP whitelist, and verification status for..
  • Retrieve Account Details — Fetch complete Vobiz account details - auth credentials, pricing tier, verification status, and contact info - with a single authenticated GET..
  • Balance & Transactions — Check your Vobiz account balance by currency and retrieve a full transaction ledger - credits, debits, and invoice history for voice usage worldwide
  • Concurrency — Retrieve real-time concurrent call usage for your Vobiz account - monitor active channels, check capacity headroom, and scale voice infrastructure..
  • Preview CPS and concurrency pricing — Calculate the monthly price for additional Vobiz CPS or concurrent-call capacity without purchasing capacity or debiting the account
  • Purchase CPS or concurrency capacity — Purchase recurring Vobiz CPS or concurrent-call capacity and activate a channel subscription that renews every 30 days
  • NDNC Webhook — Receive real-time UCC / NDNC complaint alerts on your own HTTPS endpoint

​
Sub-Accounts

  • Vobiz Sub-Accounts API – Multi-Tenant & Reseller Account Management — Provision and manage isolated customer sub-accounts under a Vobiz parent account - segmented billing, independent credentials, and usage tracking for..
  • Sub-Account Onboarding Flow — End-to-end example: create a customer_use sub-account, complete KYC, buy and assign a number, and place the first call - with explicit guidance on..
  • The Subaccount Object — Explore the Vobiz Subaccount object schema - auth credentials, permissions, rate limits, SA_ identifier format, and tenant isolation under a parent..
  • Create a Subaccount — Provision an isolated Vobiz subaccount with its own auth credentials for multi-tenant SaaS apps, white-label resellers, or departmental resource..
  • Retrieve a Subaccount — Fetch the full details of a specific Vobiz subaccount by its sub_auth_id - credentials, permissions, rate limits, and current status for a single..
  • Update a Subaccount — Update any fields on a Vobiz subaccount - rename it, toggle enabled status, adjust rate limits, or modify permissions
  • Delete a Subaccount — Permanently delete a Vobiz subaccount and revoke its authentication credentials - irreversible operation for offboarding tenants or closing reseller..
  • List All Subaccounts — Retrieve a paginated list of all Vobiz subaccounts sorted by creation date - enumerate tenants across your multi-tenant SaaS or reseller platform
  • Assign DID to Sub-Account — Assign a parent-pool DID to one of your sub-accounts so it can place and receive calls on that number
  • Unassign DID (15-Day Cool-Off) — Move a DID back to the parent pool. A 15-day cool-off blocks numbers that had a call in the last 15 days; admins can bypass with force=true
  • KYC
    • Sub-Account KYC — Verify customer_use sub-accounts with per-document KYC - PAN, GST, CIN, and Aadhaar via DigiLocker - or hand off to a Vobiz-hosted KYC session
    • Get KYC Status — Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business..
    • Verify PAN — Run a real-time PAN verification for a customer_use sub-account
    • Verify GST — Run a real-time GSTIN verification for a customer_use sub-account using a 15-character GSTIN
    • CIN Search — Look up a company’s CIN by name. Returns candidate matches to confirm in the next step
    • CIN Confirm — Confirm the CIN selected from the search results to complete company identity verification
    • DigiLocker Initiate — Start a DigiLocker-based Aadhaar verification - returns the authorization link and an access_request_id for the customer to complete OAuth
    • DigiLocker Verify — Finalize Aadhaar verification via DigiLocker after the customer completes the OAuth flow
    • Create KYC Session — Hand off sub-account KYC to a Vobiz-hosted widget - either email the customer a signed link or redirect them inline
    • KYC Email Flow with Webhook — Start a hosted sub-account KYC via email link and register a webhook to receive status updates - create the session, the events Vobiz POSTs, and how..
    • KYC Redirect Flow with Webhook — Start a hosted sub-account KYC via redirect - get a widget_url back, redirect the customer yourself, and register a webhook for status updates
    • KYC Test Mode — Build and test your sub-account KYC integration without real documents

​
Phone Numbers

  • Vobiz Phone Numbers API – Buy, Manage & Release DIDs Globally — Buy, manage, and release virtual phone numbers globally via the Vobiz API - covering India DIDs, 160 series, 140 series, E.164 numbers across 130+..
  • The PhoneNumber Object — Every Vobiz phone number is modeled as a PhoneNumber object holding capabilities, billing, E.164 format, status, and assignment details for voice..
  • List Account Phone Numbers — Retrieve all phone numbers purchased and assigned to your Vobiz account - capabilities, billing, status, and application assignments across 130+..
  • List Inventory Numbers — Browse Vobiz phone numbers available for purchase - search unassigned DIDs, virtual numbers, and toll-free numbers by country, prefix, or voice..
  • Purchase from Inventory — Purchase a Vobiz phone number from inventory and assign it to your account - instantly deducts setup and monthly fees and activates the number for..
  • Release a Phone Number — Release a Vobiz phone number with a 24-hour cancellation window, or skip the cooldown with an immediate release
  • Cancel a Number Release — Cancel a pending phone number release during the 24-hour cooldown and restore the number to active
  • Get Number Health Dashboard — Retrieve the health and analytics dashboard for a Vobiz number - status, spam flag, and call metrics (total/answered calls, answer rate, minutes)..

​
Recordings

  • Vobiz Recordings API – Call & Conference Recording Management — List, retrieve, download, and delete Vobiz call and conference recordings via REST API - with bulk export, compliance-grade storage, per-recording..
  • The Recording Object — Explore every field on the Vobiz Recording object - recording ID, file URL, format, duration, source call UUID, and storage billing
  • Retrieve a Recording — Fetch full metadata for a specific Vobiz call recording by ID - file URL, duration, format, associated call UUID, and storage billing
  • List All Recordings — Retrieve a paginated list of Vobiz call recordings with filters for recording type, trunk, or extension - for archival, compliance, and quality..
  • Download a Recording — Programmatically download Vobiz recording files and resolve common authentication issues during playback - example code and troubleshooting tips
  • Export Historical Recordings — Export Vobiz call recordings matching filter criteria as a downloadable archive delivered via email - async background job for bulk historical data..

​
Call Detail Records

  • Vobiz Call Detail Records (CDR) API – Call Logs & Billing Analytics — Query, filter, and export Vobiz CDRs with per-call billing data, MOS scores, jitter, hangup attribution, and CSV export - for reconciliation, fraud..
  • List CDRs — Retrieve paginated Vobiz call detail records with filters for date range, number, direction, and duration - the primary endpoint for call analytics..
  • Get Single CDR — Retrieve the full call detail record for a specific call by its call_id - duration, disposition, caller ID, timestamps, and billing data for a single..
  • Search CDRs — Search Vobiz call detail records with active filter combinations - find specific calls by number, status, or duration for dispute resolution and..
  • Recent CDRs — Fetch the most recent Vobiz call detail records without date filters - a quick tail view of your latest voice traffic for real-time debugging and..
  • Export CDRs as CSV — Export Vobiz call detail records as a CSV file for billing reconciliation, compliance auditing, and traffic analysis - returns text/csv content..

​
SIP Trunking

​
Trunks

  • Vobiz SIP Trunking API – Enterprise Voice & Elastic SIP Trunks — Create and manage elastic SIP trunks on Vobiz - auto-provisioned SIP domains, IP or credential auth, CPS throttling, and priority failover routing..
  • The Trunk Object — Explore the Vobiz SIP Trunk object schema - SIP domain, auth mode, credentials, IP ACLs, origination URIs, rate limits, and all fields returned by..
  • Create a Trunk — Provision a new Vobiz SIP trunk with concurrent-call limits, CPS caps, TLS/SRTP, credentials, IP ACLs, and origination URIs - all in a single API..
  • Retrieve a Trunk — Fetch full configuration of a single Vobiz SIP trunk by ID - rate limits, auth mode, SIP domain, and attached credentials, IP ACLs, and origination..
  • Retrieve All Trunks — Paginated list of all SIP trunks on your Vobiz account - view configurations, monitor rate limits, and manage global SIP trunking resources in one..
  • Update a Trunk — Modify an existing Vobiz SIP trunk - update name, description, concurrent-call limits, CPS caps, or webhook URL without recreating the trunk resource
  • Assign Number to Trunk — Assign a phone number to a Vobiz SIP trunk so all inbound calls to that DID route through the designated trunk - supports global and India DID..
  • Unassign Number from Trunk — Remove a phone number’s trunk assignment on Vobiz - the DID returns to your account inventory and inbound routing via the trunk stops immediately
  • Delete a Trunk — Permanently delete a Vobiz SIP trunk and all associated credentials, IP ACLs, and origination URIs - this action is irreversible and stops all trunk..
  • Trunk Webhooks — Configure HTTP webhooks on Vobiz SIP trunks to receive real-time call events globally - call admitted, rejected, or ended with duration, cost, and..

​
Credentials

  • Credentials — Manage SIP credentials for username and password authentication on your Vobiz trunks - create, list, rotate, and revoke credentials per trunk
  • The Credential Object — Explore the Vobiz SIP Credential object schema - credential_id, username, write-only password, enabled flag, trunk association, and ISO 8601..
  • Create Credential — Add a SIP digest credential to a Vobiz trunk to authenticate softphones, IP phones, or AI voice agents - unique username required, password is..
  • Retrieve All Credentials — Paginated list of all SIP digest credentials on your Vobiz account - audit usernames, check enabled states, and manage authentication for global SIP..
  • Update Credential — Rotate the password, toggle the enabled state, or update the description of a Vobiz SIP credential without interrupting other active trunk..
  • Delete Credential — Permanently revoke a SIP digest credential from your Vobiz trunk - every device or AI agent using that username loses authentication access..

​
IP Access Control List

  • IP Access Control Lists — Manage IP-based authentication for your Vobiz SIP trunks using IPv4 whitelisting - restrict trunk access to known PBX and softswitch addresses
  • The IP ACL Object — Complete field reference for the Vobiz IP ACL object - covers ip_address, enabled flag, UUID, and ISO 8601 timestamps for SIP trunk IP allowlists
  • Create IP ACL — Add an IPv4 address to your Vobiz SIP trunk allowlist so PBX systems, SBCs, or carriers authenticate calls without SIP digest credentials - 130+..
  • Retrieve All IP ACLs — Fetch a paginated list of all IP ACL entries on your Vobiz account to audit whitelisted IPv4 addresses, enabled states, and trunk IP auth coverage..
  • Update IP ACL — Modify a Vobiz IP ACL entry to update the whitelisted IPv4 address, toggle its enabled state, or edit the description - all with a single PUT request
  • Delete IP ACL — Permanently remove a whitelisted IPv4 address from a Vobiz SIP trunk, revoking IP-based authentication and blocking unauthenticated calls from that..

​
Origination URI

  • Origination URIs — Configure outbound SIP routing destinations on your Vobiz trunk - origination URIs control where the trunk delivers inbound traffic for termination
  • The Origination URI Object — Complete field reference for the Vobiz Origination URI object - SIP URI format, priority, weight, transport protocol, enabled flag, and ISO 8601..
  • Create Origination URI — Add a SIP destination URI to your Vobiz trunk for outbound routing - set priority and weight for load balancing and carrier failover across 130+..
  • Retrieve All Origination URIs — List all SIP destination URIs on a Vobiz trunk - review routing priority, load-balancing weights, and enabled status to audit outbound call..
  • Update Origination URI — Update a Vobiz origination URI - change SIP destination, routing priority, load-balancing weight, or enabled state with a partial PUT; no re-creation..
  • Delete Origination URI — Permanently remove a SIP destination URI from a Vobiz trunk, halting outbound routing to that endpoint - keep at least one active URI to avoid call..

​
Voice & XML

​
Applications

  • Vobiz Applications API – Configure Answer, Hangup & Message URLs — Bundle Answer URL, Hangup URL, and Message webhook URLs into reusable Vobiz Applications that control inbound call routing and XML flow for any phone..
  • 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 — Detect answering machines and voicemail on global outbound calls with Vobiz AMD - configure sync or async mode, silence timeout, and callback..
  • Transfer a Call — 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 WebSocket Call Audio — Fork live call audio to a WebSocket server in real time with the Vobiz Audio Streams API - enabling AI voice agents, speech transcription, sentiment..
  • 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

​
XML Overview

​
Stream

  • Stream XML Element – Real-Time WebSocket Audio | Vobiz — 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 via Vobiz Stream WebSocket to terminate the stream from your application - Vobiz immediately proceeds to the next XML element, or..

​
Dial

  • Dial XML element — Bridge the current call to PSTN numbers or SIP users with Vobiz Dial, with explicit answer and connected-call limits, real-time events, and a final..
  • 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

​
Gather

  • Gather XML Element – Collect DTMF & Speech Input | Vobiz — 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 in Live Calls | Vobiz — 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

​
Record

​
Redirect

​
Hangup

​
Wait

  • Wait XML Element – Silent Pause & Machine Detection | Vobiz — 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 — Use the silence parameter on the Vobiz Wait element with machine_detection to distinguish a human pickup from voicemail before continuing the call..

​
PreAnswer

​
Conference

​
Request

  • Vobiz XML 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

​
WhatsApp

​
Getting Started

  • Introduction to WhatsApp Business — Discover how the WhatsApp Business API works on Vobiz - enterprise messaging at scale in 130+ countries with templates, webhooks, and a no-code..
  • Prerequisites — Complete every prerequisite for WhatsApp Business on Vobiz - Meta Business Account, verified phone number, and approved display name - in 15–30..
  • Quick Start Guide — Get up and running with Vobiz WhatsApp Business in under 5 minutes - connect your first channel and send messages via console and API examples

​
Channel Management

  • Channel Management — Connect and manage WhatsApp Business channels on Vobiz - choose from multiple connection methods, run multiple channels, and monitor performance
  • Bring Your Own Number (BYON) Setup Guide — Connect your existing WhatsApp Business number to Vobiz using BYON - step-by-step setup guide covering OTP verification, Meta Business Manager, and..

​
Messaging

  • WhatsApp Messaging — Send messages, manage conversations, and engage customers on WhatsApp Business via Vobiz - message types, the 24-hour window, and template basics
  • Using the WhatsApp Inbox — Manage all WhatsApp conversations from the Vobiz shared inbox - send messages, view history, use canned responses, and collaborate across agents in..
  • WhatsApp Message Templates — Create and submit WhatsApp message templates on Vobiz for Meta approval - required for all outbound business-initiated messages outside the 24-hour..

​
Webhooks

  • WhatsApp Webhooks — Receive real-time WhatsApp event notifications from Vobiz on your own server - inbound messages, delivery status, and call events delivered as signed..
  • Webhook Events Reference — Reference for every outbound WhatsApp webhook event Vobiz delivers to your server - the common envelope, the three real event types (message.inbound..

​
WhatsApp Business API

  • Vobiz WhatsApp Business API Reference — Use the Vobiz WhatsApp Business API reference to send messages and manage channels, contacts, templates, campaigns, conversations, calls, and..
  • API Authentication — Authenticate every Vobiz WhatsApp API request using X-Auth-ID and X-Auth-Token headers - find your credentials in the Vobiz Console and secure them..
  • Send Message API — Send WhatsApp messages via the Vobiz REST API - text, images, video, audio, documents, stickers, and Meta-approved templates over a single endpoint
  • Channels API — Create, update, and remove WhatsApp Business channels on Vobiz - connect your WABA, manage display names, and rotate access tokens via REST API
  • Numbers API — Search and purchase WhatsApp-capable numbers on Vobiz, or verify and connect an existing number via BYON - OTP-based ownership verification included
  • Conversations API — Retrieve and paginate WhatsApp conversation threads on Vobiz - build inbox views, sync message history to your CRM, or audit logs with cursor-based..
  • Contacts API — Create, update, tag, and delete WhatsApp contacts on Vobiz, or import thousands of contacts at once via CSV bulk upload for campaign targeting
  • Templates API — Submit, manage, and sync WhatsApp Message Templates via the Vobiz API - Meta-approved formats required for all proactive business-initiated outbound..
  • Campaigns API — Create and manage WhatsApp broadcast campaigns on Vobiz - send bulk outbound messages via Meta-approved templates to segmented contact audiences at..
  • Canned responses API — Create and manage WhatsApp canned responses on Vobiz - reusable reply snippets that agents trigger with a /shortcut command directly inside the inbox
  • Calls API — Initiate and manage WhatsApp Business voice calls programmatically via Vobiz - WebRTC-based signaling for inbound, outbound, and call state..
  • Webhooks API — Manage Vobiz outbound webhook subscriptions and understand the inbound Meta callback - create, list, and delete subscriptions to receive WhatsApp..

​
Partner API

​
Overview & Flow

  • Vobiz Partner Portal – Reseller & White-Label telephony Program — Vobiz Partner Program gives resellers full API control over account provisioning, balance transfers, DID inventory, CDR access, and analytics..
  • Partner Integration Flow — Walk through a full Vobiz partner integration - provision a customer, transfer balance, complete KYC, create a SIP trunk, and monitor live CDRs..
  • Partner API Reference — Complete reference for the Vobiz Partner API - 21 endpoints across authentication, customer provisioning, billing, CDRs, DIDs, KYC sessions, and..

​
Endpoints

  • Partner API Authentication — Authenticate against the Vobiz Partner API using permanent X-Auth headers for server integrations or short-lived JWT tokens for interactive sessions
  • Partner Profile — Retrieve your Vobiz partner identity, billing configuration, GST status, and current balance - the authoritative source for your permanent partner ID..
  • Dashboard & Analytics — Access aggregated usage metrics and date-range analytics across your Vobiz reseller ecosystem - live dashboard summary and flexible reporting..
  • Customer Accounts — Provision, list, and manage SIP-enabled customer sub-accounts under your Vobiz partner account - each customer gets a unique auth_id for all..
  • Balance Transfer — Transfer credits from your Vobiz partner master wallet to a customer’s wallet - the primary mechanism for funding reseller sub-accounts with prepaid..
  • KYC Sessions — Initiate and manage Vobiz KYC verification sessions for sub-accounts under your partner umbrella - supports both async email-link delivery and..
  • Partner Transactions — Access detailed financial ledgers for every credit and debit event across your Vobiz reseller ecosystem - essential for monthly billing..
  • CDRs (Call History) — Fetch full call detail records for every voice session across your Vobiz partner ecosystem - filter by date, direction, or hangup cause for billing..
  • Phone Numbers (DIDs) — View and monitor DID phone number assignments for each customer in your Vobiz partner ecosystem - list per-customer numbers or get a global inventory..

​
Integrations

​
AI Voice Platforms

  • Vobiz Integrations & SDKs — Connect Vobiz to leading AI voice platforms globally - Vapi, Retell AI, ElevenLabs, LiveKit, Pipecat, Rapida AI, and more via SIP trunking, REST..
  • Vapi
    • Vapi integration (dashboard) — Connect Vapi to Vobiz SIP trunking without code - no-code dashboard walkthrough to receive inbound calls and make outbound calls in 130+ countries
    • Vapi integration (API) — Connect Vapi to Vobiz SIP trunking via API - route inbound calls to any Vapi AI assistant and place outbound calls to 130+ countries programmatically
  • Retell AI
    • Retell AI integration (dashboard) — Connect Retell AI to Vobiz SIP trunking without code - no-code dashboard setup for outbound and inbound AI voice calls in 130+ countries
    • Retell AI integration (API) — Connect Retell AI to Vobiz SIP trunking via API - programmatic outbound and inbound call routing for AI voice agents across 130+ countries
  • ElevenLabs
    • ElevenLabs integration — ElevenLabs connects to Vobiz SIP trunking for ultra-realistic AI voice calls - enable outbound and inbound calling in 130+ countries via dashboard or..
    • ElevenLabs integration (dashboard) — ElevenLabs connects to Vobiz SIP trunking without code - no-code dashboard setup for AI voice agents with ultra-realistic TTS voices in 130+..
    • ElevenLabs integration (API) — Connect ElevenLabs to Vobiz SIP trunking via API - programmatic setup for ultra-realistic AI voice agents on outbound and inbound calls in 130+..
  • LiveKit integration — LiveKit connects to Vobiz SIP trunking for real-time AI voice agents - inbound and outbound calling across 130+ countries with dispatch rules and..
  • Pipecat integration — Pipecat connects to Vobiz SIP trunking to power AI voice pipelines on real phone calls - WebSocket streaming and SIP trunk setup across 130+..
  • Bolna integration — Connect Bolna.ai voice agents to Vobiz SIP trunking for global inbound and outbound calling across 130+ countries, including India
  • Dograh integration — Connect Vobiz telephony to a self-hosted Dograh instance to place and receive AI voice-agent calls - Docker setup, telephony config, and the..
  • Rapida AI integration — Connect an open-source Rapida AI deployment to Vobiz for inbound and outbound AI phone calls using Vobiz applications, the REST API, and..
  • Ultravox Integration — Run Ultravox conversational AI over Vobiz SIP trunking - configure your trunk, dispatch outbound calls, and reach 130+ countries including India
  • Build an AI voice agent with WebSockets — Connect a custom AI voice agent to Vobiz with bidirectional WebSocket audio, direction-specific formats, playback, checkpoints, and barge-in
  • OpenAI Realtime SIP Call Handler — Connect inbound Vobiz SIP calls directly to OpenAI’s Realtime API for natural, low-latency AI voice conversations across 130+ countries including..
  • Vobiz WebRTC Playground — Make and receive browser-based phone calls with the Vobiz WebRTC Playground using your API credentials and a Vobiz DID

​
Official SDKs

  • Python SDK — Build Python voice apps with the Vobiz SDK - outbound calls, SIP trunking, VobizXML, and Flask webhook handlers for 130+ countries including India
  • Node.js SDK — Build Node.js and TypeScript voice apps with the Vobiz SDK - outbound calls, SIP trunks, CDR, and call recording across 130+ countries including..
  • Ruby SDK — Build Ruby and Rails voice apps with the Vobiz SDK - outbound calls, SIP trunks, DID management, and VobizXML for global calling in 130+ countries
  • Go SDK — Build Go voice apps with the Vobiz SDK - place outbound calls, manage SIP trunks, and craft VobizXML synchronously for 130+ countries including India
  • C# / .NET SDK — Build C# and .NET 8 voice apps with the Vobiz SDK - outbound calls, SIP trunks, and VobizXML with native DI for global calling in 130+ countries
  • Java SDK — Build Java voice apps with the Vobiz SDK - outbound calls, SIP trunks, CDR, and call recording across 130+ countries including India
  • PHP SDK — Build PHP voice apps with the Vobiz SDK - outbound calls, SIP trunks, CDR, and call recording across 130+ countries including India

​
Browser & WebRTC

​
Business Phone Systems

  • 3CX integration — Connect 3CX PBX to Vobiz SIP trunking for inbound and outbound calling across 130+ countries - configure a generic SIP trunk in minutes
  • Zoiper5 Integration — How to set up an XML application, create a SIP Endpoint, configure Zoiper5, and make an outbound call using Vobiz

​
Migrations

​
Examples & Tutorials

​
Guides

  • Build an AI Voice Agent — Connect leading conversational AI platforms - Vapi, Retell, ElevenLabs, Pipecat, LiveKit - directly to real phone numbers using Vobiz SIP trunking
  • Build an inbound AI voice agent — Set up an AI-powered inbound voice agent on Vobiz that answers incoming calls and routes audio to your agent platform over SIP trunking..
  • Build an outbound AI voice agent — Set up an AI-powered voice agent on Vobiz that places outbound calls - dial out from your agent platform over Vobiz SIP trunking with full control
  • Migrate from Plivo to Vobiz — Move your voice app from Plivo to Vobiz in hours, not weeks
  • Authentication & base URL — Migrate authentication and the API base URL from Plivo to Vobiz - swap the SDK package, switch raw HTTP to the X-Auth-ID and X-Auth-Token headers..
  • Endpoint & SDK mapping — Map every Plivo REST endpoint and SDK method to its Vobiz equivalent
  • Convert PlivoXML to VobizXML — Migrate your Plivo call-control XML to VobizXML
  • Webhooks & signature validation — Migrate your Plivo webhook handlers and signature verification to Vobiz - the params and the HMAC-SHA256 scheme are nearly identical, you mostly swap..
  • Gotchas & breaking changes — The handful of real breaking changes when migrating from Plivo to Vobiz - XML verb renames, path casing, required status params, webhook signatures..
  • Phone numbers (you can’t port from Plivo) — When migrating from Plivo to Vobiz you cannot port or transfer your Plivo numbers - there is no porting flow
  • Cutover checklist — An end-to-end runbook for moving a production Plivo voice app to Vobiz with minimal risk - swap creds, convert XML, re-point webhooks, canary..

​
LiveKit Templates

  • Call transfer agent — Transfer an active Vobiz call to any E.164 phone number via SIP REFER from inside a LiveKit AI voice agent - full code, payloads, and trunk setup
  • LiveKit IVR with DTMF — Build an IVR menu in a LiveKit AI voice agent on Vobiz that responds to DTMF keypad input in addition to spoken voice commands - Python example
  • Agent-to-agent handoff — Transfer an active Vobiz call from one LiveKit AI agent to a specialized agent mid-conversation while preserving full conversation context and..
  • Answering machine detection — Detect whether an outbound LiveKit call reached a human or a voicemail machine on Vobiz before your AI agent begins speaking - Python example
  • LiveKit all-features example — A single LiveKit agent example demonstrating inbound, outbound, transfers, DTMF, answering machine detection, and webhooks together on Vobiz
  • LiveKit webhook & CRM integration — Push Vobiz call events to your CRM in real time using HMAC-signed webhooks and LiveKit function tools - end-to-end Python example with sample..
  • LiveKit inbound calling — Route inbound calls from any Vobiz phone number to a LiveKit AI voice agent over SIP trunking with real-time audio streaming - Python example
  • LiveKit outbound calling — Place outbound calls from a LiveKit AI voice agent via a Vobiz SIP trunk, with per-call dispatch metadata and end-of-call webhooks - Python example

​
Server Templates

  • Vobiz + Pipecat — Stream raw Vobiz call audio into a Pipecat AI voice agent pipeline using WebSocket transport - covers trunk setup, Python code, and pipeline wiring
  • Bun Media Stream Server — Minimal Bun WebSocket server that receives Vobiz call audio, writes it to WAV, and logs status callbacks
  • Bare-metal XML WebSocket — Build a real-time AI voice agent on Vobiz using only the XML WebSocket streaming primitive - no LiveKit, no Pipecat, no third-party SDK required
  • IVR menu — Build a multi-level Interactive Voice Response menu on Vobiz with dynamic configuration, DTMF keypad routing, and call analytics tracking in Python
  • Call queue — Build a hold-music call queue on Vobiz featuring round-robin agent dispatch, configurable retry cycles, and voicemail fallback - Python and XML..
  • Call survey — Run an outbound three-question DTMF voice survey on Vobiz, store results via the API, and export responses to CSV - complete Python and XML example
  • Appointment reminder — Send outbound appointment reminder calls on Vobiz with confirm, reschedule, and cancel DTMF options - every outcome stored per appointment in Python
  • OTP call — Generate a six-digit OTP, place a Vobiz outbound call, read it digit by digit to the caller, and verify the response on your backend - Python example
  • Voicemail — Capture caller voice messages on Vobiz using the Record verb, store recordings as MP3, and retrieve them via the admin API - Python and XML example
  • Number capture — Collect a caller’s phone number on Vobiz via DTMF keypad input with the # terminator, validation, and duplicate detection in a Python XML example
  • Two-way number masking — Connect a field agent and a customer through two masking DIDs so neither sees the other’s real number, bidirectional call masking with FastAPI and..

​
Use Cases

  • Solutions — Build production-ready voice applications with Vobiz telephony platform
  • AI Voice Agent – Deploy 24/7 AI Phone Agents at Scale | Vobiz — Deploy 24/7 AI voice agents that handle real callers at scale
  • Cloud IVR — Build programmable cloud IVR on Vobiz with DTMF, speech recognition, and intelligent routing - no hardware, globally available across 130+ countries
  • Contact Centre — Build a fully custom contact centre on Vobiz - inbound routing, queuing, recording, and AI augmentation without per-seat CCaaS pricing, across 130+..
  • Conference Calling — Host multi-party calls with live moderation, recording, and coach mode
  • Automated Outbound Calling — Reach thousands of customers with personalised voice calls at scale
  • Appointment Reminders — Cut no-show rates with automated voice appointment reminders that confirm, reschedule, or cancel via keypad - deployed across 130+ countries
  • Call Recording — Capture, store, and analyse call audio for compliance, QA, and AI training
  • Number Masking — Connect two parties through proxy DIDs so neither sees the other’s real number, two-way call masking for ride-hailing, delivery, and marketplaces on..
  • Call Transfer — Move active calls between agents, teams, or IVRs on Vobiz globally - warm transfers, blind transfers, SIP REFER, and full context preservation
  • Call Escalation — Automatically route complex calls to senior handlers with full context intact
  • Agent-to-Agent Handoff — Transfer calls from AI to human agents without losing context - Vobiz carries full transcripts and call metadata through warm handoffs across 130+..
  • Post-Call Analytics — Turn every completed call into structured business intelligence using Vobiz CDR and recording APIs
  • CRM Integration — Eliminate manual call logging by auto-syncing every call, recording, and outcome to your CRM via Vobiz webhooks

​
Industries

  • Healthcare — Automate patient appointment booking, triage, reminders, and teleconsultation with Vobiz
  • Finance & Fintech — Scale collections, fraud alerts, and KYC onboarding with a compliant voice API built for fintech
  • Logistics & Delivery — Automate last-mile delivery confirmations, ETA alerts, and driver-customer coordination with Vobiz
  • E-commerce & Retail — Reduce RTO and recover revenue with automated COD confirmations, delivery alerts, and post-purchase surveys
  • Real Estate — Qualify leads and automate site-visit scheduling at scale with Vobiz - IVR routing, outbound call campaigns, and CRM integration for property..

​
Compare Platforms

​
Blogs

​
Blogs

  • Vobiz Blog — Guides, deep-dives, and product updates from the Vobiz team - voice AI engineering, telephony best practices, and platform announcements

​
Articles