Skip to main content
The PhoneNumber object represents a phone number in the Vobiz system, including its capabilities, billing details, and status.

​
Attributes

FieldTypeDescription
idstringUUID identifier for the phone number.
auth_idstringAuth ID (MA_xxx or SA_xxx) that owns this number. Null if number is in inventory and not assigned to any account.
e164stringPhone number in E164 format (e.g., “+14155551234”).
countrystringCountry code (e.g., “US”, “IN”).
regionstringState/region code (e.g., “CA”, “MH”). Optional.
capabilitiesobjectObject containing boolean flags for each capability: voice, sms, mms, fax.
capabilities.voicebooleanWhether the number supports voice calling.
capabilities.smsbooleanWhether the number supports SMS messaging.
capabilities.mmsbooleanWhether the number supports MMS messaging.
capabilities.faxbooleanWhether the number supports fax.
statusstringCurrent status of the number. One of: “active”, “pending_purchase”, “pending_release”, “released”, “blocked”.
providerstringUpstream carrier/provider identifier. Often an empty string for Vobiz-stocked numbers.
setup_feenumberOne-time setup fee charged when purchasing the number.
monthly_feenumberMonthly recurring fee for the number.
currencystringCurrency code for fees (e.g., “USD”, “INR”).
application_idstringID of the application the number is attached to, if any. Optional.
trunk_group_idstringUUID of assigned trunk group. Null if not assigned to any trunk. Optional.
voice_enabledbooleanWhether voice routing is enabled for the number.
tagsarrayFree-form string tags applied to the number.
is_blockedbooleanWhether the number is currently blocked.
is_trial_numberbooleanWhether the number was provisioned as a trial number.
sourcestringHow the number entered the account (e.g., purchased, inventory).
minimum_commitment_monthsintegerMinimum commitment period in months. 0 if none.
aadhaar_verification_requiredbooleanWhether Aadhaar verification is required for this number (India).
aadhaar_verifiedbooleanWhether Aadhaar verification has been completed.
purchased_atstringISO 8601 timestamp when the number was purchased. Optional.
released_atstringISO 8601 timestamp when the number was released. Optional.
last_billing_datestringISO 8601 timestamp of the most recent monthly-fee billing. Optional.
next_billing_datestringISO 8601 timestamp of the next scheduled monthly-fee billing. Optional.
created_atstringISO 8601 timestamp when the number record was created.
updated_atstringISO 8601 timestamp when the number record was last updated.
In list and purchase responses the owning account is returned as account_id (e.g. MA_XXXXXX). The detached inventory listing has auth_id=NULL. The capabilities block is voice-first — sms, mms, and fax are commonly false.

​
Number Status Values

StatusDescription
activeNumber is active and available
pending_purchasePurchase in progress
pending_releaseRelease in progress
releasedNumber has been released
blockedNumber is blocked

​
Example PhoneNumber Object

JSON
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "auth_id": "{auth_id}",
  "e164": "+14155551234",
  "country": "US",
  "region": "CA",
  "capabilities": {
    "voice": true,
    "sms": true,
    "mms": false,
    "fax": false
  },
  "status": "active",
  "setup_fee": 1.00,
  "monthly_fee": 1.00,
  "currency": "USD",
  "trunk_group_id": "660e8400-e29b-41d4-a716-446655440001",
  "purchased_at": "2025-01-15T10:00:00Z",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}