Hanzo
OpenapiTel

Provisions with the carrier FIRST and records second.

Provisions with the carrier FIRST and records second.

POST /v1/tel/numbers

Addresshttps://api.hanzo.ai/v1/tel/numbers
MethodPOST
Operationpost_tel_numbers
AuthAuthorization: Bearer $HANZO_API_KEY

Provisions with the carrier FIRST and records second. The other order records a holding that may not exist, and a number the platform believes it owns but cannot use is worse than one it failed to buy.

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
e164bodystringE164 is the number to buy, in E.164 (a leading + and digits), exactly as the search returned it.

Response

StatusBodyMeaning
201Numbercreated

201 body — 8 fields.

FieldInTypeAlwaysDescription
capablebodystring[]Capable is what the number can carry: any of "voice", "sms", "mms", "fax".
countrybodystringCountry is the ISO 3166-1 alpha-2 code the number is issued under.
currencybodystringCurrency is the ISO 4217 code Monthly is denominated in.
e164bodystringE164 is the number in E.164: a leading + and digits only, no spaces or dashes.
idbodystringID is the carrier's handle for the number, and the id every route here addresses it by.
monthlybodyintegerMonthly is the recurring rental in the MINOR unit of Currency (cents for USD), exactly as the carrier quoted it.
orgbodystringOrg is the tenant holding the number.
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 create

Tel API · All Hanzo APIs · Interactive reference

How is this guide?

On this page