v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

View all the available numbers with filters

post/numbers/available/search

Query parameters

pageinteger

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

sizeinteger

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

sortstring

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

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

application/json

Request body

fieldNamestring 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).

searchTermstring required

The exact value that the specified field must match.

searchOperatorstring

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

Response

200

totalElementsinteger

lastboolean

totalPagesinteger

numberOfElementsinteger

firstboolean

sizeinteger

numberinteger

Example response

{
  "content": [
    {
      "msisdn": "+1201xxxxxxxx",
      "country": "US",
      "services": [
        "Sms"
      ],
      "inboundCosts": [
        {
          "price": 0.04,
          "currency": "USD",
          "service": "Sms"
        }
      ],
      "monthlyCosts": {
        "price": 0.3,
        "currency": "USD"
      },
      "activationCosts": {
        "price": 0.1,
        "currency": "USD"
      },
      "chargeInterval": 1
    }
  ],
  "totalElements": 1,
  "last": true,
  "totalPages": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 20
}