Available Phone Numbers

This section describes how you can search XBP's available inventory of numbers for purchasing.

Purchasing phone numbers is a two step process. You should first search for available phone numbers and then send a POST request to /phone_numbers resource to purchase and provision the phone number.

For more information please check out Purchase or Provision a Phone Number .

GET /available_phone_numbers

Parameters

Name Type Description
area_code integer If area_code is passed only numbers with the matching code are returned.
phone_type string Filter number based on their type, possible values are local and toll-free

Example Request

curl "https://api.xbp.io/available_phone_numbers?area_code=408" \
     -u API_KEY:

Sample Response

{
  "available_phone_numbers":
  [
    {
      "number": "+14088279556",
      "friendly_name": "1(408) 827-9556",
      "phone_type": "local",
      "capabilities": {
        "voice": true,
        "fax": true,
        "sms": true,
        "mms": false
      },
      "lata": "722",
      "rate_center": "LOS GATOS",
      "country": "US",
      "region": "CA",
      "latitude": "37.23640684634082",
      "longitude": "-121.9601015161013",
      "postal_code": "95032"
    },...
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2,
    "limit": 50,
    "size": 50,
    "total_pages": 42,
    "total_records": 2092
  }
}