CAcallr
Phone Numbers Store

Reserve numbers

Changed on

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: a new reservation releases the previous one, whose token stops working. The numbers are picked at random among the available ones matching your filters: prefix matches the beginning of the number, area a part of the area name. The quantity may be reduced to the number of phone numbers your account can still have. If no number matches, the API returns 404. Prepaid accounts need enough credit for the contract duration (402 otherwise).

post/numbers/store

Request

  • Base URL
    https://api.callr.com/v2.0
  • URL
    https://api.callr.com/v2.0/numbers/store
  • Auth
    • API key in header x-api-key
    • or HTTP basic

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
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"
      }
    }
  ]
}

Changes