v1

latestOpenAPI 3.0.12026-07-226992320.0 KB

Phone Numbers

Get Phone Number

Retrieves the full configuration of a single phone number by its +E.164 value. Returns assigned agents, active status, provider, and SIP configuration for BYO numbers.

get/v1/phone-numbers/{phoneNumber}

Path parameters

phoneNumberstring required

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

Response

sipPhoneNumberstring

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

provider'twilio' | 'telnyx' | 'byo'

The service provider associated with the phone number.

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",
  "provider": "twilio",
  "inboundAgentId": "agent_D5D0p7TUs66TTAEAx",
  "outboundAgentId": "agent_D5D0p7TUs66TTAEAx",
  "outboundPhoneNumber": "+14155552671",
  "active": true,
  "terminationSipURI": "sip.telnyx.com",
  "friendlyName": "Support Line - US"
}