Vobiz API Documentation

Complete API documentation for building enterprise-grade telephony solutions. Provision SIP trunks, manage phone numbers, route calls, and track usage with our powerful REST APIs.

https://api.vobiz.ai

Core Features

SIP Trunk Provisioning

Auto-generated domains (trunkId.sip.vobiz.ai) with configurable codecs, rate limits, and authentication

Call Routing & LCR

Intelligent least-cost routing with prefix-based rules and carrier priority management

Number Management

Search, purchase, and assign phone numbers with auto-billing

Real-time Billing

Multi-currency balance management, CDR processing, and Razorpay payment integration

API Features

RESTful API

Standard HTTP methods (GET, POST, PUT, DELETE) with JSON request and response format

Header-Based Authentication

Secure header-based authentication using X-Auth-ID and X-Auth-Token for all API endpoints.

Multi-Tenancy

Account-scoped resources with sub-account support for SaaS and reseller models

Rate Limiting

CPS (calls per second) and concurrent call limits

Getting Started

Base URL

Production API Base URL

https://api.vobiz.ai

Prerequisites

Vobiz Account

Contact Vobiz to set up your account and receive credentials

Authentication Credentials

You'll receive an Auth ID and Auth Token for authentication.

HTTP Client

Use cURL, Postman, or any HTTP library in your preferred language

Quick Setup Steps

1. Get Credentials

Receive your account credentials from Vobiz team

2. Authenticate

Include your X-Auth-ID and X-Auth-Token headers in all API requests.

3. Create SIP Trunk

Provision your first trunk to get a SIP domain

4. Start Calling

Configure your SIP client and start making calls

Authentication Overview

X-Auth-ID & X-Auth-Token

All API endpoints require X-Auth-ID and X-Auth-Token headers for authentication:

Authentication Headers

X-Auth-ID: {your_auth_id}
X-Auth-Token: {your_auth_token}

Account-Scoped Resources

All resource APIs follow a strict account-scoped pattern for security and multi-tenancy:

Account-Scoped URL Pattern

https://api.vobiz.ai/api/v1/account/{accountID}/resource

Examples:
GET  https://api.vobiz.ai/api/v1/account/MA_2210JXXN/trunks
POST https://api.vobiz.ai/api/v1/account/MA_2210JXXN/trunks
GET  https://api.vobiz.ai/api/v1/account/MA_2210JXXN/balance
POST https://api.vobiz.ai/api/v1/account/MA_2210JXXN/numbers/purchase

Important: The Gateway validates that the account_id associated with your authentication credentials matches the accountID in the URL path. This ensures complete data isolation between accounts.

Exception: Sub-account endpoints use /accounts/ (plural) with trailing slash:

https://api.vobiz.ai/api/v1/accounts/{accountId}/sub-accounts/

Quick Start