Phone Numbers (DIDs)

GET

api

partner

accounts

{customer_auth_id}

numbers

List customer numbers

curl --request GET \
  --url https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

{
  "items": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+918012345678",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 300,
      "currency": "INR",
      "application_id": "20577609616603585",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-03-25T06:58:38Z",
      "is_blocked": false,
      "created_at": "2025-03-31T18:30:00Z",
      "updated_at": "2026-03-25T06:58:54Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T06:58:38Z",
      "next_billing_date": "2026-04-25T06:58:38Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    },
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+919876543210",
      "country": "IN",
      "region": "Mumbai",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 200,
      "currency": "INR",
      "application_id": "31985999331899218",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-02-17T10:25:30Z",
      "is_blocked": false,
      "created_at": "2026-02-14T09:30:04Z",
      "updated_at": "2026-02-17T10:29:35Z",
      "is_trial_number": false,
      "last_billing_date": "2026-02-17T10:25:30Z",
      "next_billing_date": "2026-03-17T10:25:30Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 2,
  "account_auth_id": "MA_XXXXXXXX"
}

← Partner API Reference 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.

All Partner API requests use X-Auth-ID and X-Auth-Token headers. See Authentication for details.

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

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.

Query Parameters

Parameter	Default	Description
`page`	`1`	Page number (1-indexed)
`per_page`	`20`	Items per page (max `100`)
`search`	-	Filter by partial number match

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 -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"

{
  "items": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+918012345678",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": { "voice": true, "sms": false, "mms": false, "fax": false },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 300,
      "currency": "INR",
      "application_id": "20577609616603585",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-03-25T06:58:38Z",
      "is_blocked": false,
      "created_at": "2025-03-31T18:30:00Z",
      "updated_at": "2026-03-25T06:58:54Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T06:58:38Z",
      "next_billing_date": "2026-04-25T06:58:38Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1,
  "account_auth_id": "MA_XXXXXXXX"
}

Response fields

Field	Notes
`e164`	The number in E.164 format.
`status`	`active` once the number is routing.
`capabilities`	Per-channel flags - `voice`, `sms`, `mms`, `fax`. Indian DIDs are typically voice-only.
`application_id`	The Vobiz application the number is routed to. A number with no application has nowhere to route inbound calls.
`setup_fee` / `monthly_fee`	One-time and recurring rental cost in `currency`. Add `monthly_fee` to the customer’s invoice.
`last_billing_date` / `next_billing_date`	When the DID was last charged and when it next renews. There is no separate `expires_at`; a number stops routing only when released or when the account can’t cover the next rental.
`aadhaar_verification_required` / `aadhaar_verified`	Indian regulatory flag. If `aadhaar_verification_required` is `true` and `aadhaar_verified` is `false`, the number may be restricted until the customer completes KYC.
`source`	How the number was obtained, e.g. `purchased`.

All Numbers (Global)

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.

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"

The global response uses the same item schema as the per-customer endpoint, paginated across every account under your umbrella.

Number Management Guide

Every customer needs at least one active number - A customer with no assigned numbers cannot receive inbound calls. After creating a customer account, assign at least one DID via the Vobiz Console.
Monitor renewals - Watch next_billing_date. A DID stops routing only when it is released or when the customer’s wallet can’t cover the next rental. Build a weekly check that flags numbers renewing within 14 days against customers whose balance is low.
Verify application routing after assignment - After assigning a number, confirm application_id is set. A number with no application receives calls but has nowhere to route them, causing immediate hangups for callers.
Track costs for billing - Use monthly_fee (recurring) and setup_fee (one-time) for the DID rental cost per number. Add these to the customer invoice alongside call usage from the CDR endpoint.
Watch Aadhaar status (India) - If aadhaar_verification_required is true but aadhaar_verified is false, the number may be regulatorily restricted until the customer completes KYC.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

customer_auth_id

string

required

Query Parameters

string

Substring match against the E.164 number.

page

integer

default:1

per_page

integer

default:20

Response

200 - application/json

Customer numbers

items

array

required

page

integer

required

per_page

integer

required

total

integer

required

account_auth_id

string

required

CDRs (Call History)

List customer numbers

curl --request GET \
  --url https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

{
  "items": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+918012345678",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 300,
      "currency": "INR",
      "application_id": "20577609616603585",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-03-25T06:58:38Z",
      "is_blocked": false,
      "created_at": "2025-03-31T18:30:00Z",
      "updated_at": "2026-03-25T06:58:54Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T06:58:38Z",
      "next_billing_date": "2026-04-25T06:58:38Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    },
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+919876543210",
      "country": "IN",
      "region": "Mumbai",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 200,
      "currency": "INR",
      "application_id": "31985999331899218",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-02-17T10:25:30Z",
      "is_blocked": false,
      "created_at": "2026-02-14T09:30:04Z",
      "updated_at": "2026-02-17T10:29:35Z",
      "is_trial_number": false,
      "last_billing_date": "2026-02-17T10:25:30Z",
      "next_billing_date": "2026-03-17T10:25:30Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 2,
  "account_auth_id": "MA_XXXXXXXX"
}

​Overview

​Customer Numbers

​Query Parameters

​Response fields

​All Numbers (Global)

​Number Management Guide

Authorizations

Path Parameters

Query Parameters

Response

Overview

Customer Numbers

Query Parameters

Response fields

All Numbers (Global)

Number Management Guide