ZAzavudev

Search available phone numbers

Changed on

Search for available phone numbers to purchase by country and type.

get/v1/phone-numbers/available

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/phone-numbers/available
  • Auth
    HTTP bearer

Query parameters

countryCodestring required

Two-letter ISO country code.

type'local' | 'national' | 'tollFree' | 'mobile'

Type of phone number. mobile is stocked in countries where no geographic (local) or non-geographic (national) inventory exists, and in several markets it is the only type that can receive SMS.

Type of phone number to search for.

containsstring

Search for numbers containing this string: digits, or letters for vanity numbers. Spaces, dashes, dots and parentheses are ignored, so 1-800 searches 1800.

capabilitiesstring
Example:voice,sms

Comma-separated capabilities the number must have: sms, voice, mms. Numbers missing any of them are dropped.

limitinteger

Maximum number of results to return.

Response

List of available phone numbers. An empty items means the country is served but nothing matched these filters, including a number type the country does not sell (retry with another type) and a contains pattern no number matches.

Example response

{
  "items": [
    {
      "phoneNumber": "+15551234567",
      "friendlyName": "(555) 123-4567",
      "locality": "San Francisco",
      "region": "CA"
    }
  ]
}

Changes