Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for provisioning a new phone number for an agent

agentId
required

Agent to assign the provisioned phone number to

Pattern: ^[0-9a-z]+$
countryCode
string
default:US

ISO 3166-1 alpha-2 country code for number selection

Pattern: ^[A-Za-z]{2}$
numberType
enum<string>

Phone number type to provision (treated as local when omitted)

Available options:
local,
mobile,
national,
toll_free,
shared_cost
areaCode
string

Preferred area code for the phone number

capabilities
enum<string>[]

Required capabilities for the phone number

Communication capability type

Available options:
sms,
mms,
voice

Response

200 - application/json

OK

Provisioned phone number resource with provider and compliance details

id
string
required

Unique identifier for the provisioned phone record

phoneNumber
string
required

E.164 formatted phone number that was provisioned

providerId
string | null
required

Opaque carrier-side identifier for the number

capabilities
object
required

Active communication capabilities for this number

tenDlcStatus
enum<string>
required

10DLC campaign registration status for A2P SMS compliance

Available options:
PENDING,
REGISTERED,
REJECTED,
NOT_REQUIRED,
UNREGISTERED
isPrimary
boolean
required

Whether this is the primary phone number for the agent

createdAt
string<date-time>
required

ISO 8601 timestamp when the number was provisioned