Import a SIP phone number

POST

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

POST

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

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/product/import-phone-number"
4 
5 payload = {
6     "phoneNumber": "+14155552678",
7     "sipTerminationUrl": "sip:trunk.voipprovider.net",
8     "name": "Customer Service Line",
9     "sipUsername": "cs_user_01",
10     "sipPassword": "securePass123!"
11 }
12 headers = {
13     "Authorization": "Bearer <token>",
14     "Content-Type": "application/json"
15 }
16 
17 response = requests.post(url, json=payload, headers=headers)
18 
19 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "_id": "60d5ec49f1a4c12d4c8b4567",
5     "productType": "custom",
6     "isActive": true,
7     "attributes": {
8       "name": "Customer Service Line",
9       "phoneNumber": "+14155552678",
10       "outboundSipTrunkId": "ST_9f8e7d6c5b4a3",
11       "inboundSipTrunkId": "ST_1a2b3c4d5e6f7"
12     },
13     "agentId": "a1b2c3d4e5f6789012345678",
14     "createdAt": "2024-06-10T09:15:00.000Z",
15     "updatedAt": "2024-06-10T09:15: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.

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 in E.164 format

sipTerminationUrlstringRequired

The SIP URI where calls should be routed to your infrastructure

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