Vobiz Logo
Vobiz
|API Documentation
Console

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 via Twilio integration 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

JWT Authentication

Secure JWT Bearer token authentication for all API endpoints with automatic token refresh

Multi-Tenancy

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

Rate Limiting

CPS (calls per second) and concurrent call limits via Speedbump service

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 email and password credentials to obtain JWT tokens via login

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. Login & Get Tokens

POST to /api/v1/auth/login to obtain JWT access and refresh tokens

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

JWT Bearer Token

All API endpoints require JWT Bearer token authentication:

JWT Authorization Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

• Access token expires in 30 minutes

• Refresh token valid for 7 days

• Contains account_id, account_type, rate_limit

• Returned during login

• Can be refreshed without re-authentication

Account-Scoped Resources

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

Account-Scoped URL Pattern
/api/v1/account/{accountID}/resource

Examples:
GET  /api/v1/account/MA_2210JXXN/trunks
POST /api/v1/account/MA_2210JXXN/trunks
GET  /api/v1/account/MA_2210JXXN/balance
POST /api/v1/account/MA_2210JXXN/numbers/purchase

Important: The Gateway validates that the account_id in your JWT token matches the accountID in the URL path. This ensures complete data isolation between accounts.

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

/api/v1/accounts/{accountId}/sub-accounts/
Quick Start