POST
/
api
/
v1
/
phone-numbers
/
purchase
curl --request POST \
  --url https://cx-staging-three.fly.dev/api/v1/phone-numbers/purchase \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phoneNumber": "+1234567890",
  "countryCode": "US"
}'
{
  "phone": "+1234567890",
  "agentId": "c84951a0-8354-40b0-a1ee-c43d259f6a40",
  "country": "US"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
Input data for purchasing a phone number
​
phoneNumber
string
required

The phone number to purchase

Example:

"+1234567890"

​
countryCode
string
required

The country code for the phone number

Example:

"US"

Response

201
application/json
Phone number purchased successfully
​
phone
string
required

The phone number

Example:

"+1234567890"

​
agentId
string
required

The agent ID

Example:

"c84951a0-8354-40b0-a1ee-c43d259f6a40"

​
country
string
required

The country code

Example:

"US"