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.

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”.
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”).
trunk_group_idstringUUID of assigned trunk group. Null if not assigned to any trunk. Optional.
purchased_atstringISO 8601 timestamp when the number was purchased. Optional.
released_atstringISO 8601 timestamp when the number was released. Optional.
created_atstringISO 8601 timestamp when the number record was created.
updated_atstringISO 8601 timestamp when the number record was last updated.

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