View all the available numbers with filters

post

https://connect.routee.net/numbers/available/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE PARAMETERS

KEY	DESCRIPTION
totalPages	The number of total pages.
last	Whether the current page is the last one.
totalElements	The total amount of elements for the current search.
first	Whether the current page is the first one.
numberOfElements	The number of elements currently on this page.
number	The requested page number.
size	The requested page size.
content	Contains the search results.
content.msisdn	The msisdn (the phone number).
content.country	The country code in ISO 3166-1 alpha-2 format.
content.services	The supported services.
content.inboundCosts	Information about inbound message costs.
content.inboundCosts.price	The price per inbound message.
content.inboundCosts.currency	The currency of the price.
content.inboundCosts.service	The service that the inbound message price is referred to.
content.monthlyCosts	Information about costs per month.
content.monthlyCosts.price	The cost of the number per month.
content.monthlyCosts.currency	The currency of the price.
content.activationCosts	Information about activation costs.
content.activationCosts.price	The activation cost of the number.
content.activationCosts.currency	The currency of the price.
content.chargeInterval	The time interval used for charging the inbound calls (in seconds).
content.tollFree	Whether the number is Toll-Free.

Query Params

page

int32

Defaults to 0

The page number to retrieve, default value is 0 (meaning the first page)

size

int32

Defaults to 20

The number of items to retrieve, default value is 20.

sort

string

The field name that will be used to sort the results.

Body Params

fieldName

string

required

The name of the field to filter. Available values are: country (required), msisdn, service, areaCode (Works for the countries US and Canada only) and type ("VLN" or "TOLL_FREE", Works for the countries US and Canada only).

searchTerm

string

required

The exact value that the specified field must match.

searchOperator

string

Optional: The operator upon which the search operation will be executed. Possible values: 'is', 'contains', 'starts_with', 'ends_with'. If missing defaults to 'is'.

Headers

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Content-Type

string

required

Defaults to application/json

application/json

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400