Sign in

v

latestOpenAPI 3.1.02026-08-087786217.1 KB
numbers

Create Number

Provision a new SMS-enabled phone number.

  1. Check number limit (lifetime limit)
  2. Search the account's configured SMS provider for available numbers
  3. Purchase the first available one
  4. Configure messaging and voice routing
  5. Store the number in our database
post/v1/numbers

Request body

countrystring
areaCodestring nullable
agentIdstring nullable

Response

Successful Response

idstring required
phoneNumberstring required
countrystring required
statusstring required
typestring
agentIdstring nullable
outboundSms'enabled' | 'activating' | 'registration_required'
createdAtstring date-time required