v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB
Phone Numbers Store

Reserve numbers

Reserve numbers before ordering. This method gives you a token to use with the POST /numbers/store/{token} method. Your booking is held for a maximum of 5 minutes. You can have only one reservation at a time.

post/numbers/store

Query parameters

countrystring required

ISO 3166-1 alpha-2 country code

Example:FR

Country code

type'geographic' | 'mobile' | 'non-geographic' | 'personal' | 'platform' | 'sharedrevenue' | 'sms-only' | 'special' | 'tollfree' | 'verified' required

Type of number

Example:geographic

Type of number

quantityinteger

Quantity to reserve

class'gold' | 'classic'

Number class. "gold" is for premium (rare) numbers, "classic" is for regular numbers.

Example:classic

Class of number

prefixstring

The prefix of the number

areastring

The area/city of the number

Response

Reservation status

tokenstring required

Reservation token

expiresstring date-time required

RFC 3339, section 5.6

Example response

{
  "expires": "2024-04-24T17:42:28Z",
  "contract": {
    "paymentType": "prepaid",
    "ends": "2024-04-24T17:42:28Z"
  },
  "items": [
    {
      "number": "+33199001234",
      "pricing": {
        "minute": "5.50",
        "mrc": "5.50",
        "nrc": "5.50",
        "setup": "5.50"
      }
    }
  ]
}