POST
/
v1
/
phone-number
Create Phone Number
curl --request POST \
  --url https://api.sigmamind.ai/v1/phone-number \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "friendlyName": "My Phone Number",
  "provider": "twilio",
  "phoneNumber": 14155552671,
  "trunkName": "My Trunk",
  "trunkUsername": "username",
  "trunkPassword": "password",
  "terminationSipURI": "sip.telnyx.com"
}'
"Object"

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
provider
enum<string>
required

The telecom provider of the phone number.

Available options:
twilio, telnyx, byo
Example:

"twilio"

​
friendlyName
string

A user-friendly label for the phone number.

Example:

"My Phone Number"

​
phoneNumber
string

The phone number in E.164 format. Required when bringing your own number.

Example:

14155552671

​
trunkName
string

The name of the trunk associated with this phone number.

Example:

"My Trunk"

​
trunkUsername
string

The trunk username used for outbound calls. Must be set up in your provider account.

Example:

"username"

​
trunkPassword
string

The trunk password is used for outbound calls. Must be set up in your provider account.

Example:

"password"

​
terminationSipURI
string

The SIP URI for terminating calls, provided by the telecom provider.

Example:

"sip.telnyx.com"

Response

OK

Phone number details of the caller

​
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

​
terminationSipURI
string

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

Example:

"sip.telnyx.com"