API Referencenumbers

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

Authentication

AuthorizationBearer

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

Headers

X-Sub-Account-IdstringOptional

Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.

Request

This endpoint expects an object.
countrystringOptionalDefaults to US
areaCodestring or nullOptional
agentIdstring or nullOptional
typeenum or nullOptional
Allowed values:
imessageTypeenum or nullOptional
Allowed values:

Response

Successful Response
idstring
phoneNumberstring
countrystring
statusstring
createdAtdatetime
typestringOptionalDefaults to sms
agentIdstring or nullOptional
outboundSmsenumOptionalDefaults to enabled
Allowed values:
inboundCallsEnabledbooleanOptionalDefaults to true
readReceiptsEnabledbooleanOptionalDefaults to true
whatsappEnabledbooleanOptionalDefaults to false
dailyNewContactsobject or nullOptional
purchasedAtdatetime or nullOptional

Errors

422
Unprocessable Entity Error