Skip to main content
POST
/
v1
/
phone-numbers
Create Phone Number
curl --request POST \
  --url https://api.sigmamind.ai/v1/phone-numbers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "friendlyName": "My Phone Number",
  "countryCode": "US",
  "areaCode": 415,
  "phoneNumber": "+14155552671",
  "inboundAgentId": "awTw7UKhOsLGiDbt",
  "outboundAgentId": "awTw7UKhOsLGiDbt",
  "outboundPhoneNumber": "+14155552671"
}
'
{
  "sipPhoneNumber": "+14155552671",
  "provider": "twilio",
  "inboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundAgentId": "D5D0p7TUs66TTAEAx",
  "outboundPhoneNumber": "+14155552671",
  "active": true,
  "friendlyName": "Support Line - US"
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

application/json
​
friendlyName
string

A user-friendly label for the phone number.

Maximum string length: 128
Example:

"My Phone Number"

​
countryCode
string

ISO 3166-1 alpha-2 country code (e.g. 'US', 'IN'). Required if phoneNumber is not provided.

Pattern: ^[A-Z]{2}$
Example:

"US"

​
areaCode
integer<int32>

Area/region code within the specified country for number selection.

Required range: 100 <= x <= 99999
Example:

415

​
phoneNumber
string

The exact phone number to purchase in E.164 format. If omitted, a number is auto-selected based on countryCode and areaCode.

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

"+14155552671"

​
inboundAgentId
string

The inbound AI agent ID to associate with this phone number.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
outboundAgentId
string

The outbound AI agent ID to associate with this phone number.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
outboundPhoneNumber
string

The outbound phone number in E.164 format, used for test calls.

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

"+14155552671"

Response

OK

​
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"

​
provider
enum<string>

The service provider associated with the phone number.

Available options:
twilio, telnyx, byo
Example:

"twilio"

​
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

​
friendlyName
string

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

Example:

"Support Line - US"