Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Vobiz Docs - Navigation Structure

5 top-level tabs. Every existing page maps to exactly one tab.

---

​

Tab 1 - Documentation

Getting started, concepts, best practices, compliance, FAQ, tools

​

GETTING STARTED

• Introduction → /
• Quick Start → /quick-start
• Error Handling → /errors

​

CORE CONCEPTS

• Overview → /concepts
• SIP Trunking → /concepts/sip-trunking
• Streaming WebSockets → /concepts/streaming-websockets
• SIP vs WebSockets → /concepts/sip-vs-websockets
• Callbacks → /concepts/callbacks
• Callback Configurations → /concepts/callback-configurations
• IP Whitelisting → /concepts/ip-whitelisting

​

BEST PRACTICES

• Overview → /best-practices
• Number Utilization Guide → /best-practices/number-utilization
• DLT Registration Guide → /best-practices/dlt-registration
• 140 & 160 Acquisition Guide → /best-practices/140-160-acquisition

​

COMPLIANCE (INDIA)

• Calling Regulations → /compliance/india/calling-regulations
• KYC Documents → /compliance/india/kyc
• UCC Management → /compliance/india/ucc

​

FAQ

• Overview → /faq
• Trial Numbers & Inbound → /faq/trial-inbound
• SIP Codes 480 / 486 → /faq/sip-codes-480-486
• Error 429 Rate Limits → /faq/error-429
• Concurrency → /faq/concurrency
• Calls Per Second (CPS) → /faq/cps
• Purchasing Capacity → /faq/purchase-concurrency-cps
• Number Series → /faq/number-series
• Supported Integrations → /faq/integrations
• Call Transfer → /faq/call-transfer
• IVR Support → /faq/ivr
• Verification / KYC Docs → /faq/verification-docs
• Contact Support → /faq/contact-support
• Domestic Calling in India → /faq/domestic-calling-india

​

TOOLS

• CPS & Cost Calculator → /resources/calculator
• XML Builder → /xml-builder

---

​

Tab 2 - API Reference

3-level hierarchy: Group → Section → Pages Five groups: Regular APIs · SIP Trunking APIs · Voice & XML · WhatsApp · Partner

---

​

▸ GROUP 1 - Regular APIs

Core account management - accounts, numbers, recordings, CDR

​

Account

• Overview → /account
• The Account Object → /account/account-object
• Retrieve Account → /account/retrieve-account
• Balance → /account/balance
• Concurrency → /account/concurrency

​

Sub-Accounts

• Overview → /sub-accounts
• The Subaccount Object → /sub-accounts/subaccount-object
• Create a Subaccount → /sub-accounts/create-subaccount
• Retrieve a Subaccount → /sub-accounts/retrieve-subaccount
• Update a Subaccount → /sub-accounts/update-subaccount
• Delete a Subaccount → /sub-accounts/delete-subaccount
• List All Subaccounts → /sub-accounts/list-all-subaccounts

​

Phone Numbers

• Overview → /account-phone-number
• The PhoneNumber Object → /account-phone-number/account-phone-number-object
• List Account Numbers → /account-phone-number/list-account-phone-numbers
• List Inventory Numbers → /account-phone-number/list-inventory-numbers
• Purchase from Inventory → /account-phone-number/purchase-from-inventory
• Unrent a Number → /account-phone-number/unrent-number
• BYOC → /account-phone-number/byoc

​

Recordings

• Overview → /recording
• The Recording Object → /recording/recording-object
• Retrieve a Recording → /recording/retrieve-recording
• List All Recordings → /recording/list-all-recordings
• Download a Recording → /recording/download-recording
• Delete a Recording → /recording/delete-recording
• Export Historical Recordings → /recording/export-historical-recordings
• Bulk Delete Recordings → /recording/bulk-delete-recordings

​

Call Detail Records

• CDR Reference → /cdr

---

​

▸ GROUP 2 - SIP Trunking APIs

Trunk management, credentials, IP ACLs, origination URIs, SIP endpoints

​

Trunks

• Overview → /trunks
• The Trunk Object → /trunks/trunk-object
• Create a Trunk → /trunks/create-trunk
• Retrieve a Trunk → /trunks/retrieve-trunk
• Retrieve All Trunks → /trunks/retrieve-all-trunks
• Update a Trunk → /trunks/update-trunk
• Assign Number to Trunk → /trunks/assign-number
• Unassign Number from Trunk → /trunks/unassign-number
• Delete a Trunk → /trunks/delete-trunk
• Webhook → /trunks/webhook

​

Credentials

