Phone Numbers

Create a phone number

Create a new phone number for the account. You can specify search criteria or let the system select a random number.

Path parameters

account_idstringRequired
The account for which the phone number should be created.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Phone number params
area_codestringOptionalformat: "^\d{3}$"
The desired area code for this phone number. If provided without type, the type will be inferred.
latitudedoubleOptional>=-90<=90
Latitude to search for nearby phone numbers. Must be used with longitude. If provided without type, type will be inferred as 'local'.
longitudedoubleOptional>=-180<=180
Longitude to search for nearby phone numbers. Must be used with latitude. If provided without type, type will be inferred as 'local'.
typeenumOptional

Whether the phone number is local or toll-free. Can be omitted if area_code or latitude/longitude are provided.

Allowed values:

Response

Phone number
idstring
Unique identifier for the phone number
numberstringformat: "phone-number"
The phone number in E.164 format
typeenum

Whether the phone number is local, toll-free, or short code

Allowed values: