# Vobiz ## Docs - [Documentation Project Instructions](https://docs.vobiz.ai/AGENTS.md): Guidance for AI agents and contributors working in this Mintlify documentation project: conventions, structure, and writing standards. - [Account](https://docs.vobiz.ai/account.md): Manage your Vobiz account programmatically - balance, concurrency, transactions, credentials, and pricing tier through the REST API. - [Phone Numbers](https://docs.vobiz.ai/account-phone-number.md): Manage phone numbers in your Vobiz account. List owned numbers, view inventory, purchase numbers, and release numbers back to inventory. - [The PhoneNumber Object](https://docs.vobiz.ai/account-phone-number/account-phone-number-object.md): The PhoneNumber object represents a Vobiz phone number with capabilities, billing, status, and assignment details for inbound and outbound calling. - [Bring Your Own Carrier (BYOC)](https://docs.vobiz.ai/account-phone-number/byoc.md): Integrate your existing telephony provider with Vobiz. Follow this step-by-step process to configure your carrier gateways and import your numbers. - [List Account Phone Numbers](https://docs.vobiz.ai/account-phone-number/list-account-phone-numbers.md): List all phone numbers on your account. - [List Inventory Numbers](https://docs.vobiz.ai/account-phone-number/list-inventory-numbers.md): Browse available phone numbers in inventory that are not assigned to any account. Only numbers with `status='active'` and `auth_id=NULL` are returned. These numbers are ready to be purchased. - [Purchase from Inventory](https://docs.vobiz.ai/account-phone-number/purchase-from-inventory.md): Purchase a phone number from inventory and assign it to your account. Debits your account balance for the setup fee and monthly fee. For sub-accounts (SA_), the parent master account (MA_) is charged. - [Release a Phone Number](https://docs.vobiz.ai/account-phone-number/unrent-number.md): Release a phone number from your account. - [The Account Object](https://docs.vobiz.ai/account/account-object.md): Reference for the Vobiz Account object - authentication credentials, pricing tier, verification status, contact details, and creation timestamps. - [Balance & Transactions](https://docs.vobiz.ai/account/balance.md): Retrieve the current account balance for a specific currency. - [Concurrency](https://docs.vobiz.ai/account/concurrency.md): Retrieve the current concurrent call usage and configured limits. - [Retrieve Account Details](https://docs.vobiz.ai/account/retrieve-account.md): Retrieve complete account details including pricing tier and credentials. - [Applications](https://docs.vobiz.ai/applications.md): Manage Vobiz Applications - a bundle of Answer, Hangup, and Message URLs that controls how incoming calls and messages on your numbers are routed. - [The Application Object](https://docs.vobiz.ai/applications/application-object.md): Reference for the Vobiz Application object: webhook URLs, HTTP methods, fallback behavior, and configuration for inbound call and message handling. - [Attach Number to Application](https://docs.vobiz.ai/applications/attach-number.md): 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. - [Create an Application](https://docs.vobiz.ai/applications/create-application.md): Creates an Application with webhook URLs for call handling. Creating an application is usually a first step, after which you attach the application to either a number or an endpoint. - [Delete an Application](https://docs.vobiz.ai/applications/delete-application.md): Permanently delete an Application. If the application is associated with phone numbers, the deletion may be blocked unless those associations are removed first. - [Detach Number from Application](https://docs.vobiz.ai/applications/detach-number.md): Remove the link between a phone number and a voice application. The number stays in your account inventory but no longer routes incoming calls to the app. - [List All Applications](https://docs.vobiz.ai/applications/list-all-applications.md): Get details of all applications created under your Vobiz account. - [Retrieve an Application](https://docs.vobiz.ai/applications/retrieve-application.md): Get details of a particular application by passing the app_id. - [Update an Application](https://docs.vobiz.ai/applications/update-application.md): Modify an application using this API. You can update any subset of fields (partial update). Fields not provided will remain unchanged. - [Audio Streams](https://docs.vobiz.ai/audio-streams.md): Stream real-time audio from active Vobiz calls over WebSocket to power transcription, sentiment analysis, AI voice agents, and live monitoring. - [List all Audio Streams](https://docs.vobiz.ai/audio-streams/list-audio-streams.md): List all audio streams on a live call. - [Retrieve an Audio Stream](https://docs.vobiz.ai/audio-streams/retrieve-audio-stream.md): Get details of a specific audio stream. - [Start an Audio Stream](https://docs.vobiz.ai/audio-streams/start-audio-stream.md): Start streaming raw audio from a live call to a WebSocket URL. - [Stop all Audio Streams](https://docs.vobiz.ai/audio-streams/stop-all-audio-streams.md): Stop every active audio stream currently running on a Vobiz call in a single request - useful for cleanup at call end or before transferring. - [Stop a Specific Audio Stream](https://docs.vobiz.ai/audio-streams/stop-audio-stream.md): Stop a specific audio stream on a live call. - [The Stream Object](https://docs.vobiz.ai/audio-streams/stream-object.md): Reference for the Vobiz audio Stream object: stream ID, status, track configuration, codec, WebSocket URL, bidirectional flags, and timestamps. - [Best Practices](https://docs.vobiz.ai/best-practices.md): Follow these recommendations for secure, reliable, and performant integrations with Vobiz. Learn from our experience and avoid common pitfalls. - [140 & 160 Series Number Acquisition Guide](https://docs.vobiz.ai/best-practices/140-160-acquisition.md): Process, documents, eligibility, and use-case scenarios for acquiring 140 and 160 series numbers on Vobiz - India, TRAI regulated, 2025 guidelines. - [1400 & 1600 Series Activation Guide](https://docs.vobiz.ai/best-practices/dlt-registration.md): Step-by-step DLT registration and compliance process for Vobiz 1400 and 1600 series numbers - header, template, and consent registration for India. - [Number Utilization Guide](https://docs.vobiz.ai/best-practices/number-utilization.md): Best practices to improve call connectivity, reduce spam flagging, and ensure regulatory compliance while using Vobiz infrastructure. - [The Call Object](https://docs.vobiz.ai/call/call-object.md): Reference for the Vobiz Call object - fields covering metadata, status, direction, duration, hangup cause, recording, and per-call billing details. - [DTMF](https://docs.vobiz.ai/call/dtmf.md): Send DTMF (keypad) tones on an active call. Use `w` for 0.5s pause, `W` for 1s pause. - [Send digits on an active call](https://docs.vobiz.ai/call/dtmf/send-digits.md): Send DTMF (keypad) tones on an active call. Use `w` for 0.5s pause, `W` for 1s pause. - [Hang Up a Call](https://docs.vobiz.ai/call/hangup-call.md): Terminate an active Vobiz call by its UUID-hang up the A-leg, the B-leg, or the entire bridged session through a single DELETE API call. - [Machine Detection](https://docs.vobiz.ai/call/machine-detection.md): Detect answering machines, voicemail, and human pickup on outbound Vobiz calls using synchronous or asynchronous AMD modes with callback delivery. - [Make an Outbound Call](https://docs.vobiz.ai/call/make-call.md): Initiate an outbound call to a PSTN number or SIP endpoint. Use `<` to separate multiple destinations (max 1000). - [Call Management Overview](https://docs.vobiz.ai/call/overview.md): Comprehensive control over voice calls, including making calls, call control operations, recording, playing audio, text-to-speech, and DTMF digit sending. - [Play audio on calls](https://docs.vobiz.ai/call/play-audio.md): 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](https://docs.vobiz.ai/call/play-audio/play-audio.md): Play an audio file to a live call leg. - [Stop playing audio on a call](https://docs.vobiz.ai/call/play-audio/stop-audio.md): Stop audio playing on a live call. - [Record calls](https://docs.vobiz.ai/call/record-calls.md): 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](https://docs.vobiz.ai/call/record-calls/start-recording.md): Begin recording an active call. Set format, enable transcription, and configure a callback URL. - [Stop recording a call](https://docs.vobiz.ai/call/record-calls/stop-recording.md): Stop an active recording on an in-progress call. - [Retrieve all live calls](https://docs.vobiz.ai/call/retrieve-all-live-calls.md): List the UUIDs of every active live call on your Vobiz account - useful for monitoring dashboards, capacity audits, and operational tooling. - [Retrieve all queued calls](https://docs.vobiz.ai/call/retrieve-all-queued-calls.md): List the UUIDs of every queued call on your Vobiz account that is waiting to be connected, for visibility into pending outbound dialer traffic. - [Retrieve a live call](https://docs.vobiz.ai/call/retrieve-live-call.md): Retrieve real-time details of a single active Vobiz call by UUID, including call state, direction, duration so far, and per-leg metadata. - [Retrieve a queued call](https://docs.vobiz.ai/call/retrieve-queued-call.md): Retrieve details of a single queued Vobiz call by UUID that is waiting to be connected, including queue position, destination, and timestamps. - [Speak text on calls](https://docs.vobiz.ai/call/speak-text.md): 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](https://docs.vobiz.ai/call/speak-text/speak-text.md): Convert text to speech and play it on a live call. - [Stop speaking text during a call](https://docs.vobiz.ai/call/speak-text/stop-speak.md): Stop ongoing TTS playback on a live call. - [Transfer a Call](https://docs.vobiz.ai/call/transfer-call.md): Transfer an in-progress Vobiz call to a different URL for new XML call-flow instructions - supports A-leg, B-leg, and full session transfers. - [Call Detail Records (CDR)](https://docs.vobiz.ai/cdr.md): Retrieve detailed call logs, billing summary, and per-call data - every CDR field returned by the live Vobiz API for billing and analytics. - [Export CDRs as CSV](https://docs.vobiz.ai/cdr/export-cdrs.md): Returns CDR data as a downloadable CSV file. Same filters as the list endpoint. - [Get Single CDR](https://docs.vobiz.ai/cdr/get-cdr.md): Retrieve the CDR for a specific completed call using its `call_id`. Useful when you have a `call_id` from a callback or previous API response. - [List CDRs](https://docs.vobiz.ai/cdr/list-cdrs.md): Returns all CDRs for your account. Supports filtering by phone numbers, date range, call direction, duration, and pagination. - [Recent CDRs](https://docs.vobiz.ai/cdr/recent-cdrs.md): Returns the most recent CDRs for your account without requiring a date range. Default 20 records; use `limit` to retrieve more. - [Search CDRs](https://docs.vobiz.ai/cdr/search-cdrs.md): Identical filters to the list endpoint, but the response also includes a `filter_summary` object describing the active filters applied. - [Changelog](https://docs.vobiz.ai/changelog.md): Track every release, deprecation, and breaking change to the Vobiz API, SDKs, dashboard, and platform features as they ship to production. - [Vobiz vs Exotel: voice API comparison for India 2025](https://docs.vobiz.ai/compare/vobiz-vs-exotel.md): Compare Vobiz and Exotel on pricing, API access, developer experience, and features. See why developers building voice apps in India switch to Vobiz. - [Vobiz vs JustCall: developer API vs business phone system](https://docs.vobiz.ai/compare/vobiz-vs-justcall.md): Vobiz vs JustCall - compare a developer voice API against a business phone system. Pricing, features, and use cases for Indian teams in 2025. - [Vobiz vs Plivo: Voice API Comparison for India 2025](https://docs.vobiz.ai/compare/vobiz-vs-plivo.md): Vobiz vs Plivo - compare pricing in INR, India phone numbers, support, and features. See why Vobiz is the better Plivo alternative for Indian developers. - [Vobiz vs TeleCRM: voice API vs sales CRM, India 2025](https://docs.vobiz.ai/compare/vobiz-vs-telecrm.md): Vobiz vs TeleCRM - when to pick a programmable voice API versus a sales CRM. Pricing, features, and the right fit for Indian sales teams in 2025. - [Vobiz vs Telnyx: voice API pricing and features in India](https://docs.vobiz.ai/compare/vobiz-vs-telnyx.md): Vobiz vs Telnyx - compare voice API pricing in INR, in-country PSTN, SIP trunking, and support for Indian developers and platform teams in 2025. - [Vobiz vs Twilio: Best Voice API for India in 2025](https://docs.vobiz.ai/compare/vobiz-vs-twilio.md): Compare Vobiz and Twilio for voice API, SIP trunking, and WhatsApp in India. INR pricing, features, support, and why Indian developers switch. - [Vobiz vs Vonage: voice API for India, pricing and features](https://docs.vobiz.ai/compare/vobiz-vs-vonage.md): Vobiz vs Vonage - voice API pricing in INR, in-country PSTN coverage, support quality, and the better fit for Indian developers building in 2025. - [India Calling Regulations](https://docs.vobiz.ai/compliance/india/calling-regulations.md): Regulatory requirements, eligibility rules, and compliance setup for domestic voice calling within India on Vobiz - DLT, KYC, and TRAI guidelines. - [India Number KYC](https://docs.vobiz.ai/compliance/india/kyc.md): Verify your identity or business to start renting Indian phone numbers. Our verification process is fully automated and takes less than 2 minutes. - [UCC Management](https://docs.vobiz.ai/compliance/india/ucc.md): How Vobiz handles Unsolicited Commercial Communication (UCC) complaints for Indian voice numbers, and what you need to do to avoid penalties. - [Concepts](https://docs.vobiz.ai/concepts.md): Learn core concepts and architectural patterns behind Vobiz telephony - calls, applications, trunks, callbacks, and SIP vs WebSocket connectivity. - [Callback Configurations](https://docs.vobiz.ai/concepts/callback-configurations.md): Configure callback URLs across Vobiz resources to receive real-time event notifications for calls, conferences, recordings, transcriptions, and more. - [Callbacks](https://docs.vobiz.ai/concepts/callbacks.md): Callbacks (webhooks) are HTTP requests Vobiz sends to your server to notify you about call, recording, and message events in real time. - [IP Address Whitelisting](https://docs.vobiz.ai/concepts/ip-whitelisting.md): Whitelist these IP addresses on your firewall to ensure uninterrupted SIP signaling, RTP media, and callback delivery between your infrastructure and Vobiz. - [SIP Trunking](https://docs.vobiz.ai/concepts/sip-trunking.md): SIP is the signaling standard behind nearly every modern phone call. Learn how SIP trunking on Vobiz powers AI voice agents and PBX integrations. - [SIP vs WebSockets](https://docs.vobiz.ai/concepts/sip-vs-websockets.md): Compare SIP and WebSocket architectures for connecting phone calls to AI voice agents - pick the right fit for latency, cost, and deployment speed. - [Voice XML Streaming WebSockets](https://docs.vobiz.ai/concepts/streaming-websockets.md): WebSocket audio streaming is the second major architecture for connecting phone calls to AI voice agents - and it is fundamentally different from SIP. - [The Conference Object](https://docs.vobiz.ai/conference/conference-object.md): Reference for the Vobiz Conference object - fields covering conference ID, name, active members, mute state, recording status, and timestamps. - [Hang Up All Conferences](https://docs.vobiz.ai/conference/hang-up-all-conferences.md): Terminate all active conference rooms. - [Hang Up a Conference](https://docs.vobiz.ai/conference/hang-up-conference.md): Terminate a specific conference room and disconnect all members. - [Conference Members](https://docs.vobiz.ai/conference/members.md): Control individual Vobiz conference members - mute, deaf, kick, hang up, and play audio or text to a single participant without affecting others. - [Deaf a Member](https://docs.vobiz.ai/conference/members/deaf-member.md): Prevent a conference member from hearing other participants. - [Hang up a member](https://docs.vobiz.ai/conference/members/hang-up-member.md): Disconnect a specific member from a conference. - [Kick a member](https://docs.vobiz.ai/conference/members/kick-member.md): Remove a specific participant from a conference call. - [Mute a Member](https://docs.vobiz.ai/conference/members/mute-member.md): Prevent a member from speaking. Use `all` as member_id to mute everyone. - [Play Audio to a Member](https://docs.vobiz.ai/conference/members/play-audio.md): Play an audio file to a specific conference member. - [Stop Playing Audio to a Member](https://docs.vobiz.ai/conference/members/stop-audio.md): Stop audio playback for a specific conference member. - [Undeaf a Member](https://docs.vobiz.ai/conference/members/undeaf-member.md): Restore a conference member's ability to hear other participants. - [Unmute a member](https://docs.vobiz.ai/conference/members/unmute-member.md): Allow a muted member to speak again. - [Conference recording](https://docs.vobiz.ai/conference/recording.md): Record Vobiz conference calls with optional speech-to-text transcription, custom file formats, callback delivery, and per-conference retention controls. - [Start conference recording](https://docs.vobiz.ai/conference/recording/start-recording.md): Begin recording all audio in a conference room. - [Stop conference recording](https://docs.vobiz.ai/conference/recording/stop-recording.md): Stop recording a conference room. - [List All Conferences](https://docs.vobiz.ai/conference/retrieve-all-conferences.md): Retrieve all active conference rooms on the account. - [Retrieve a Conference](https://docs.vobiz.ai/conference/retrieve-conference.md): Get details and member list of a specific conference room. - [Vobiz Docs Navigation Structure](https://docs.vobiz.ai/docs.md): Internal planning map of the Vobiz documentation site: five top-level tabs and how each existing page is grouped under them. - [Endpoint](https://docs.vobiz.ai/endpoint.md): Manage SIP endpoints on Vobiz for making and receiving calls from IP phones, mobile SIP clients, softphones, and any SIP-compliant device. - [Create an Endpoint](https://docs.vobiz.ai/endpoint/create-endpoint.md): Create a new SIP endpoint that can be used to make and receive calls through IP phones, softphones, or SIP clients. Each endpoint is assigned a unique SIP URI and endpoint ID. - [Delete an Endpoint](https://docs.vobiz.ai/endpoint/delete-endpoint.md): Permanently delete an endpoint from your Vobiz account. Once deleted, the SIP URI will no longer be accessible, and any devices registered with this endpoint will be disconnected. - [The Endpoint Object](https://docs.vobiz.ai/endpoint/endpoint-object.md): Reference for the Vobiz SIP Endpoint object schema-username, password, alias, attached application, registration status, and timestamp fields. - [List all Endpoints](https://docs.vobiz.ai/endpoint/list-all-endpoints.md): Retrieve a paginated list of all SIP endpoints in your account. - [Retrieve an Endpoint](https://docs.vobiz.ai/endpoint/retrieve-endpoint.md): Retrieve the details of an existing endpoint. The response includes all endpoint attributes and, if the endpoint is currently registered on a SIP client, additional registration details. - [Update an Endpoint](https://docs.vobiz.ai/endpoint/update-endpoint.md): Update an existing endpoint's configuration. You can change the password, alias, or attached application. The fields `username`, `endpoint_id`, `domain`, `allow_same_domain`, `allow_other_domains`, `allow_phones`, and `allow_apps` are locked after creation. - [Error Handling](https://docs.vobiz.ai/errors.md): Understand Vobiz API error responses, HTTP status codes, error payload shapes, and how to handle common error scenarios in your integration. - [LiveKit all-features example](https://docs.vobiz.ai/examples/livekit-vobiz-all-feature-example.md): A single LiveKit agent example demonstrating inbound, outbound, transfers, DTMF, answering machine detection, and webhooks together on Vobiz. - [LiveKit inbound calling](https://docs.vobiz.ai/examples/livekit-vobiz-inbound.md): Accept inbound calls on a Vobiz phone number and route them to a LiveKit AI voice agent over SIP trunking with full audio streaming. - [Answering machine detection](https://docs.vobiz.ai/examples/livekit-vobiz-machine-detection-agent-example.md): Detect whether an outbound LiveKit call was answered by a human or a voicemail machine on Vobiz before the AI agent begins speaking. - [LiveKit outbound calling](https://docs.vobiz.ai/examples/livekit-vobiz-outbound.md): Make outbound calls from a LiveKit AI voice agent through a Vobiz SIP trunk, with per-call dispatch metadata and end-of-call webhooks. - [LiveKit webhook & CRM integration](https://docs.vobiz.ai/examples/livekit-vobiz-webhook-integration-example.md): Stream Vobiz call events to your CRM in real time using webhooks and LiveKit function tools - end-to-end example with sample payloads. - [Bare-metal XML WebSocket](https://docs.vobiz.ai/examples/vobiz-all-xml.md): Build a real-time AI voice agent on Vobiz using only the XML streaming primitive - no LiveKit or Pipecat required. Pure WebSocket example. - [Appointment reminder](https://docs.vobiz.ai/examples/vobiz-appointment-reminder-xml-python.md): Outbound appointment reminder call on Vobiz with confirm, reschedule, and cancel DTMF options - every outcome stored per appointment in Python. - [Call queue](https://docs.vobiz.ai/examples/vobiz-call-queue-xml-python.md): Build a hold-music call queue on Vobiz with round-robin agent dispatch, retry cycles, and voicemail fallback - Python and XML example. - [Call survey](https://docs.vobiz.ai/examples/vobiz-call-survey-xml-python.md): Run an outbound three-question DTMF survey on Vobiz with results stored via the API and exported to CSV-complete Python and XML example. - [IVR menu](https://docs.vobiz.ai/examples/vobiz-ivr-xml-python.md): Build a multi-level Interactive Voice Response menu on Vobiz with dynamic configuration, DTMF input, and call analytics in Python. - [Agent-to-agent handoff](https://docs.vobiz.ai/examples/vobiz-livekit-agent-to-agent-handoff-example.md): Transfer an active Vobiz call from one LiveKit AI agent to another specialized agent mid-conversation, preserving full context and history. - [Call transfer agent](https://docs.vobiz.ai/examples/vobiz-livekit-call-transfer-example.md): Transfer an active Vobiz call to any E.164 phone number via SIP REFER from inside a LiveKit AI voice agent - code, payloads, and trunk setup. - [LiveKit IVR with DTMF](https://docs.vobiz.ai/examples/vobiz-livekit-ivr-dtmf-example.md): 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. - [Number capture](https://docs.vobiz.ai/examples/vobiz-number-capture-xml-python.md): Collect a caller's phone number on Vobiz via DTMF keypad input with the # terminator, validation, and duplicate detection in a Python XML example. - [OTP call](https://docs.vobiz.ai/examples/vobiz-otp-call-xml-python.md): Generate a six-digit OTP, place a call on Vobiz, read it digit by digit, and verify the response on your backend - Python and XML example. - [Voicemail](https://docs.vobiz.ai/examples/vobiz-voicemail-xml-python.md): Capture caller voice messages on Vobiz, store the recording, and retrieve it later via the admin API - full Python and XML voicemail example. - [Vobiz + Pipecat](https://docs.vobiz.ai/examples/vobiz-x-pipecat.md): Stream raw Vobiz call audio into a Pipecat AI voice agent pipeline using WebSocket transport - example covering trunk setup and Python code. - [Frequently Asked Questions](https://docs.vobiz.ai/faq.md): Quick answers to common questions about Vobiz accounts, billing, API limits, concurrency, integrations, SIP trunking, and developer support. - [Is call transfer supported?](https://docs.vobiz.ai/faq/call-transfer.md): The three supported call transfer methods on Vobiz - the Dial XML tag, REST API live transfer, and SIP REFER (RFC 3515) - with when to use each. - [What is Concurrency?](https://docs.vobiz.ai/faq/concurrency.md): Concurrency on Vobiz is the maximum number of simultaneous active calls on your account - learn how it works and how to size it for your dialer. - [How can I contact support?](https://docs.vobiz.ai/faq/contact-support.md): Reach the Vobiz engineering and success teams for API integration help, network debugging, capacity upgrades, and billing inquiries. - [What is CPS (Calls Per Second)?](https://docs.vobiz.ai/faq/cps.md): CPS on Vobiz is the rate limit on call initiation, independent of concurrency - learn why it matters and how to pace your outbound dialer correctly. - [Domestic Calling in India](https://docs.vobiz.ai/faq/domestic-calling-india.md): Why domestic calling is the preferred choice for IN-to-IN traffic on Vobiz, plus caller-ID, media anchoring, and KYC requirements for India. - [Why am I receiving a 429 error?](https://docs.vobiz.ai/faq/error-429.md): Identify whether a 429 Too Many Requests response from Vobiz is caused by a concurrency limit or a CPS limit, and learn the steps to resolve each. - [What integrations do you support?](https://docs.vobiz.ai/faq/integrations.md): Supported AI voice agent platforms, WebRTC stacks, and SIP-interoperable PBX systems that work natively on the Vobiz telephony network. - [Do you support IVR?](https://docs.vobiz.ai/faq/ivr.md): Build dynamic Interactive Voice Response menus on Vobiz using Gather, Speak, Play, and SIP transfer XML primitives - including code examples. - [Do you provide 1400, 1600, and 92 series numbers?](https://docs.vobiz.ai/faq/number-series.md): Availability of premium short-code, multi-channel, 140, 160, and 92-series mobile numbers on Vobiz for India - eligibility and provisioning timelines. - [Can I purchase additional Concurrency or CPS?](https://docs.vobiz.ai/faq/purchase-concurrency-cps.md): Step-by-step guide to upgrading your Vobiz account's concurrency and calls-per-second limits through the dashboard, plus pricing considerations. - [Why am I receiving SIP response codes 480 or 486?](https://docs.vobiz.ai/faq/sip-codes-480-486.md): Understand SIP 480 Temporarily Unavailable and 486 Busy Here response codes on Vobiz, and how to debug carrier-level spam blocks and call rejections. - [Can I connect my trial number for inbound calls?](https://docs.vobiz.ai/faq/trial-inbound.md): Why Vobiz trial numbers are restricted to outbound testing and the verification steps to unlock inbound call routing on a fully verified account. - [What documents are required for verification?](https://docs.vobiz.ai/faq/verification-docs.md): KYC document requirements for organizations and individuals registering on Vobiz, plus our data privacy commitments and India compliance details. - [Build an AI Voice Agent](https://docs.vobiz.ai/guides/ai-voice-agent.md): 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](https://docs.vobiz.ai/guides/ai-voice-agent/inbound.md): Set up an AI-powered voice agent on Vobiz that answers incoming calls - route inbound traffic to your agent platform over SIP trunking. - [Build an outbound AI voice agent](https://docs.vobiz.ai/guides/ai-voice-agent/outbound.md): 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. - [Integrations & SDKs](https://docs.vobiz.ai/integrations.md): Connect Vobiz to leading AI voice platforms, build with official SDKs, and integrate with your existing stack over SIP trunking and REST APIs. - [Bolna integration](https://docs.vobiz.ai/integrations/bolna.md): Integrate Bolna.ai with Vobiz SIP trunking to give your conversational AI voice agents global calling capabilities - inbound and outbound. - [C# / .NET SDK](https://docs.vobiz.ai/integrations/csharp-sdk.md): Build voice apps in C# and .NET 8 with Vobiz's official SDK - make outbound calls, manage SIP trunks, and orchestrate VobizXML using native DI. - [ElevenLabs integration](https://docs.vobiz.ai/integrations/elevenlabs.md): Use ElevenLabs ultra-realistic AI voices with Vobiz for outbound and inbound calling - connect via the dashboard or programmatically via the API. - [ElevenLabs integration (API)](https://docs.vobiz.ai/integrations/elevenlabs-api.md): Connect Vobiz to ElevenLabs via the API for AI voice agents that use premium ultra-realistic TTS voices on outbound and inbound calls. - [ElevenLabs integration (dashboard)](https://docs.vobiz.ai/integrations/elevenlabs-dashboard.md): Connect Vobiz to ElevenLabs via the dashboard for AI voice agents with premium TTS voices - no-code setup for outbound and inbound calling. - [Go SDK](https://docs.vobiz.ai/integrations/go-sdk.md): Build voice apps in Go with Vobiz's official SDK - place outbound calls, manage SIP trunks, and craft VobizXML synchronously from any Go service. - [LiveKit integration](https://docs.vobiz.ai/integrations/livekit.md): Connect LiveKit AI voice agents to Vobiz SIP trunking for inbound and outbound calling - covers trunk setup, dispatch rules, and call routing. - [Node.js SDK](https://docs.vobiz.ai/integrations/node-sdk.md): Build voice apps in Node.js or TypeScript with Vobiz's official SDK - outbound calls, SIP trunks, CDR fetches, and call recording from one client. - [OpenAI Realtime SIP Call Handler](https://docs.vobiz.ai/integrations/openai-realtime.md): Connect inbound Vobiz SIP calls directly to OpenAI's Realtime API for natural, low-latency AI voice conversations on any Vobiz phone number. - [Pipecat integration](https://docs.vobiz.ai/integrations/pipecat.md): Build AI-powered phone calls using Pipecat and Vobiz telephony infrastructure - WebSocket streaming, voice pipelines, and SIP trunk configuration. - [Python SDK](https://docs.vobiz.ai/integrations/python-sdk.md): Build voice apps in Python with Vobiz's official SDK - supports outbound calls, SIP trunking, VobizXML, and Flask webhook handlers out of the box. - [Retell AI integration (API)](https://docs.vobiz.ai/integrations/retellai-api.md): Connect Retell AI voice agents to Vobiz via the API for outbound and inbound calling - programmatic SIP trunk creation and call routing. - [Retell AI integration (dashboard)](https://docs.vobiz.ai/integrations/retellai-dashboard.md): Connect Retell AI voice agents to Vobiz via the dashboard for outbound and inbound calling - no-code setup of SIP trunks and call routing. - [Ruby SDK](https://docs.vobiz.ai/integrations/ruby-sdk.md): Build voice apps in Ruby and Rails with Vobiz's official SDK - outbound calls, SIP trunks, DID management, and VobizXML in idiomatic Ruby. - [Ultravox Integration](https://docs.vobiz.ai/integrations/ultravox.md): Set up outbound calls using Ultravox conversational AI on Vobiz SIP infrastructure - trunk configuration, dispatch, and Python code samples. - [Vapi integration (API)](https://docs.vobiz.ai/integrations/vapi-api.md): Receive inbound calls on your Vobiz phone number and route them to your Vapi AI assistant - every step configured programmatically via the API. - [Vapi integration (dashboard)](https://docs.vobiz.ai/integrations/vapi-dashboard.md): Receive inbound calls on your Vobiz phone number and have them answered by your Vapi AI assistant - no-code dashboard setup walkthrough. - [Browser Calling with Vobiz WebRTC](https://docs.vobiz.ai/integrations/webrtc-application-setup.md): Set up a Vobiz Voice Application for WebRTC browser calling - configure Answer URLs, attach a phone number, and prepare your backend to return VobizXML. - [Vobiz AI Voice Agent via WebSockets](https://docs.vobiz.ai/integrations/websockets.md): Build custom AI voice agents on Vobiz using raw WebSocket audio streams - covers the XML protocol, PCM transformations, and a Python reference server. - [Introduction](https://docs.vobiz.ai/introduction.md): SIP trunking built for AI voice agents - native integrations with Vapi, Retell, LiveKit, and ElevenLabs. Pay per minute, first call in 5 minutes. - [Partner Portal](https://docs.vobiz.ai/partner.md): The Vobiz Partner Program gives resellers programmatic control over account provisioning, balance, DID inventory, CDR access, and analytics. - [Partner API Reference](https://docs.vobiz.ai/partner/api.md): Complete reference for the Vobiz Partner API - 16 endpoints across authentication, customer provisioning, billing, CDRs, DIDs, and analytics for resellers. - [Dashboard & Analytics](https://docs.vobiz.ai/partner/api/analytics.md): Aggregated partner metrics - total customers, active accounts, balance held across the partner ecosystem, MTD revenue, etc. - [Authentication](https://docs.vobiz.ai/partner/api/authentication.md): Authenticate against the Vobiz Partner API using permanent X-Auth headers for server integrations or short-lived JWT tokens for interactive sessions. - [Balance Transfer](https://docs.vobiz.ai/partner/api/balance.md): Atomically debits your partner master balance and credits the customer's wallet. Both legs are recorded in each account's ledger. Transfers are **permanent and cannot be reversed.** - [CDRs (Call History)](https://docs.vobiz.ai/partner/api/cdrs.md): Look up any customer's call history. Same filter set as the customer-side CDR endpoint. - [Customer Accounts](https://docs.vobiz.ai/partner/api/customers.md): Returns all customer sub-accounts under your partner account. - [Phone Numbers (DIDs)](https://docs.vobiz.ai/partner/api/numbers.md): Phone numbers currently assigned to a customer account. - [Profile](https://docs.vobiz.ai/partner/api/profile.md): Returns the authenticated partner's profile and balance. - [Transactions](https://docs.vobiz.ai/partner/api/transactions.md): Returns the customer's transaction ledger. Filter by date range or transaction type. Useful for billing reconciliation. - [Example Flow](https://docs.vobiz.ai/partner/flow.md): Walk through a complete Vobiz partner integration - provision a customer, transfer balance, run KYC, create a SIP trunk, and monitor live CDRs end-to-end. - [Quick Start](https://docs.vobiz.ai/quick-start.md): Get from zero to your first Vobiz call in minutes - pick your path (AI agent, SIP trunk, or XML) and follow the steps tailored to your build. - [Recording](https://docs.vobiz.ai/recording.md): Manage Vobiz call and conference recordings - list, retrieve, download, bulk delete, and export with email delivery for compliance and QA. - [Bulk Delete Recordings](https://docs.vobiz.ai/recording/bulk-delete-recordings.md): Delete many Vobiz recordings at once that match filter criteria - async operation returns a job ID for progress tracking and completion callback. - [Delete a Recording](https://docs.vobiz.ai/recording/delete-recording.md): Permanently delete a recording from the account. - [Download a Recording](https://docs.vobiz.ai/recording/download-recording.md): Programmatically download Vobiz recording files and resolve common authentication issues during playback - example code and troubleshooting tips. - [Export Historical Recordings](https://docs.vobiz.ai/recording/export-historical-recordings.md): Export Vobiz recordings matching filter criteria as a downloadable archive sent via email - async job for bulk historical data delivery. - [List All Recordings](https://docs.vobiz.ai/recording/list-all-recordings.md): Retrieve all call recordings on the account. - [The Recording Object](https://docs.vobiz.ai/recording/recording-object.md): Reference for the Vobiz Recording object - fields covering recording ID, URL, file format, duration, source call UUID, and transcription status. - [Retrieve a Recording](https://docs.vobiz.ai/recording/retrieve-recording.md): Get details and download URL for a specific recording. - [CPS & Cost Calculator](https://docs.vobiz.ai/resources/calculator.md): Estimate Calls Per Second, simultaneous concurrency, and capacity requirements for your voice campaigns. Live calculator built into the page. - [Solutions](https://docs.vobiz.ai/solutions.md): Discover how teams build with Vobiz - use cases, industry solutions, platform comparisons, and developer templates for voice and WhatsApp. - [Agent-to-Agent Handoff](https://docs.vobiz.ai/solutions/agent-to-agent-handoff.md): Connect AI voice agents to human experts on Vobiz instantly, passing full conversation transcripts and customer context for seamless handoffs. - [AI Voice Agent](https://docs.vobiz.ai/solutions/ai-voice-agent.md): Deploy 24/7 natural spoken conversation bots on Vobiz that understand intent and respond with ultra-low latency - built for inbound and outbound. - [Appointment Reminders](https://docs.vobiz.ai/solutions/appointment-reminders.md): Drastically reduce no-show rates on Vobiz with automated, interactive appointment confirmation calls - confirm, reschedule, or cancel via DTMF. - [Automated Outbound Calling](https://docs.vobiz.ai/solutions/automated-outbound-calling.md): Initiate up to 1000 simultaneous outbound calls on Vobiz for notifications, alerts, OTPs, surveys, and promotional broadcast campaigns at scale. - [Call Escalation](https://docs.vobiz.ai/solutions/call-escalation.md): Establish structured safety nets on Vobiz that automatically route urgent or complex calls to senior handlers - preserves context and call history. - [Call Recording](https://docs.vobiz.ai/solutions/call-recording.md): Capture, store, and analyze Vobiz call audio for compliance, quality assurance, training, dispute resolution, and conversation intelligence. - [Call Transfer](https://docs.vobiz.ai/solutions/call-transfer.md): Seamlessly move active Vobiz calls between agents, teams, or IVRs with full conversation context preservation and SIP REFER support. - [Cloud IVR](https://docs.vobiz.ai/solutions/cloud-ivr.md): Build intelligent programmable voice menus on Vobiz that qualify and route callers without human intervention - DTMF, speech, and routing logic. - [Conference Calling](https://docs.vobiz.ai/solutions/conference-calling.md): Assemble multi-party meetings on Vobiz programmatically with granular control over moderation, monitoring, recording, and per-member audio. - [Contact Centre](https://docs.vobiz.ai/solutions/contact-centre.md): Build a fully customizable programmable call centre on Vobiz using our carrier-grade building blocks - queueing, routing, recording, and analytics. - [CRM Integration](https://docs.vobiz.ai/solutions/crm-integration.md): Auto-log Vobiz calls, recordings, and outcomes directly into your CRM without manual data entry - webhooks, Salesforce, HubSpot, and Zoho ready. - [E-commerce & Retail](https://docs.vobiz.ai/solutions/ecommerce-retail.md): Reduce RTO on Vobiz with automated COD confirmation calls and build customer loyalty through post-purchase surveys and delivery notifications. - [Finance & Fintech](https://docs.vobiz.ai/solutions/finance-fintech.md): Secure, compliant Vobiz voice solutions for fintech - collections, fraud alerts, KYC onboarding, and OTP delivery on a TRAI-aligned platform. - [Healthcare](https://docs.vobiz.ai/solutions/healthcare.md): Transform patient communication on Vobiz with automated booking, triage, appointment reminders, and remote consultation voice infrastructure. - [Logistics & Delivery](https://docs.vobiz.ai/solutions/logistics-delivery.md): Coordinate drivers and customers in real time on Vobiz with automated delivery notification calls, ETA updates, and last-mile confirmation flows. - [Post-Call Analytics](https://docs.vobiz.ai/solutions/post-call-analytics.md): Extract actionable insights from Vobiz call volume, duration, and outcomes using the CDR and recording APIs - feed BI tools and ML pipelines. - [Real Estate](https://docs.vobiz.ai/solutions/real-estate.md): Scale lead qualification on Vobiz and automate site-visit coordination for developers and brokers - outbound calling, IVR, and CRM integration. - [Sub-Accounts](https://docs.vobiz.ai/sub-accounts.md): Manage multiple customer accounts using Vobiz subaccounts - segment, manage, and track usage and billing independently per end customer or team. - [Create a Subaccount](https://docs.vobiz.ai/sub-accounts/create-subaccount.md): Create a new sub-account under the master account. - [Delete a Subaccount](https://docs.vobiz.ai/sub-accounts/delete-subaccount.md): Permanently delete a sub-account and revoke its credentials. - [List All Subaccounts](https://docs.vobiz.ai/sub-accounts/list-all-subaccounts.md): Retrieve all sub-accounts under the master account. - [Retrieve a Subaccount](https://docs.vobiz.ai/sub-accounts/retrieve-subaccount.md): Retrieve details of a specific sub-account. - [The Subaccount Object](https://docs.vobiz.ai/sub-accounts/subaccount-object.md): Reference for the Vobiz Subaccount object - authentication credentials, permissions, rate limits, and isolation under a parent Vobiz account. - [Update a Subaccount](https://docs.vobiz.ai/sub-accounts/update-subaccount.md): Update the name or status of a sub-account. - [SIP Trunk Service](https://docs.vobiz.ai/trunks.md): Manage SIP trunks on Vobiz for enterprise voice - automatic SIP domain provisioning, authentication, outbound routing, and scalable infrastructure. - [Assign Number to Trunk](https://docs.vobiz.ai/trunks/assign-number.md): Assign a phone number to a specific SIP trunk. Once assigned, all inbound calls to that phone number will be routed through the designated trunk. The phone number must be URL-encoded; use `%2B` instead of `+` (e.g., `%2B912271264217`). - [Create a Trunk](https://docs.vobiz.ai/trunks/create-trunk.md): Create a new SIP trunk for inbound or outbound calling. - [Credentials](https://docs.vobiz.ai/trunks/credentials.md): Manage SIP credentials for username and password authentication on your Vobiz trunks - create, list, rotate, and revoke credentials per trunk. - [Create Credential](https://docs.vobiz.ai/trunks/credentials/create-credential.md): Create SIP credentials for trunk authentication. - [The Credential Object](https://docs.vobiz.ai/trunks/credentials/credential-object.md): Reference for the Vobiz SIP Credential object - username, password reference, attached trunk, creation timestamp, and status fields. - [Delete Credential](https://docs.vobiz.ai/trunks/credentials/delete-credential.md): Delete an existing SIP credential. - [Retrieve All Credentials](https://docs.vobiz.ai/trunks/credentials/retrieve-all-credentials.md): Retrieve all SIP credentials on the account. - [Update Credential](https://docs.vobiz.ai/trunks/credentials/update-credential.md): Update the password for an existing SIP credential. - [Delete a Trunk](https://docs.vobiz.ai/trunks/delete-trunk.md): Permanently delete a SIP trunk. - [IP Access Control Lists](https://docs.vobiz.ai/trunks/ip-acl.md): Manage IP-based authentication for your Vobiz SIP trunks using IPv4 whitelisting - restrict trunk access to known PBX and softswitch addresses. - [Create IP ACL](https://docs.vobiz.ai/trunks/ip-acl/create-ip-acl.md): Add an IP access control rule to restrict SIP trunk access. - [Delete IP ACL](https://docs.vobiz.ai/trunks/ip-acl/delete-ip-acl.md): Remove an IP access control rule. - [The IP ACL Object](https://docs.vobiz.ai/trunks/ip-acl/ip-acl-object.md): Reference for the Vobiz IP Access Control List object - IPv4 address, attached trunk, description, creation timestamp, and active flag. - [Retrieve All IP ACLs](https://docs.vobiz.ai/trunks/ip-acl/retrieve-all-ip-acls.md): Retrieve all IP access control rules on the account. - [Update IP ACL](https://docs.vobiz.ai/trunks/ip-acl/update-ip-acl.md): Update an existing IP access control rule. - [Origination URIs](https://docs.vobiz.ai/trunks/origination-uri.md): Configure outbound SIP routing destinations on your Vobiz trunk - origination URIs control where the trunk delivers inbound traffic for termination. - [Create Origination URI](https://docs.vobiz.ai/trunks/origination-uri/create-origination-uri.md): Add an inbound SIP endpoint (origination URI) to a trunk. - [Delete Origination URI](https://docs.vobiz.ai/trunks/origination-uri/delete-origination-uri.md): Delete an origination URI from a trunk. - [The Origination URI Object](https://docs.vobiz.ai/trunks/origination-uri/origination-uri-object.md): Reference for the Vobiz Origination URI object - SIP URI, weight, priority, transport, attached trunk, and active routing status fields. - [Retrieve All Origination URIs](https://docs.vobiz.ai/trunks/origination-uri/retrieve-all-origination-uris.md): Retrieve all origination URIs on the account. - [Update Origination URI](https://docs.vobiz.ai/trunks/origination-uri/update-origination-uri.md): Update an existing origination URI. - [Retrieve All Trunks](https://docs.vobiz.ai/trunks/retrieve-all-trunks.md): Retrieve all SIP trunks configured on the account. - [Retrieve a Trunk](https://docs.vobiz.ai/trunks/retrieve-trunk.md): Get details of a specific SIP trunk. - [The Trunk Object](https://docs.vobiz.ai/trunks/trunk-object.md): Reference for the Vobiz SIP Trunk object - SIP domain, authentication mode, credentials, IP ACLs, origination URIs, and attached numbers. - [Unassign Number from Trunk](https://docs.vobiz.ai/trunks/unassign-number.md): Remove the assignment between a phone number and a SIP trunk. After unassignment, the number remains in your account inventory but will no longer route inbound calls through the previously assigned trunk. URL-encode the phone number (use `%2B` instead of `+`). - [Update a Trunk](https://docs.vobiz.ai/trunks/update-trunk.md): Update a SIP trunk's name, configuration, or status. - [Trunk Webhooks](https://docs.vobiz.ai/trunks/webhook.md): Configure HTTP webhooks on Vobiz SIP trunks to receive real-time callbacks when calls are admitted, rejected, or end with full call quality details. - [API Reference](https://docs.vobiz.ai/whatsapp/api.md): The Vobiz WhatsApp API lets you programmatically send messages, manage contacts, run campaigns, and integrate WhatsApp into your applications. - [API Authentication](https://docs.vobiz.ai/whatsapp/api/authentication.md): Learn how to authenticate your requests to the Vobiz API using header-based authentication with Auth ID and Auth Token credentials. - [Calls API](https://docs.vobiz.ai/whatsapp/api/calls.md): Initiate and manage WhatsApp voice calls programmatically on Vobiz using WebRTC-based signaling - inbound, outbound, and call state management. - [Campaigns API](https://docs.vobiz.ai/whatsapp/api/campaigns.md): Create and manage WhatsApp broadcast campaigns on Vobiz - bulk outbound messages sent via Meta-approved templates to a segmented audience list. - [Canned responses API](https://docs.vobiz.ai/whatsapp/api/canned-responses.md): Manage saved WhatsApp reply shortcuts for your Vobiz support agents - reusable message snippets triggered by a /shortcut command in the inbox. - [Channels API](https://docs.vobiz.ai/whatsapp/api/channels.md): Manage your WhatsApp Business channels - create connections to your WABA, update display names or access tokens, and remove channels. - [Contacts API](https://docs.vobiz.ai/whatsapp/api/contacts.md): Manage your WhatsApp contact list on Vobiz - create, update, tag, and delete contacts individually or import contacts in bulk from a CSV upload. - [Conversations API](https://docs.vobiz.ai/whatsapp/api/conversations.md): Retrieve WhatsApp conversation threads on Vobiz and paginate through individual messages to build inbox views, sync to CRM, or audit message logs. - [Numbers API](https://docs.vobiz.ai/whatsapp/api/numbers.md): Search for available WhatsApp-capable numbers on Vobiz, purchase new ones, or verify and connect an existing number through BYON (bring your own number). - [Send Message API](https://docs.vobiz.ai/whatsapp/api/send-message.md): Send WhatsApp messages programmatically on Vobiz - text, images, video, documents, and approved template messages over a single REST endpoint. - [Templates API](https://docs.vobiz.ai/whatsapp/api/templates.md): Manage and send WhatsApp Message Templates on Vobiz - Meta-approved message formats required for proactive business-initiated outbound messages. - [Webhooks API](https://docs.vobiz.ai/whatsapp/api/webhooks.md): Configure webhook endpoints on Vobiz to receive real-time WhatsApp events from both Meta and Vobiz for your messaging integration and CRM sync. - [Channel Management](https://docs.vobiz.ai/whatsapp/channels.md): 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](https://docs.vobiz.ai/whatsapp/channels/byon.md): Connect your existing WhatsApp Business number to Vobiz using the BYON (bring your own number) method - full setup guide with screenshots and steps. - [Introduction to WhatsApp Business](https://docs.vobiz.ai/whatsapp/getting-started/introduction.md): Learn how the WhatsApp Business API differs from the consumer app, and why Vobiz pairs it with templates, webhooks, and a no-code campaign builder. - [Prerequisites](https://docs.vobiz.ai/whatsapp/getting-started/prerequisites.md): Before you can start using WhatsApp Business with Vobiz, you'll need to set up a few things. This guide will walk you through all the requirements. - [Quick Start Guide](https://docs.vobiz.ai/whatsapp/getting-started/quick-start.md): Get up and running with Vobiz WhatsApp Business in under 5 minutes - connect your first channel and send messages via console and API examples. - [WhatsApp Messaging](https://docs.vobiz.ai/whatsapp/messaging.md): 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](https://docs.vobiz.ai/whatsapp/messaging/inbox.md): The Vobiz inbox unifies WhatsApp conversations across every channel - send messages, view conversation history, and respond to customers in real time. - [WhatsApp Message Templates](https://docs.vobiz.ai/whatsapp/messaging/templates.md): WhatsApp message templates on Vobiz are pre-approved formats required to start conversations outside the 24-hour messaging window - Meta-approved. - [WhatsApp Webhooks](https://docs.vobiz.ai/whatsapp/webhooks.md): Receive real-time WhatsApp event notifications on Vobiz directly to your application - webhooks power CRM sync, automation, and customer workflows. - [Webhook Events Reference](https://docs.vobiz.ai/whatsapp/webhooks/events.md): Complete reference for every webhook event sent by Vobiz for WhatsApp, including payload structures, sample data, and triggers for each event type. - [XML Builder](https://docs.vobiz.ai/xml-builder.md): Compose Vobiz Voice XML visually - pick verbs, order them, and configure each one. Live preview of generated XML updates as you build the call flow. - [The Conference Element](https://docs.vobiz.ai/xml/conference.md): Connect the caller to a conference room. Multiple callers can join the same conference to participate in a group call. - [The Dial Element](https://docs.vobiz.ai/xml/dial.md): Use the Dial XML element on Vobiz to dial one or many phone numbers and bridge them to the current caller - answer detection and timeout supported. - [Confirm to answer call](https://docs.vobiz.ai/xml/dial/confirm-to-answer-call.md): Use confirmKey and confirmSound on the Vobiz Dial element to require human confirmation, preventing voicemail systems from accidentally answering. - [Custom caller tone](https://docs.vobiz.ai/xml/dial/custom-caller-tone.md): Play a custom caller tone while the Vobiz Dial element bridges to the destination - set the audio via the dialMusic attribute on the Dial verb. - [Dial status reporting](https://docs.vobiz.ai/xml/dial/dial-status-reporting.md): Use the action URL on the Vobiz Dial element to receive a call status callback after the call ends - control flow by returning fresh XML. - [The Number Element](https://docs.vobiz.ai/xml/dial/number.md): Use the Number XML element on Vobiz to specify a phone number to dial inside a Dial verb - supports multiple Number children for parallel dialing. - [Sequential dialing](https://docs.vobiz.ai/xml/dial/sequential-dialing.md): Dial multiple Vobiz numbers sequentially with the Dial element - set per-Number timeouts so the next destination is tried only after the previous fails. - [Simultaneous dialing](https://docs.vobiz.ai/xml/dial/simultaneous-dialing.md): Dial several Vobiz destinations simultaneously with User and Number children - the first endpoint to answer connects, the rest are dropped instantly. - [The User Element](https://docs.vobiz.ai/xml/dial/user.md): Use the User XML element on Vobiz inside a Dial verb to specify a SIP endpoint (user@domain) to dial - supports multiple Users for parallel calls. - [The DTMF Element](https://docs.vobiz.ai/xml/dtmf.md): Use the Vobiz DTMF XML element to send DTMF digits on a live call - useful for automating IVR navigation, account lookups, and tone-based services. - [The Gather Element](https://docs.vobiz.ai/xml/gather.md): Use the Gather XML element on Vobiz to collect user input via DTMF keypad presses or automatic speech recognition (ASR) during a live phone call. - [Detecting speech inputs](https://docs.vobiz.ai/xml/gather/detecting-speech-inputs.md): 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](https://docs.vobiz.ai/xml/gather/pricing-for-speech-recognition.md): 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](https://docs.vobiz.ai/xml/gather/supported-languages.md): Reference list of BCP-47 language codes Vobiz Gather supports for speech recognition - including en-IN, Hindi, and major global locales for IVR builds. - [The Hangup Element](https://docs.vobiz.ai/xml/hangup.md): Use the Vobiz Hangup XML element to end a call - reject an incoming call before answering or terminate the call leg at any point in your call flow. - [Hang up call after a minute](https://docs.vobiz.ai/xml/hangup/hang-up-after-a-minute.md): 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. - [XML Best Practices](https://docs.vobiz.ai/xml/overview/best-practices.md): Build robust, scalable, and user-friendly voice applications with these proven patterns and recommendations for Vobiz XML development. - [Getting Started with XML](https://docs.vobiz.ai/xml/overview/getting-started.md): Build your first voice application with Vobiz XML. This guide walks you through setting up webhooks, writing your first XML responses, and testing call flows. - [How XML Works](https://docs.vobiz.ai/xml/overview/how-it-works.md): Understand the request-response cycle between Vobiz and your application. Learn how XML instructions control call flow through webhooks and dynamic responses. - [The Play Element](https://docs.vobiz.ai/xml/play.md): Use the Vobiz Play XML element to fetch and play an audio file from a remote URL to the caller - supports mp3 and wav formats with loop control. - [Play music](https://docs.vobiz.ai/xml/play/play-music.md): 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. - [The PreAnswer Element](https://docs.vobiz.ai/xml/preanswer.md): The Vobiz PreAnswer XML element answers an incoming call in early media mode - useful for playing greetings or warnings before formal call answer. - [Notify callers](https://docs.vobiz.ai/xml/preanswer/notify-callers.md): 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. - [The Record Element](https://docs.vobiz.ai/xml/record.md): The Vobiz Record XML element records a call or conference and posts the recording URL to your callback URL once the recording is finished processing. - [Record a voicemail](https://docs.vobiz.ai/xml/record/record-a-voicemail.md): This example shows how to record a voicemail message. The recording will stop when the caller presses the star key or after 30 seconds, whichever comes first. - [Stream with Record](https://docs.vobiz.ai/xml/record/stream-with-record.md): 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. - [The Redirect Element](https://docs.vobiz.ai/xml/redirect.md): Use the Vobiz Redirect XML element to transfer control of a call mid-flow to a different URL that returns the next XML response for the call to execute. - [Transfer a call](https://docs.vobiz.ai/xml/redirect/transfer-a-call.md): 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. - [XML request](https://docs.vobiz.ai/xml/request.md): Vobiz makes synchronous HTTP requests to your application when handling a call - your endpoint must return valid Vobiz XML to drive the call flow. - [Call status](https://docs.vobiz.ai/xml/request/call-status.md): Vobiz sends a call status to request URLs under the CallStatus key. Your application can make decisions about how to process a call based on this status. - [Event](https://docs.vobiz.ai/xml/request/event.md): 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 logic. - [SIP headers](https://docs.vobiz.ai/xml/request/sip-headers.md): Forward custom SIP headers from a Vobiz SIP endpoint to your application - configure your SIP phone to send headers and access them in the HTTP request. - [The Response Element](https://docs.vobiz.ai/xml/response.md): The Response element is the root of every Vobiz XML document - every XML response from your application must be wrapped in a Response element to be valid. - [The Speak Element](https://docs.vobiz.ai/xml/speak.md): You can use the Speak element to read out text as speech to the caller. It's useful for communicating dynamic text that cannot be prerecorded. - [Play a message](https://docs.vobiz.ai/xml/speak/play-a-message.md): 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](https://docs.vobiz.ai/xml/speak/play-in-a-loop.md): 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](https://docs.vobiz.ai/xml/speak/ssml.md): Use Speech Synthesis Markup Language (SSML) inside the Vobiz Speak XML element to control pronunciation, pauses, emphasis, and prosody of TTS output. - [The Stream Element](https://docs.vobiz.ai/xml/stream.md): The Vobiz Stream XML element lets you receive raw audio from a live call over a WebSocket - power AI voice agents, transcription, and live monitoring. - [Checkpoint Event](https://docs.vobiz.ai/xml/stream/checkpoint-event.md): Send a checkpoint event via Vobiz Stream WebSocket when queued audio events are ready - used to synchronize playback with downstream processing logic. - [Clear Stream](https://docs.vobiz.ai/xml/stream/clear-audio.md): The Vobiz clearAudio Stream event interrupts audio previously sent via playAudio - useful for instantly stopping TTS when the caller starts speaking. - [Initiate a Stream](https://docs.vobiz.ai/xml/stream/initiate.md): Establish a WebSocket connection to Vobiz Stream and begin streaming raw audio from an active call - covers handshake, codecs, and authentication. - [Play Audio Event](https://docs.vobiz.ai/xml/stream/play-audio.md): Use the Vobiz playAudio Stream event to transmit audio through the WebSocket connection back into a live call - ideal for AI voice agent responses. - [Stream Events Overview](https://docs.vobiz.ai/xml/stream/stream-events.md): Use the Vobiz Stream WebSocket connection to send events from your application to control playback, mark checkpoints, and signal interruption. - [The Wait Element](https://docs.vobiz.ai/xml/wait.md): The Vobiz Wait XML element waits silently for a specified number of seconds during a call - useful for pacing, machine detection, and timed pauses. - [Basic wait](https://docs.vobiz.ai/xml/wait/basic-wait.md): 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](https://docs.vobiz.ai/xml/wait/beep-detection.md): 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](https://docs.vobiz.ai/xml/wait/delayed-call-answer.md): 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](https://docs.vobiz.ai/xml/wait/machine-detection.md): Use the silence parameter on the Vobiz Wait element with machine_detection to distinguish a human pickup from voicemail before continuing the call flow. ## OpenAPI Specs - [openapi](https://docs.vobiz.ai/openapi.yaml) ## Optional - [API Status](https://status.vobiz.ai)