Skip to main content
POST
Purchase an available phone number

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Headers

x-public-key
string
required
x-private-key
string
required
organization
string
required

Body

application/json
number
string
required

The phone number to purchase.

Minimum string length: 7
Example:

"+918155550101"

countryCode
string
required

2-letter ISO country code.

Required string length: 2
Example:

"IN"

numberType
enum<string>
required
Available options:
local
Example:

"local"

provider
string
default:miraiminds
Example:

"miraiminds"

setupFeeCents
integer
default:0

One-time setup fee in cents.

Required range: x >= 0

Response

Phone number purchased successfully

message
string
Example:

"Phone number purchased successfully"

data
object

A telephony number owned by the organization.