• Overview → /trunks/credentials
• The Credential Object → /trunks/credentials/credential-object
• Create a Credential → /trunks/credentials/create-credential
• Retrieve All Credentials → /trunks/credentials/retrieve-all-credentials
• Update a Credential → /trunks/credentials/update-credential
• Delete a Credential → /trunks/credentials/delete-credential

​

IP Access Control List

• Overview → /trunks/ip-acl
• The IP ACL Object → /trunks/ip-acl/ip-acl-object
• Create an IP ACL → /trunks/ip-acl/create-ip-acl
• Retrieve All IP ACLs → /trunks/ip-acl/retrieve-all-ip-acls
• Update an IP ACL → /trunks/ip-acl/update-ip-acl
• Delete an IP ACL → /trunks/ip-acl/delete-ip-acl

​

Origination URI

• Overview → /trunks/origination-uri
• The Origination URI Object → /trunks/origination-uri/origination-uri-object
• Create an Origination URI → /trunks/origination-uri/create-origination-uri
• Retrieve All Origination URIs → /trunks/origination-uri/retrieve-all-origination-uris
• Update an Origination URI → /trunks/origination-uri/update-origination-uri
• Delete an Origination URI → /trunks/origination-uri/delete-origination-uri

​

SIP Endpoints

• Overview → /endpoint
• The Endpoint Object → /endpoint/endpoint-object
• Create an Endpoint → /endpoint/create-endpoint
• Retrieve an Endpoint → /endpoint/retrieve-endpoint
• Update an Endpoint → /endpoint/update-endpoint
• Delete an Endpoint → /endpoint/delete-endpoint
• List All Endpoints → /endpoint/list-all-endpoints

---

​

▸ GROUP 3 - Voice & XML API

Two clear sub-divisions: REST APIs for live call control · XML elements for call flow scripting

---

​

── VOICE APIs (REST) ──

​

Applications

• Overview → /applications
• The Application Object → /applications/application-object
• Create an Application → /applications/create-application
• Retrieve an Application → /applications/retrieve-application
• Update an Application → /applications/update-application
• Delete an Application → /applications/delete-application
• List All Applications → /applications/list-all-applications
• Link Numbers → /applications/link-numbers

​

Call Management

• Overview → /call/overview
• The Call Object → /call/call-object
• Make a Call → /call/make-call
• Machine Detection → /call/machine-detection
• Transfer a Call → /call/transfer-call
• Hang Up a Call → /call/hangup-call
• Retrieve a Live Call → /call/retrieve-live-call
• Retrieve All Live Calls → /call/retrieve-all-live-calls
• Retrieve a Queued Call → /call/retrieve-queued-call
• Retrieve All Queued Calls → /call/retrieve-all-queued-calls
• Record Calls
  • Overview → /call/record-calls
  • Start Recording → /call/record-calls/start-recording
  • Stop Recording → /call/record-calls/stop-recording
• Play Audio
  • Overview → /call/play-audio
  • Play Audio on a Call → /call/play-audio/play-audio
  • Stop Playing Audio → /call/play-audio/stop-audio
• Speak Text
  • Overview → /call/speak-text
  • Speak Text on a Call → /call/speak-text/speak-text
  • Stop Speaking → /call/speak-text/stop-speak
• DTMF
  • Overview → /call/dtmf
  • Send Digits → /call/dtmf/send-digits

​

Conferences

• The Conference Object → /conference/conference-object
• Retrieve a Conference → /conference/retrieve-conference
• Retrieve All Conferences → /conference/retrieve-all-conferences
• Hang Up a Conference → /conference/hang-up-conference
• Hang Up All Conferences → /conference/hang-up-all-conferences
• Members
  • Overview → /conference/members
  • Play Audio to Member → /conference/members/play-audio
  • Stop Audio to Member → /conference/members/stop-audio
  • Deaf a Member → /conference/members/deaf-member
  • Undeaf a Member → /conference/members/undeaf-member
  • Mute a Member → /conference/members/mute-member
  • Unmute a Member → /conference/members/unmute-member
  • Kick a Member → /conference/members/kick-member
  • Hang Up a Member → /conference/members/hang-up-member
• Recording
  • Overview → /conference/recording
  • Start Recording → /conference/recording/start-recording
  • Stop Recording → /conference/recording/stop-recording

​

Audio Streams

• Overview → /audio-streams
• The Stream Object → /audio-streams/stream-object
• Start an Audio Stream → /audio-streams/start-audio-stream
• Retrieve an Audio Stream → /audio-streams/retrieve-audio-stream
• List All Audio Streams → /audio-streams/list-audio-streams
• Stop an Audio Stream → /audio-streams/stop-audio-stream
• Stop All Audio Streams → /audio-streams/stop-all-audio-streams

