> ## 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 API Reference

> Use the Vobiz API reference to build voice calls, SIP trunks, phone-number workflows, audio streams, WhatsApp messaging, and account automation.

Use the Vobiz REST APIs to provision telephony resources, control calls, stream audio, send WhatsApp messages, and manage your account.

## Start with the core API

The core API covers accounts, phone numbers, voice calls, SIP trunks, applications, endpoints, recordings, conferences, and call detail records.

```text theme={null}
https://api.vobiz.ai/api/v1
```

Send your Vobiz Auth ID and Auth Token with every server-to-server request:

```http theme={null}
X-Auth-ID: MA_XXXXXXXX
X-Auth-Token: YOUR_AUTH_TOKEN
```

> [!WARNING]
>
> Keep your Auth Token on the server. Do not expose it in browser or mobile application code.

> [card] [Account API](https://www.vobiz.ai/docs/account.md)
>
> Retrieve account details, balances, transaction history, and concurrency limits.

> [card] [Phone Numbers API](https://www.vobiz.ai/docs/account-phone-number.md)
>
> Search, purchase, assign, release, and manage Vobiz phone numbers.

> [card] [Voice Calls API](https://www.vobiz.ai/docs/call/overview.md)
>
> Create outbound calls and control active calls programmatically.

> [card] [SIP Trunking API](https://www.vobiz.ai/docs/trunks.md)
>
> Provision SIP trunks, credentials, IP access lists, and origination routes.

> [card] [Voice XML reference](https://www.vobiz.ai/docs/xml/overview/how-it-works.md)
>
> Define call behavior with playback, speech, gathering, dialing, recording, and streaming elements.

> [card] [Audio Streams API](https://www.vobiz.ai/docs/audio-streams.md)
>
> Start, inspect, and stop bidirectional call-audio streams.

> [card] [Recordings API](https://www.vobiz.ai/docs/recording.md)
>
> List, retrieve, download, and export call recordings.

> [card] [Call Detail Records](https://www.vobiz.ai/docs/cdr.md)
>
> Query call records, quality metrics, costs, and hangup attribution.

> [card] [Applications & endpoints](https://www.vobiz.ai/docs/applications.md)
>
> Configure webhook-driven voice applications and registered SIP endpoints.

## Use the SMS, MMS and RCS API

Messaging resources use an account-scoped base URL, in the same form as the [Call API](https://www.vobiz.ai/docs/call/make-call.md). Replace `{auth_id}` with your Auth ID:

```text theme={null}
https://api.vobiz.ai/api/v1/Account/{auth_id}/Sms
```

The earlier `https://api.vobiz.ai/api/v1/sms` URLs still work.

> [card] [Messaging API overview](https://www.vobiz.ai/docs/sms/overview.md)
>
> Send SMS, MMS and RCS, buy messaging numbers, and register for 10DLC and toll-free.

> [card] [Send a message](https://www.vobiz.ai/docs/sms/api/messages/send-message.md)
>
> One endpoint for SMS, MMS and RCS, with idempotency and scheduling.

## Use the WhatsApp Business API

WhatsApp resources use an account-scoped base URL, in the same form as the [Call API](https://www.vobiz.ai/docs/call/make-call.md). Replace `{auth_id}` with your Auth ID:

```text theme={null}
https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp
```

The earlier `https://api.vobiz.ai/api/v1/messaging` URLs still work.

> [card] [WhatsApp Business API reference](https://www.vobiz.ai/docs/whatsapp/api.md)
>
> Send messages and manage channels, contacts, templates, campaigns, conversations, calls, and webhooks.

> [card] [WhatsApp API authentication](https://www.vobiz.ai/docs/whatsapp/api/authentication.md)
>
> Authenticate WhatsApp requests and protect your API credentials.

## Download the API contract

Use the OpenAPI document to generate clients, inspect request schemas, or import the Vobiz API into compatible development tools.

> [card] [OpenAPI specification](https://www.vobiz.ai/openapi.json)
>
> Download the machine-readable Vobiz OpenAPI specification.

> [card] [Quick start](https://www.vobiz.ai/docs/quick-start.md)
>
> Create an account, get credentials, buy a number, and place your first call.

## Related resources

* Review [API error formats and HTTP status codes](https://www.vobiz.ai/docs/errors.md).
* Read the [API versioning and deprecation policy](https://www.vobiz.ai/docs/api-reference/versioning).
* Browse [Vobiz SDK and integration guides](https://www.vobiz.ai/docs/integrations.md).
* Check current availability on the [Vobiz status page](https://status.vobiz.ai).


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