Skip to main content
POST
Import Phone Number

Authorizations

Authorization
string
header
required

API key must be provided as: Bearer <api_key>

Body

application/json
phoneNumber
string
required

Phone number in E.164 format (e.g. +4917642048466)

terminationUri
string
required

SIP termination URI for routing calls

authUsername
string
required

Username for SIP authentication

authPassword
string
required

Password for SIP authentication

transport
enum<string>
default:TCP

SIP transport protocol for the imported number. Defaults to TCP.

Available options:
TCP,
UDP,
TLS
inOutboundPool
boolean
default:true

Whether to include this phone number in the outbound call pool. Defaults to true.

Response

Phone number imported successfully

type
enum<string>

Resource type identifier

Available options:
PhoneNumber
id
string<uuid>

Unique identifier for the phone number

phoneNumber
string

Phone number in E.164 format (e.g. +4917642048466)

inOutboundPool
boolean

Whether this phone number is available for outbound calls

phoneNumberType
enum<string> | null

Type of phone number (local or mobile)

Available options:
local,
mobile,
null
createdAt
string<date-time>

When the phone number was added to the account