Skip to main content
DELETE
Delete a phone number

Path Parameters

phone_number_id
string
required

Response

Phone number successfully deleted

phone_number
string
required

The phone number

_id
string

Unique identifier for this phone number record

provider
string

Phone number provider

Allowed value: "sip"
friendly_name
string | null

A human-readable label for this phone number. Cannot be blank when provided.

sip_termination_uri
string | null

The SIP URI that outbound calls are sent to. The host must be an IP address or domain. Optional for inbound-only numbers.

sip_trunk_username
string | null

Username for authenticating with the SIP trunk provider

sip_trunk_password
string | null

Password for authenticating with the SIP trunk provider

inbound_agent_id
string | null

ID of the AI agent that handles incoming calls to this number. Cannot be blank when provided.

outbound_agent_id
string | null

ID of the AI agent used for outbound calls from this number. Cannot be blank when provided.

sip_infra_region
string | null

The infrastructure region for SIP routing

sip_infra_zones
string[] | null

Zones within a multi-zone sip_infra_region to register the number on. The zones that come up are returned as availability_zones. Only for organizations with multi-zone routing enabled.

call_concurrency
integer | null

Maximum number of concurrent calls allowed on this number

Required range: x >= 1
max_concurrent_inbound_calls
integer | null

Maximum number of concurrent inbound calls

Required range: x >= 0
max_concurrent_outbound_calls
integer | null

Maximum number of concurrent outbound calls

Required range: x >= 0
expires
integer | null

SIP registration expiry, in seconds

Required range: x >= 1
advanced
AdvancedSipConfig · object | null

Advanced SIP configuration

availability_zones
string[] | null

Zones the number is registered and available on. Omitted when not set.

workspace_id
string | null

Workspace the phone number belongs to