POST
Create Phone Number

Authorizations

Authorization
string
header
required

Interactive user session: the login JWT, sent as Authorization: Bearer <token>.

Path Parameters

config_id
integer
required

Body

application/json

Create a new phone number under a telephony configuration.

address_normalized and address_type are computed server-side from address (and country_code if PSTN). address itself is stored verbatim for display.

address
string
required
Required string length: 1 - 255
country_code
string | null
Required string length: 2
label
string | null
Maximum string length: 64
inbound_workflow_id
integer | null
direction
enum<string>
default:inbound
Available options:
inbound,
outbound,
both
outbound_workflow_id
integer | null
is_active
boolean
default:true
is_default_caller_id
boolean
default:false
extra_metadata
Extra Metadata ┬╖ object

Response

Successful Response

id
integer
required
telephony_configuration_id
integer
required
address
string
required
address_normalized
string
required
address_type
string
required
is_active
boolean
required
is_default_caller_id
boolean
required
extra_metadata
Extra Metadata ┬╖ object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
country_code
string | null
label
string | null
inbound_workflow_id
integer | null
inbound_workflow_name
string | null
direction
string
default:inbound
outbound_workflow_id
integer | null
provider_sync
ProviderSyncStatus ┬╖ object | null

Result of pushing a phone-number change to the upstream provider.

Returned alongside create/update responses when the route attempted to sync inbound webhook configuration. ok=False is a warning, not a fatal error тАФ the DB write succeeded.