Import a SIP phone number

POST

https://api.smallest.ai/atoms/v1/product/import-phone-number

POST

/atoms/v1/product/import-phone-number

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.phone_numbers.import_a_sip_phone_number(
8     phone_number="+14155551234",
9     sip_termination_url="trunk.your-provider.com",
10     name="Main Support Line",
11     sip_username="",
12     sip_password="",
13 )

1 {
2   "status": true,
3   "data": {
4     "_id": "507f1f77bcf86cd799439011",
5     "productType": "custom",
6     "isActive": true,
7     "attributes": {
8       "name": "Main Support Line",
9       "phoneNumber": "+14155551234",
10       "outboundSipTrunkId": "ST_xxxxxxxxxxxx",
11       "inboundSipTrunkId": "ST_xxxxxxxxxxxx"
12     },
13     "agentId": "string",
14     "createdAt": "2026-03-16T12:00:00.000Z",
15     "updatedAt": "2026-03-16T12:00:00.000Z"
16   }
17 }

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, a name is auto-generated from the phone number and user ID.

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)

Response

Phone number imported successfully

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error