Skip to main content
GET
https://app.famulor.de/api/
/
user
/
assistants
/
phone-numbers
Get available phone numbers
curl --request GET \
  --url https://app.famulor.de/api/user/assistants/phone-numbers \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
  }
]
Get a list of all phone numbers in your account that can be assigned to assistants. Optionally filter by assistant type.

​
Query Parameters

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

​
Response Fields

​
data
array
Array of phone number objects
[
  {
    "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 you own are returned
  • When filtering with type=inbound, caller ID numbers and already assigned numbers are excluded
  • The is_available field indicates if the number can be assigned to a new inbound assistant
  • Phone numbers are returned as an indexed array
  • Use the phone number id when assigning numbers to assistants