v10

latestSwagger 2.02026-07-13203270.7 KB

Browse, reserve and purchase available phone numbers

Browses for available phone numbers to purchase.

Browses for available phone numbers to purchase. The response will be a randomized list of phone numbers available to purchase matching the browsing criteria. This operation is not paginated. Since the results are randomized, repeating the same request will not guarantee the same results.

post/availablePhoneNumbers/countries/{countryCode}/:browse

Path parameters

countryCodestring required

The ISO 3166-2 country code, e.g. US.

Query parameters

api-versionstring required

Version of API to invoke

Request body

phoneNumberType'geographic' | 'tollFree' | 'mobile' required

Represents the number type of the offering.

assignmentType'person' | 'application'

Represents the assignment type of the offering. Also known as the use case.

phoneNumberPrefixesstring[]

The phone number prefix to match. If specified, the search will be limited to phone numbers that start with the any of the given prefixes.

Example request

{
  "phoneNumberPrefixes": [
    "1425",
    "1626"
  ]
}

Response

A randomized list of phone numbers available to purchase matching the browsing criteria.