> ## Documentation Index
> Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vobiz Docs Sitemap - API Reference: Regular APIs

> Every page in the API Reference: Regular APIs section of the Vobiz documentation, grouped as it appears in the sidebar, with a one line summary of each.

Every page in the **API Reference: Regular APIs** section of the Vobiz documentation (47 pages), grouped as it appears in the sidebar, with a one line summary of each. The other sections are listed on the [documentation sitemap](https://www.vobiz.ai/docs/resources/sitemap).

* [Vobiz API Reference](https://www.vobiz.ai/docs/api-reference) — Use the Vobiz API reference to build voice calls, SIP trunks, phone-number workflows, audio streams, WhatsApp messaging, and account automation
* [Vobiz API Versioning & Deprecation Policy](https://www.vobiz.ai/docs/api-reference/versioning) — How Vobiz versions the REST API, which changes are additive versus breaking, and the deprecation lifecycle with Deprecation and Sunset response..

## Account

* [Vobiz Account API: Balance & Concurrency](https://www.vobiz.ai/docs/account.md) — 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](https://www.vobiz.ai/docs/account/account-object.md) — Explore every field in the Vobiz Account object - auth\_id, pricing tier, CPS limits, concurrency caps, IP whitelist, and verification status
* [Retrieve Account Details](https://www.vobiz.ai/docs/account/retrieve-account.md) — Fetch complete Vobiz account details - auth credentials, pricing tier, verification status, and contact info - with a single authenticated GET..
* [Balance](https://www.vobiz.ai/docs/account/balance.md) — Check your Vobiz account balance by currency - available balance, reserved funds, promotional credit, credit limit, and low-balance thresholds
* [Transactions](https://www.vobiz.ai/docs/account/transactions.md) — Retrieve a full Vobiz transaction ledger - credits, debits, call charges, DID rentals, and invoice history with per-day totals and reference-type..
* [Concurrency](https://www.vobiz.ai/docs/account/concurrency.md) — 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](https://www.vobiz.ai/docs/account/channel-pricing-preview.md) — Calculate the monthly price for additional Vobiz CPS or concurrent-call capacity without purchasing capacity or debiting the account
* [Purchase CPS or concurrency capacity](https://www.vobiz.ai/docs/account/channel-subscriptions.md) — Purchase recurring Vobiz CPS or concurrent-call capacity and activate a channel subscription that renews every 30 days
* [NDNC Webhook](https://www.vobiz.ai/docs/account/ndnc-webhook.md) — Receive real-time UCC / NDNC complaint alerts on your HTTPS endpoint

## Sub-Accounts

* [Vobiz Sub-Accounts API: Multi-Tenant Accounts](https://www.vobiz.ai/docs/sub-accounts.md) — Provision and manage isolated customer sub-accounts under a Vobiz parent account - segmented billing, independent credentials, and usage tracking
* [Sub-Account Onboarding Flow](https://www.vobiz.ai/docs/sub-accounts/onboarding-flow.md) — End-to-end example: create a customer\_use sub-account, complete KYC, buy and assign a number, and place the first call, with parent vs sub-account..
* [The Subaccount Object](https://www.vobiz.ai/docs/sub-accounts/subaccount-object.md) — Explore the Vobiz Subaccount object schema - auth credentials, permissions, rate limits, SA\_ identifier format, and tenant isolation under a parent..
* [Create a Subaccount](https://www.vobiz.ai/docs/sub-accounts/create-subaccount.md) — Provision an isolated Vobiz subaccount with its own auth credentials for multi-tenant SaaS apps, resellers, or departmental resource separation
* [Retrieve a Subaccount](https://www.vobiz.ai/docs/sub-accounts/retrieve-subaccount.md) — 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](https://www.vobiz.ai/docs/sub-accounts/update-subaccount.md) — Update any fields on a Vobiz subaccount - rename it, toggle enabled status, adjust rate limits, or modify permissions
* [Delete a Subaccount](https://www.vobiz.ai/docs/sub-accounts/delete-subaccount.md) — Permanently delete a Vobiz subaccount and revoke its authentication credentials - irreversible operation for offboarding tenants or closing reseller..
* [List All Subaccounts](https://www.vobiz.ai/docs/sub-accounts/list-all-subaccounts.md) — 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](https://www.vobiz.ai/docs/account-phone-number/assign-subaccount.md) — 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)](https://www.vobiz.ai/docs/account-phone-number/unassign-subaccount.md) — 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](https://www.vobiz.ai/docs/sub-accounts/kyc/overview.md) — Verify customer\_use sub-accounts with a Vobiz-hosted KYC session, then poll the aggregated KYC status until calls are unblocked
  * [Get KYC Status](https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status.md) — Retrieve the aggregated KYC state for a customer\_use sub-account - which verifications have passed, whether calls are still blocked, and the business..
  * [Initialize KYC](https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session.md) — Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification
  * [KYC Email Flow with Webhook](https://www.vobiz.ai/docs/sub-accounts/kyc/email-flow-webhook.md) — Start a hosted sub-account KYC via email link and register a webhook for status updates - the session, the events Vobiz POSTs, and HMAC verification
  * [KYC Redirect Flow with Webhook](https://www.vobiz.ai/docs/sub-accounts/kyc/redirect-flow-webhook.md) — Start a hosted sub-account KYC via redirect - get a widget\_url, redirect the customer yourself, and register a webhook for status updates
  * [KYC Test Mode](https://www.vobiz.ai/docs/sub-accounts/kyc/test-mode.md) — Test your sub-account KYC integration without real documents

## Phone Numbers

* [Vobiz Phone Numbers API: Buy & Manage DIDs](https://www.vobiz.ai/docs/account-phone-number.md) — Buy, manage, and release virtual phone numbers with the Vobiz API - India DIDs, 160 and 140 series, and E.164 numbers across 130+ countries
* [The PhoneNumber Object](https://www.vobiz.ai/docs/account-phone-number/account-phone-number-object.md) — 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](https://www.vobiz.ai/docs/account-phone-number/list-account-phone-numbers.md) — Retrieve all phone numbers purchased and assigned to your Vobiz account - capabilities, billing, status, and application assignments across 130+..
* [List Inventory Numbers](https://www.vobiz.ai/docs/account-phone-number/list-inventory-numbers.md) — Browse Vobiz phone numbers available for purchase - search unassigned DIDs, virtual numbers, and toll-free numbers by country, prefix, or voice..
* [Purchase from Inventory](https://www.vobiz.ai/docs/account-phone-number/purchase-from-inventory.md) — 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](https://www.vobiz.ai/docs/account-phone-number/unrent-number.md) — Release a Vobiz phone number for an account-specific fee, with a 24-hour cancellation window or an immediate-release option
* [Cancel a Number Release](https://www.vobiz.ai/docs/account-phone-number/cancel-release.md) — Cancel a pending phone number release during the 24-hour cooldown and restore the number to active
* [Get Number Health Dashboard](https://www.vobiz.ai/docs/account-phone-number/get-number-health.md) — Retrieve the health of a Vobiz number - status, spam flag, and call metrics such as answer rate and minutes, with a daily time series of snapshots

## Recordings

* [Vobiz Recordings API: Call & Conference Recordings](https://www.vobiz.ai/docs/recording.md) — List, retrieve, download, and delete Vobiz call and conference recordings via REST API - with bulk export, per-recording metadata, and..
* [The Recording Object](https://www.vobiz.ai/docs/recording/recording-object.md) — Explore every field on the Vobiz Recording object - recording ID, file URL, format, duration, source call UUID, and storage billing
* [Retrieve a Recording](https://www.vobiz.ai/docs/recording/retrieve-recording.md) — Fetch full metadata for a specific Vobiz call recording by ID - file URL, duration, format, associated call UUID, and storage billing
* [List All Recordings](https://www.vobiz.ai/docs/recording/list-all-recordings.md) — Retrieve a paginated list of Vobiz call recordings with filters for recording type, trunk, or extension - for archival, compliance, and quality..
* [Download a Recording](https://www.vobiz.ai/docs/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://www.vobiz.ai/docs/recording/export-historical-recordings.md) — 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](https://www.vobiz.ai/docs/cdr.md) — Query, filter, and export Vobiz CDRs with per-call billing data, MOS scores, jitter, and hangup attribution - for reconciliation and TRAI reporting
* [List CDRs](https://www.vobiz.ai/docs/cdr/list-cdrs.md) — Retrieve paginated Vobiz call detail records with filters for date range, number, direction, and duration - the main endpoint for analytics and..
* [Get Single CDR](https://www.vobiz.ai/docs/cdr/get-cdr.md) — Retrieve the full call detail record for one call by its call\_id - duration, disposition, caller ID, timestamps, and billing data for that voice..
* [Search CDRs](https://www.vobiz.ai/docs/cdr/search-cdrs.md) — Search Vobiz call detail records with active filter combinations - find specific calls by number, status, or duration for dispute resolution and..
* [Recent CDRs](https://www.vobiz.ai/docs/cdr/recent-cdrs.md) — 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](https://www.vobiz.ai/docs/cdr/export-cdrs.md) — Export Vobiz call detail records as a CSV file for billing reconciliation, compliance auditing, and traffic analysis - returns text/csv content..


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.