Get Phone Number - SigmaMind AI

{ "sipPhoneNumber": "+14155552671", "provider": "twilio", "inboundAgentId": "agent_D5D0p7TUs66TTAEAx", "outboundAgentId": "agent_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.

Path Parameters

phoneNumber

string

required

Phone number to retrieve, in +E.164 format. Obtained from the sipPhoneNumber field in the Create, Import, or List Phone Numbers response.

Response

Caller phone number used to dial contacts in this campaign. This number appears as the caller ID on recipients' devices.

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:

"agent_D5D0p7TUs66TTAEAx"

outboundAgentId

string

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

Example:

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