Partner API

Phone Numbers (DIDs)

View and monitor the DID (Direct Inward Dialing) phone number inventory assigned to each customer, or get a global view across all accounts. Customers need at least one active DID to receive inbound calls.

Overview

These endpoints are read-only. They show you what numbers are assigned to each customer. To assign or release numbers, use the Vobiz Console or contact your account manager.

Read-only inventory

The Partner API does not currently support assigning, purchasing, or releasing phone numbers programmatically. Use the Vobiz Partner Console to manage number inventory, or contact support@vobiz.ai for bulk number provisioning.

Customer Numbers

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers

Returns all phone numbers assigned to a specific customer account. Use to verify a customer's number inventory, check allocation status, and identify the application each number is routed to.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

Query Parameters

Parameter	Default	Description
page	1	Page number
per_page	20	Records per page (max 100)
search	(empty)	Search by number string (partial match)
application_id	(empty)	Filter numbers routed to a specific application

cURL — List all numbers for a customer

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers?page=1&per_page=20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — Search for a specific number

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers?search=9122712" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "data": [
    {
      "number": "+912271264217",
      "number_type": "local",
      "country": "IN",
      "region": "Mumbai",
      "status": "active",
      "application_id": "app_abc123",
      "application_name": "Main IVR",
      "trunk_id": "trunk_xyz",
      "monthly_cost": 500.00,
      "currency": "INR",
      "assigned_at": "2026-02-01T10:00:00Z",
      "expires_at": null
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "per_page": 20
  }
}

All Numbers (Global)

GEThttps://api.vobiz.ai/api/v1/partner/numbers

Returns all phone numbers across every customer account under your partner umbrella. Use to audit your complete DID inventory, identify unassigned numbers, or find numbers that are expiring soon.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL — All numbers across all customers

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/numbers?page=1&per_page=50" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK — Global number inventory

{
  "data": [
    {
      "number": "+912271264217",
      "account_auth_id": "MA_48149cf4",
      "account_name": "Credresolve",
      "status": "active",
      "application_id": "app_abc123",
      "monthly_cost": 500.00,
      "currency": "INR",
      "assigned_at": "2026-02-01T10:00:00Z"
    },
    {
      "number": "+912271264218",
      "account_auth_id": "MA_99ab12c3",
      "account_name": "Acme Outbound",
      "status": "active",
      "application_id": "app_def456",
      "monthly_cost": 500.00,
      "currency": "INR",
      "assigned_at": "2026-01-15T09:00:00Z"
    }
  ],
  "meta": {
    "total": 147,
    "page": 1,
    "per_page": 50
  }
}

Response Fields

Field	Description
number	The phone number in E.164 format (e.g. +912271264217)
number_type	"local", "tollfree", or "mobile"
country	ISO country code of the number
region	Geographic region or area (e.g. Mumbai, Delhi)
status	"active" — number is assigned and routing calls. "suspended" — number is paused.
application_id	ID of the Vobiz application this number routes to
application_name	Display name of the routing application
trunk_id	SIP trunk this number is associated with
monthly_cost	Monthly rental cost for this number in the specified currency
assigned_at	ISO 8601 timestamp when the number was assigned to this customer
expires_at	Expiry date if applicable. Null means the number auto-renews.
account_auth_id	Customer auth_id owning this number (global endpoint only)
account_name	Customer name (global endpoint only)

Number Management Guide

Every customer needs at least one active number

A customer with zero assigned numbers cannot receive inbound calls. After creating a customer account, immediately assign at least one DID via the Vobiz Console.

Monitor expiry dates

Numbers with an expires_at value will stop routing calls if not renewed. Build a scheduled check that queries the numbers endpoint weekly and flags any numbers with expires_at within 14 days.

Verify application routing after number assignment

After assigning a number, verify the application_id is set correctly. A number with a null application_id will receive calls but have nowhere to route them — resulting in immediate hangups for callers.

Track costs for billing

The monthly_cost field gives you the DID rental cost per number. Add this to your customer invoice alongside their call usage from the CDR endpoint.

CDRs

Partner Overview