GET
/
v1
/
phone-number
/
{phoneNumber}
Get Phone Number
curl --request GET \
  --url https://api.sigmamind.ai/v1/phone-number/{phoneNumber} \
  --header 'X-API-Key: <api-key>'
"Object"

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
phoneNumber
string
required

The caller’s phone number in E.164 format

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"