​

── XML ELEMENTS ──

​

XML Overview

• How XML Works → /xml/overview/how-it-works
• Getting Started → /xml/overview/getting-started
• Best Practices → /xml/overview/best-practices

​

Stream

• Overview → /xml/stream
• Initiate a Stream → /xml/stream/initiate
• Stream Events → /xml/stream/stream-events
• Checkpoint Event → /xml/stream/checkpoint-event
• Clear Audio Stream → /xml/stream/clear-audio
• Play Audio Event → /xml/stream/play-audio

​

Conference (XML)

• XML Overview → /xml/conference

​

Dial

• Overview → /xml/dial
• Number → /xml/dial/number
• User → /xml/dial/user
• Sequential Dialing → /xml/dial/sequential-dialing
• Simultaneous Dialing → /xml/dial/simultaneous-dialing
• Confirm to Answer → /xml/dial/confirm-to-answer-call
• Custom Caller Tone → /xml/dial/custom-caller-tone
• Dial Status Reporting → /xml/dial/dial-status-reporting

​

Gather

• Overview → /xml/gather
• Detecting Speech Inputs → /xml/gather/detecting-speech-inputs
• Pricing for Speech Recognition → /xml/gather/pricing-for-speech-recognition
• Supported Languages → /xml/gather/supported-languages

​

Speak

• Overview → /xml/speak
• Play a Message → /xml/speak/play-a-message
• Play in a Loop → /xml/speak/play-in-a-loop
• SSML → /xml/speak/ssml

​

Play

• Overview → /xml/play
• Play Music → /xml/play/play-music

​

Record

• Overview → /xml/record
• Record a Voicemail → /xml/record/record-a-voicemail
• Stream with Record → /xml/record/stream-with-record

​

Redirect

• Overview → /xml/redirect
• Transfer a Call → /xml/redirect/transfer-a-call

​

Hangup

• Overview → /xml/hangup
• Hang Up After a Minute → /xml/hangup/hang-up-after-a-minute

​

Wait

• Overview → /xml/wait
• Basic Wait → /xml/wait/basic-wait
• Beep Detection → /xml/wait/beep-detection
• Delayed Call Answer → /xml/wait/delayed-call-answer
• Machine Detection → /xml/wait/machine-detection

​

PreAnswer

• Overview → /xml/preanswer
• Notify Callers → /xml/preanswer/notify-callers

​

Request

• Overview → /xml/request
• Call Status → /xml/request/call-status
• Event → /xml/request/event
• SIP Headers → /xml/request/sip-headers

​

Response

• Reference → /xml/response

​

DTMF

• Reference → /xml/dtmf

---

​

▸ GROUP 4 - WhatsApp Business API

WhatsApp messaging, channels, webhooks, and full API reference

​

Getting Started

• Introduction → /whatsapp/getting-started/introduction
• Prerequisites → /whatsapp/getting-started/prerequisites
• Quick Start → /whatsapp/getting-started/quick-start

​

Channel Management

• Overview → /whatsapp/channels
• BYON Guide → /whatsapp/channels/byon

​

Messaging

• Overview → /whatsapp/messaging
• Using the Inbox → /whatsapp/messaging/inbox
• Templates → /whatsapp/messaging/templates

​

Webhooks

• Overview → /whatsapp/webhooks
• Webhook Events → /whatsapp/webhooks/events

​

API Reference

• Overview → /whatsapp/api
• Authentication → /whatsapp/api/authentication
• Send Message → /whatsapp/api/send-message
• Channels → /whatsapp/api/channels
• Numbers → /whatsapp/api/numbers
• Conversations → /whatsapp/api/conversations
• Contacts → /whatsapp/api/contacts
• Templates → /whatsapp/api/templates
• Campaigns → /whatsapp/api/campaigns
• Canned Responses → /whatsapp/api/canned-responses
• Calls → /whatsapp/api/calls
• Webhooks → /whatsapp/api/webhooks

---

​

▸ GROUP 5 - Partner API

Reseller and white-label partner management

​

Overview & Flow

• Overview → /partner
• Example Flow → /partner/flow
• API Reference → /partner/api

​

Endpoints

• Authentication → /partner/api/authentication
• Profile → /partner/api/profile
• Dashboard & Analytics → /partner/api/analytics
• Customer Accounts → /partner/api/customers
• Balance Transfer → /partner/api/balance
• Transactions → /partner/api/transactions
• CDRs → /partner/api/cdrs
• Phone Numbers → /partner/api/numbers

