PATCH
/
v1
/
phone-numbers
/
{phone_number_id}

Path Parameters

phone_number_id
string
required

Body

application/json
friendly_name
string | null

A human-readable label for this phone number to help identify its purpose

inbound_agent_id
string | null

ID of the AI agent that will handle incoming calls to this number

outbound_agent_id
string | null

ID of the AI agent that will be used when making outbound calls from this number

sip_termination_uri
string | null

The SIP URI where calls to this Import Phone Number should be terminated

sip_trunk_password
string | null

Password for authenticating with the SIP trunk provider

sip_trunk_username
string | null

Username for authenticating with the SIP trunk provider

Response

200 - application/json
phone_number
string
required

The phone number in E.164 format (e.g., +14155552671)

_id
string

Unique identifier for this phone number record

friendly_name
string | null

A human-readable label for this phone number

inbound_agent_id
string | null

ID of the AI agent handling incoming calls

outbound_agent_id
string | null

ID of the AI agent used for outbound calls

provider
enum<string>
default:
sip

Indicates this is an Import Phone Number (SIP provider)

Available options:
sip
sip_infra_region
enum<string>
default:
global

The infrastructure region for SIP routing: 'global' or 'bd' (Bangladesh)

Available options:
global,
bd
sip_termination_uri
string | null

The SIP URI where calls are terminated

sip_trunk_password
string | null

Password for SIP trunk authentication

sip_trunk_username
string | null

Username for SIP trunk authentication