Skip to main content

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.

Use the Phone Numbers API to list owned numbers, browse inventory, purchase numbers, and release numbers back to inventory.
Key Features
  • List all phone numbers owned by your account with pagination support
  • Browse available phone numbers in inventory
  • Purchase numbers from inventory and assign to your account
  • Release numbers back to inventory when no longer needed
  • Master accounts (MA_) can include numbers from sub-accounts
  • View detailed number information including capabilities, pricing, and status

​
Base URL

Base URL
https://api.vobiz.ai/api

​
Authentication

All Phone Number API endpoints require authentication via X-Auth-ID and X-Auth-Token headers.
Required Headers:
  • X-Auth-ID - Your Auth ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Available Operations

  • The PhoneNumber Object - View the complete structure and attributes of a PhoneNumber object including number details, capabilities, billing information, and provider settings.
  • List Account Phone Numbers - GET request to retrieve all phone numbers owned by your account with pagination support. Master accounts can include numbers from sub-accounts.
  • List Inventory Numbers - GET request to browse available phone numbers in inventory (not assigned to any account) that are available for purchase.
  • Purchase from Inventory - POST request to purchase a number from inventory and assign it to your account. Debits balance for setup and monthly fees.
  • Unrent a Number - DELETE request to release a phone number back to inventory. The number will be unassigned from your account and trunk group.