Phone Number Management (U.S. Only)
Buy a Phone Number
Purchase a new phone number
POST
/
phonenumbers
Phone numbers through the API can currently only be purchased in the U.S., for other countries please contact support. U.S. phone numbers are priced at $ 10.00 per month. If you cancel your phone number, you will be charged for the current month, but will not be charged again.
Authorizations
Authorization
string
headerrequiredYour API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Body
application/json
prefix
string
default: +1415The prefix of the phone number, for example +1415
for San Francisco. Only US can currently be purchased through the API, please contact us for other countries and we manually add them for you
agentId
string
The agent ID of the agent to use when an inbound call is received on the phone number
Response
200 - application/json
phoneNumberId
string
The phone number ID of the phone number resource
phoneNumber
string
The phone number, prefixed with the country code, for example, +1558873402
price
number
The monthly price of the phone number in USD
agentId
string
The agent ID of the agent that the phone number is assigned to. When making inbound calls, the agent will be called.