Skip to main content
POST
Import a phone number from a provider (Twilio or LiveKit SIP).
For Twilio numbers, you must first create a Twilio integration and provide its ID. For SIP numbers, LiveKit trunks are automatically created.

Headers

string
required
Your API key for authentication.
string
required
The organization ID.
string
required
Must be application/json.

Permissions

  • phone_numbers:create (admin, agent_manager)

Request Body

string
required
Phone number in E.164 format (e.g., +12345678900).
string
required
Provider type: twilio or sip.
boolean
default:"false"
Whether the number supports inbound calls.
boolean
default:"false"
Whether the number supports outbound calls.

Twilio-Specific Parameters

string
Integration ID (required for Twilio provider). Must be a valid Twilio integration.

SIP-Specific Parameters (LiveKit)

string
Name for the SIP trunk.
string
SIP username for authentication.
string
SIP password for authentication.
string
SIP server address (required for outbound).
string
Room name pattern for inbound calls.
string
Optional PIN for inbound calls (4-10 characters).
string
default:"allow"
SIP media encryption mode: disable, allow, or require.

Response

boolean
Indicates if the import was successful.
string
Human-readable success message.
object
The created phone number object.

Errors

object
Missing required fields or invalid provider.
object
Integration not found (for Twilio).
object
Integration belongs to different organization.
object
Phone number already exists in the system.