Skip to navigation
API Referencenumbers

Create Number

Provision a new phone number from the account’s configured SMS provider (or an iMessage line with type=imessage). Optional externalId tags the number with your own identifier; see PATCH /v1/numbers/{id}.

Authentication

AuthorizationBearer

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

Headers

X-Sub-Account-IdstringOptional

Request

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

Response

Successful Response
idstring
phoneNumberstring
countrystring
statusstring
createdAtdatetime
typestringOptionalDefaults to sms
agentIdstring or nullOptional
outboundSmsenumOptionalDefaults to enabled

Outbound SMS readiness for this exact number: activating means campaign attachment is in progress; enabled means confirmed; registration_required means registration or attachment is still needed. Check the number and registration in the same account/sub-account scope. See /sms-registration.

Allowed values:
voiceRoutingobject or nullOptional

Where this number’s inbound calls go. Set it with PATCH /v1/numbers/{number_id}/voice-routing.

sipTrunkingEligiblebooleanOptionalDefaults to false

True when this number can be routed to a SIP trunk via PATCH /v1/numbers/{number_id}/voice-routing.

inboundCallsEnabledbooleanOptionalDefaults to true
readReceiptsEnabledbooleanOptionalDefaults to true
whatsappEnabledbooleanOptionalDefaults to false
dailyNewContactsobject or nullOptional
externalIdstring or nullOptional
rcsFallbackForAliasstring or nullOptional
expiresAtstring or nullOptional
purchasedAtdatetime or nullOptional
renewsAtstring or nullOptional
Scheduled renewal of this number's monthly fee, ISO 8601 UTC. Null when no renewal is scheduled or its date is not known.

Errors

422
Unprocessable Entity Error