API Reference
Get available phone numbers
Retrieve all available phone numbers for assistant assignment
On this page
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
[
{
"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=inboundis specified, caller ID numbers and already assigned numbers are filtered out - The
is_availablefield 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
idfield when assigning phone numbers to assistants
Related guides
API Reference
Introduction
Welcome to the VoxLink API
Read guide →API Reference
Authentication
Learn how to authenticate your API requests
Read guide →API Reference
Get current user
Get the authenticated user's profile information
Read guide →API Reference
List assistants
List all assistants for the authenticated user with pagination
Read guide →