Skip to main content
POST
/
v1
/
phone-numbers
/
import
Import Phone Number
curl --request POST \
  --url https://api.sigmamind.ai/v1/phone-numbers/import \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "friendlyName": "BYO - Main Office Line",
  "phoneNumber": "+14155552671",
  "inboundAgentId": "awTw7UKhOsLGiDbt",
  "outboundAgentId": "awTw7UKhOsLGiDbt",
  "trunkUsername": "my_trunk_user",
  "trunkPassword": "tr!nkP@ssword",
  "terminationSipURI": "sip.telnyx.com",
  "outboundPhoneNumber": "+14155552671"
}
'
{
  "sipPhoneNumber": "+14155552671",
  "inboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundPhoneNumber": "+14155552671",
  "active": true,
  "terminationSipURI": "sip.telnyx.com",
  "friendlyName": "Support Line - US"
}

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Body

application/json

Request body to import an existing phone number you own into SigmaMind via SIP trunking (BYO — Bring Your Own number). Use this when the number is already provisioned with an external telecom provider and you want SigmaMind to route calls through it using your own SIP trunk credentials. The number is not purchased — it remains with your provider.

​
friendlyName
string

Human-readable label for this phone number. Used to identify it in listings and dashboards. If omitted, the number itself is used as the display name.

Maximum string length: 128
Example:

"BYO - Main Office Line"

​
phoneNumber
string

The phone number being imported, in +E.164 format (e.g., +14155552671). Must be a number you own and have configured on your external SIP trunk. This number will be registered in SigmaMind and used as the caller ID for outbound calls and the destination for inbound calls routed through your trunk.

Pattern: ^\+[1-9][0-9]{6,14}$
Example:

"+14155552671"

​
inboundAgentId
string

Unique identifier of the agent that will handle inbound calls received on this number. When a call arrives at this number via the SIP trunk, it is routed to this agent automatically. If omitted, inbound calls will not be handled by an agent until one is assigned.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
outboundAgentId
string

Unique identifier of the agent that will handle outbound calls made from this number. When this number is used as the caller ID in an outbound call, this agent manages the conversation. If omitted, the agent must be specified explicitly at call creation time.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
trunkUsername
string

Username credential for authenticating outbound calls on your SIP trunk. Must match the trunk username configured in your telecom provider's account. Required for outbound call routing through the trunk.

Maximum string length: 128
Example:

"my_trunk_user"

​
trunkPassword
string

Password credential for authenticating outbound calls on your SIP trunk. Must match the trunk password configured in your telecom provider's account. Required for outbound call routing through the trunk. Stored securely and never returned in API responses.

Maximum string length: 128
Example:

"tr!nkP@ssword"

​
terminationSipURI
string

SIP URI of the termination endpoint provided by your telecom provider. SigmaMind sends outbound calls to this address to route them through your trunk. Obtain this value from your provider's SIP trunking configuration (e.g., 'sip.telnyx.com', 'sip.twilio.com'). Required for outbound call delivery.

Maximum string length: 253
Example:

"sip.telnyx.com"

​
outboundPhoneNumber
string

Default destination number dialled during test calls initiated from this phone number, in +E.164 format. Used to verify the SIP trunk is connected and routing calls correctly. Must be a valid number capable of receiving calls. If omitted, test calls cannot be placed until this is configured.

Pattern: ^\+[1-9][0-9]{6,14}$
Example:

"+14155552671"

Response

Created

​
sipPhoneNumber
string

The caller’s phone number in +E.164 format. This number must be obtained from SigmaMind or configured using SIP trunking with SigmaMind.

Example:

"+14155552671"

​
inboundAgentId
string

Default agent ID assigned to handle inbound calls for this phone number.

Example:

"D5D0p7TUs66TTAEAx"

​
outboundAgentId
string

Default agent ID assigned to handle outbound calls for this phone number.

Example:

"D5D0p7TUs66TTAEAx"

​
outboundPhoneNumber
string

The default outbound phone number of the callee, represented in +E.164 format

Example:

"+14155552671"

​
active
boolean

Indicates whether the phone number is currently active and available for use.

Example:

true

​
terminationSipURI
string

The SIP URI of the phone number, provided by the service provider for call termination.

Example:

"sip.telnyx.com"

​
friendlyName
string

A user-friendly display name assigned to this phone number.

Example:

"Support Line - US"