VoxLink.ai

API Reference

Get available phone numbers

Retrieve all available phone numbers for assistant assignment

This endpoint returns a list of phone numbers owned by the authenticated user that can be assigned to assistants, with optional filtering by assistant type.

Query Parameters

typestring

Filter phone numbers by assistant type. Options: inbound, outbound

Response fields

dataarray

idinteger

  The unique identifier of the phone number

phone_numberstring

  The phone number in E.164 format

country_codestring

  The country code for the phone number

type_labelstring

  The human-readable type label for the phone number

is_availableboolean

  Whether the phone number is available for assignment (not currently assigned to an inbound assistant)
[
  {
    "id": 45,
    "phone_number": "+1234567890",
    "country_code": "US",
    "type_label": "Normal",
    "is_available": true
  },
  {
    "id": 46,
    "phone_number": "+1234567891",
    "country_code": "US",
    "type_label": "SIP",
    "is_available": false
  },
  {
    "id": 47,
    "phone_number": "+441234567890",
    "country_code": "GB",
    "type_label": "Caller ID",
    "is_available": true
  }
]

Notes

  • Only phone numbers owned by the authenticated user are returned
  • When type=inbound is specified, caller ID numbers and already assigned numbers are filtered out
  • The is_available field indicates if the number can be assigned to a new inbound assistant
  • Phone numbers are returned in the values collection format (indexed array)
  • Use the id field when assigning phone numbers to assistants

Related guides