The PhoneNumber Object
The PhoneNumber object represents a phone number in the Vobiz system, including details about capabilities, billing, and status.
Attributes
PhoneNumber Attributes
| Name | Type | Description |
|---|---|---|
id | string | UUID identifier for the phone number. |
auth_id | 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 | string | Phone number in E164 format (e.g., "+14155551234"). |
country | string | Country code (e.g., "US", "IN"). |
region | string | State/region code (e.g., "CA", "MH"). Optional. |
capabilities | object | Object containing boolean flags for each capability: voice, sms, mms, fax. |
capabilities.voice | boolean | Whether the number supports voice calling. |
capabilities.sms | boolean | Whether the number supports SMS messaging. |
capabilities.mms | boolean | Whether the number supports MMS messaging. |
capabilities.fax | boolean | Whether the number supports fax. |
status | string | Current status of the number. One of: "active", "pending_purchase", "pending_release", "released", "blocked". |
setup_fee | number | One-time setup fee charged when purchasing the number. |
monthly_fee | number | Monthly recurring fee for the number. |
currency | string | Currency code for fees (e.g., "USD", "INR"). |
trunk_group_id | string | UUID of assigned trunk group. Null if not assigned to any trunk. Optional. |
purchased_at | string | ISO 8601 timestamp when the number was purchased. Optional. |
released_at | string | ISO 8601 timestamp when the number was released. Optional. |
created_at | string | ISO 8601 timestamp when the number record was created. |
updated_at | 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"
}