VoxLink.ai

Phone Numbers

Get all phone numbers

Get all phone numbers owned by the authenticated user

This endpoint returns a list of all phone numbers associated with your account, including their subscription status and capabilities.

Response

dataarray

Array of phone number objects

idinteger

  The unique identifier of the phone number

phone_numberstring

  The phone number in E.164 format (e.g., +14155551234)

nicknamestring

  A short, human-friendly label for the number (or `null` if not set)

country_codestring

  The ISO 3166-1 alpha-2 country code (e.g., US, GB, AU)

typestring

  The type of phone number: `normal`, `sip`, or `caller_id`

type_labelstring

  Human-readable label for the phone number type

sms_capableboolean

  Whether the phone number can send and receive SMS

regionstring

  The region where the phone number is provisioned

has_active_subscriptionboolean

  Whether the phone number has an active subscription

created_atstring

  ISO 8601 timestamp of when the phone number was purchased
{
  "data": [
    {
      "id": 1,
      "phone_number": "+14155551234",
      "nickname": "Sales line",
      "country_code": "US",
      "type": "normal",
      "type_label": "Dedicated Number",
      "sms_capable": true,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-08T10:30:00.000000Z"
    },
    {
      "id": 2,
      "phone_number": "+442071234567",
      "nickname": null,
      "country_code": "GB",
      "type": "normal",
      "type_label": "Dedicated Number",
      "sms_capable": false,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-05T14:20:00.000000Z"
    }
  ]
}

There is also a legacy endpoint GET /user/phone-numbers that returns only SMS-capable phone numbers with active subscriptions. Use this /all endpoint if you need all phone numbers regardless of SMS capability or subscription status.

Related guides