Index » Numbers Operations (Check Availability, Reservation)

Check Phone Number Availability
Number Reservation


Check Phone Number Availability
Description
Usage
Authorization
Examples

Description
Sometimes our database can contain outdated numbers, that has been sold recently by our partners and was not processed yet as sold.
So the best solution is to use this method to ensure the Phone Number is still available.
We recommend using it whenever user is going to deal with single number, e.g. when user navigates to Number Details page, or just before adding to cart.
If the method returns false in result (see examples below), then you can display error message like "Sorry, the number is out of stock" and DO NOT add it to cart or do any action with it on your website.
If method returns false, then it also ensures that following searches will not output this number anymore.

Usage
GET https://api.phonenumberexpert.net/number/10-digital-phone-number/is-available

Authorization
Basic Authentication: username (Account Name) and password (API Key) can be obtained from PNE owner, please contact him at https://www.phonenumberexpert.com/contacts/

Examples

1. Available Number:
    https://api.phonenumberexpert.net/number/2014444444/is-available (see response)

2. Unavailable Number:
    https://api.phonenumberexpert.net/number/8888888888/is-available (see response)

3. Unknown availability on any reason (e.g. timeout 5 seconds reached for the availability request) (see response)

4. Number is currently reserved, in this case you get date-time in response, that is a moment when number will be available again. (see response)


Result of the first query can be similar to the following:
{
  "success": true,
  "elapsed": "0.054s",
  "result": true
}


Result of the second query looks similar to the following:
{
    "success": true,
    "elapsed": "0.011s",
    "result": false
}


Result of the third query looks similar to the following:
{
    "success": true,
    "elapsed": "5.013s",
    "result": null
}


Result of the fourth query looks similar to the following:
{
    "success": true,
    "elapsed": "0.016s",
    "result": "2020-02-16T00:26:23.985Z"
}

Number Reservation
Description
Usage
When user adds a number to cart in your service, you might want to reserve the number for some time, to ensure it will not be sold to another customer while user is making a decision to purchase it. Reservation works across many services at once.
Currently this functionality is limited to admins & super-admins only.

Usage
POST https://api.phonenumberexpert.net/number/10-digital-phone-number/reserve
POST https://api.phonenumberexpert.net/number/10-digital-phone-number/release