v1

latestOpenAPI 3.0.12026-07-226992320.0 KB

Phone Numbers

Import Phone Number

Imports an existing phone number via SIP trunking (BYO). Provide the number in +E.164 format along with SIP credentials (trunkUsername, trunkPassword, terminationSipURI). Returns the imported number, including its sipPhoneNumber.

post/v1/phone-numbers/import

Request body

friendlyNamestring

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.

phoneNumberstring

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.

inboundAgentIdstring

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.

outboundAgentIdstring

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.

trunkUsernamestring

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.

trunkPasswordstring

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.

terminationSipURIstring

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.

outboundPhoneNumberstring

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.

Example request

{
  "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"
}

Response

Created

sipPhoneNumberstring

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

inboundAgentIdstring

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

outboundAgentIdstring

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

outboundPhoneNumberstring

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

activeboolean

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

terminationSipURIstring

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

friendlyNamestring

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

Example response

{
  "sipPhoneNumber": "+14155552671",
  "inboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundPhoneNumber": "+14155552671",
  "active": true,
  "terminationSipURI": "sip.telnyx.com",
  "friendlyName": "Support Line - US"
}