The PhoneNumber Object

The PhoneNumber object represents a phone number in the Vobiz system, including details about capabilities, billing, and status.

Attributes

PhoneNumber Attributes

Parameter	Type	Description
`id`optional	string	UUID identifier for the phone number.
`auth_id`optional	string	Auth ID (MA_xxx or SA_xxx) that owns this number. Null if number is in inventory and not assigned to any account.
`e164`optional	string	Phone number in E164 format (e.g., "+14155551234").
`country`optional	string	Country code (e.g., "US", "IN").
`region`optional	string	State/region code (e.g., "CA", "MH"). Optional.
`capabilities`optional	object	Object containing boolean flags for each capability: voice, sms, mms, fax.
`capabilities.voice`optional	boolean	Whether the number supports voice calling.
`capabilities.sms`optional	boolean	Whether the number supports SMS messaging.
`capabilities.mms`optional	boolean	Whether the number supports MMS messaging.
`capabilities.fax`optional	boolean	Whether the number supports fax.
`status`optional	string	Current status of the number. One of: "active", "pending_purchase", "pending_release", "released", "blocked".
`setup_fee`optional	number	One-time setup fee charged when purchasing the number.
`monthly_fee`optional	number	Monthly recurring fee for the number.
`currency`optional	string	Currency code for fees (e.g., "USD", "INR").
`trunk_group_id`optional	string	UUID of assigned trunk group. Null if not assigned to any trunk. Optional.
`purchased_at`optional	string	ISO 8601 timestamp when the number was purchased. Optional.
`released_at`optional	string	ISO 8601 timestamp when the number was released. Optional.
`created_at`optional	string	ISO 8601 timestamp when the number record was created.
`updated_at`optional	string	ISO 8601 timestamp when the number record was last updated.

Number Status Values

Status	Description
active	Number is active and available
pending_purchase	Purchase in progress
pending_release	Release in progress
released	Number has been released
blocked	Number 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"
}

Phone Numbers Overview

List Account Phone Numbers