Hanzo
OpenapiTel

Asks the carrier what is available to buy.

Asks the carrier what is available to buy.

GET /v1/tel/numbers/available

Addresshttps://api.hanzo.ai/v1/tel/numbers/available
MethodGET
Operationget_tel_numbers_available
AuthAuthorization: Bearer $HANZO_API_KEY

Asks the carrier what is available to buy. Nothing is recorded — a search is not a holding, and treating it as one is how inventory leaks.

Request

4 fields.

FieldInTypeRequiredDescription
Countryquerystring
Areaquerystring
Typequerystring
Limitqueryinteger

Response

StatusBodyMeaning
200numberListok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyNumber[]Data is the numbers, and which numbers depends on the route: a search answers what the carrier has available, a list answers what this org already holds.
data[].capablebodystring[]Capable is what the number can carry: any of "voice", "sms", "mms", "fax".
data[].countrybodystringCountry is the ISO 3166-1 alpha-2 code the number is issued under.
data[].currencybodystringCurrency is the ISO 4217 code Monthly is denominated in.
data[].e164bodystringE164 is the number in E.164: a leading + and digits only, no spaces or dashes.
data[].idbodystringID is the carrier's handle for the number, and the id every route here addresses it by.
data[].monthlybodyintegerMonthly is the recurring rental in the MINOR unit of Currency (cents for USD), exactly as the carrier quoted it.
data[].orgbodystringOrg is the tenant holding the number.
data[].typebodystringType is what kind of number it is: "local", "national", "tollfree" or "mobile".

Failure carries the platform error shape — see Errors.

Examples

hanzo tel numbers available

Tel API · All Hanzo APIs · Interactive reference

How is this guide?

On this page