Hanzo
OpenapiTel

Lists the phone numbers this org HOLDS — the ones it has bought and not…

Lists the phone numbers this org HOLDS — the ones it has bought and not released.

GET /v1/tel/numbers

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

Lists the phone numbers this org HOLDS — the ones it has bought and not released. Distinct from the availability search one path down (/numbers/available), which asks the carrier what could be bought: this answers only from our own store, so it is what an org owns rather than what it could own.

Request

GET /v1/tel/numbers takes no parameters and no body — the credential is the whole request.

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 list

Tel API · All Hanzo APIs · Interactive reference

How is this guide?

On this page