Skip to navigation

Import a SIP phone number

Deprecated
View as Markdown

Deprecated. Use POST /sip-trunk/inbound and POST /sip-trunk/outbound instead. One resource per direction, and the only way to configure a trunk that answers extensions without a phone number. This endpoint keeps working for 45 days after the trunks rework’s release (responses carry a Deprecation: true header), then returns 404; the concrete sunset date is published on the Deprecation Notices page and in the changelog. See the Telephony API migration guide.

Bring your own SIP trunk by importing an existing phone number with its SIP termination URL. Atoms creates both inbound and outbound SIP trunks so your number works for making and receiving calls through the platform.

If name is omitted, the phone number itself is used as the name.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
phoneNumberstringRequired

Your existing phone number. E.164 format is recommended but not enforced server-side — any non-empty string is accepted.

sipTerminationUrlstringRequired

Your SIP provider's termination host — a hostname or IP address, optionally with a port (e.g. "sip.your-provider.com:5060"). Full SIP URIs ("sip:" / "sips:") are also accepted and automatically normalized to the bare host.

namestringOptional
A friendly display name for this number
sipUsernamestringOptional

Username for SIP authentication (if your trunk requires it)

sipPasswordstringOptional

Password for SIP authentication (if your trunk requires it)

cpsLimitdoubleOptional1-50Defaults to 1

Calls-per-second cap for this imported trunk. Defaults to 1 CPS (the safe floor for an unknown trunk). Values above 50 are rejected with "CPS limit cannot exceed 50"; values below 1 are rejected with "CPS limit must be at least 1". When a trunk already exists on the same carrier address, its existing CPS setting is kept and this value is ignored.

Response headers

Deprecationboolean

Always true; this surface is the deprecated compatibility bridge.

Response

Phone number imported; both trunks created

statusbooleanOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error