v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB

Phone Numbers

Import a SIP phone number

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.

post/product/import-phone-number

Request body

phoneNumberstring required

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

sipTerminationUrlstring required

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.

namestring

A friendly display name for this number

sipUsernamestring

Username for SIP authentication (if your trunk requires it)

sipPasswordstring

Password for SIP authentication (if your trunk requires it)

Example request

{
  "phoneNumber": "+14155551234",
  "sipTerminationUrl": "trunk.your-provider.com",
  "name": "Main Support Line",
  "sipUsername": "my-sip-user",
  "sipPassword": "my-sip-password"
}

Response

Phone number imported successfully

statusboolean

Example response

{
  "status": true,
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "productType": "custom",
    "isActive": true,
    "attributes": {
      "name": "Main Support Line",
      "phoneNumber": "+14155551234",
      "outboundSipTrunkId": "ST_xxxxxxxxxxxx",
      "inboundSipTrunkId": "ST_xxxxxxxxxxxx"
    },
    "createdAt": "2026-03-16T12:00:00.000Z",
    "updatedAt": "2026-03-16T12:00:00.000Z"
  }
}