---

​

Tab 3 - Integrations

AI voice platforms + official language SDKs

​

AI VOICE PLATFORMS

• WebRTC Setup → /integrations/webrtc-application-setup
• LiveKit → /integrations/livekit
• Pipecat → /integrations/pipecat
• Bolna.ai → /integrations/bolna
• Ultravox → /integrations/ultravox
• ElevenLabs
  • Dashboard Setup → /integrations/elevenlabs-dashboard
  • API Setup → /integrations/elevenlabs-api
• VAPI
  • Dashboard Setup → /integrations/vapi-dashboard
  • API Setup → /integrations/vapi-api
• Retell AI
  • Dashboard Setup → /integrations/retellai-dashboard
  • API Setup → /integrations/retellai-api
• WebSockets & Python → /integrations/websockets
• OpenAI Realtime → /integrations/openai-realtime

​

OFFICIAL SDKs

• Node.js SDK → /integrations/node-sdk
• Python SDK → /integrations/python-sdk
• Ruby SDK → /integrations/ruby-sdk
• Go SDK → /integrations/go-sdk
• C# / .NET SDK → /integrations/csharp-sdk

---

​

Tab 4 - Examples & Tutorials

Runnable examples, guides, use-case solutions, and platform comparisons

​

GUIDES

• Build an AI Voice Agent → /guides/ai-voice-agent
  • Inbound Agent → /guides/ai-voice-agent/inbound
  • Outbound Agent → /guides/ai-voice-agent/outbound

​

LIVEKIT TEMPLATES

• Call Transfer Agent → /examples/vobiz-livekit-call-transfer-example
• IVR DTMF Agent → /examples/vobiz-livekit-ivr-dtmf-example
• Agent-to-Agent Handoff → /examples/vobiz-livekit-agent-to-agent-handoff-example
• Machine Detection (AMD) → /examples/livekit-vobiz-machine-detection-agent-example
• All-in-One Engine → /examples/livekit-vobiz-all-feature-example
• Webhook & CRM Integration → /examples/livekit-vobiz-webhook-integration-example
• LiveKit Inbound Agent → /examples/livekit-vobiz-inbound
• LiveKit Outbound Dialer → /examples/livekit-vobiz-outbound

​

XML & PYTHON TEMPLATES

• Pipecat Voice App → /examples/vobiz-x-pipecat
• All XML Example → /examples/vobiz-all-xml
• IVR (Python + XML) → /examples/vobiz-ivr-xml-python
• Call Queue → /examples/vobiz-call-queue-xml-python
• Call Survey → /examples/vobiz-call-survey-xml-python
• Appointment Reminder → /examples/vobiz-appointment-reminder-xml-python
• OTP Call → /examples/vobiz-otp-call-xml-python
• Voicemail → /examples/vobiz-voicemail-xml-python
• Number Capture → /examples/vobiz-number-capture-xml-python

​

SOLUTIONS

• Overview → /solutions
• Use Cases
  • Cloud IVR → /solutions/cloud-ivr
  • Call Transfer → /solutions/call-transfer
  • Call Escalation → /solutions/call-escalation
  • Agent-to-Agent Handoff → /solutions/agent-to-agent-handoff
  • Call Recording → /solutions/call-recording
  • Conference Calling → /solutions/conference-calling
  • AI Voice Agent → /solutions/ai-voice-agent
  • Contact Centre → /solutions/contact-centre
  • Automated Outbound Calling → /solutions/automated-outbound-calling
  • Appointment Reminders → /solutions/appointment-reminders
  • CRM Integration → /solutions/crm-integration
  • Post-Call Analytics → /solutions/post-call-analytics
• Industries
  • Healthcare → /solutions/healthcare
  • Finance & Fintech → /solutions/finance-fintech
  • Logistics & Delivery → /solutions/logistics-delivery
  • E-commerce & Retail → /solutions/ecommerce-retail
  • Real Estate → /solutions/real-estate

​

COMPARE PLATFORMS

• Vobiz vs Twilio → /compare/vobiz-vs-twilio
• Vobiz vs Plivo → /compare/vobiz-vs-plivo
• Vobiz vs Telnyx → /compare/vobiz-vs-telnyx
• Vobiz vs Vonage → /compare/vobiz-vs-vonage
• Vobiz vs Exotel → /compare/vobiz-vs-exotel
• Vobiz vs JustCall → /compare/vobiz-vs-justcall
• Vobiz vs TeleCRM → /compare/vobiz-vs-telecrm

---

​

Tab 5 - Changelog

• /changelog → placeholder, fill over time