Order Toll-Free Numbers

Order toll-free phone numbers from carrier inventory

POST /v2/admin/phone-numbers/toll-free/order

Order Toll-Free Numbers

cURL

curl --request POST \
  --url https://api.voxo.co/v2/admin/phone-numbers/toll-free/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 123
}
'

200

{
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "branch": {
    "id": 123,
    "name": "<string>"
  },
  "callerIdName": "<string>",
  "pon": "<string>",
  "numbers": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

tenantId · number · required

Tenant ID

numbers · string[]

Phone numbers to order

callerIdName · string

Caller ID name (max 15 characters)

Maximum string length: 15

Response

200

application/json

Order confirmation

tenant · object · required

Show child attributes

branch · object · required

Show child attributes

callerIdName · string · required

Caller ID name

pon · string · required

Purchase order number

numbers · string[]

Ordered phone numbers