Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Phone Numbers

Update Phone Number

Partially updates the configuration of an existing phone number. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated phone number record.

patch/v1/phone-numbers/{phoneNumber}

Path parameters

phoneNumberstring required

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

Request body

friendlyNamestring

Updated human-readable label for this phone number. Used to identify it in listings and dashboards. Omit to leave the existing label unchanged.

inboundAgentIdstring

Updated agent ID for handling inbound calls received on this number. Replaces the currently assigned inbound agent. All inbound calls arriving after this update will be routed to the new agent. Pass null to remove the inbound agent assignment. Omit to leave the existing assignment unchanged.

outboundAgentIdstring

Updated agent ID for handling outbound calls made from this number. Replaces the currently assigned outbound agent. All outbound calls placed after this update will use the new agent. Pass null to remove the outbound agent assignment. Omit to leave the existing assignment unchanged.

terminationSipUristring

Updated SIP URI of the termination endpoint used to route outbound calls through the SIP trunk. Applicable only for BYO numbers imported via SIP trunking — has no effect on SigmaMind-provisioned numbers. Obtain this value from your telecom provider's SIP trunking configuration. Omit to leave the existing SIP URI unchanged.

trunkUsernamestring

Updated username for authenticating outbound calls on the SIP trunk. Applicable only for BYO numbers — must match the trunk username in your provider's account. Omit to leave the existing username unchanged.

trunkPasswordstring

Updated password for authenticating outbound calls on the SIP trunk. Applicable only for BYO numbers — must match the trunk password in your provider's account. Stored securely and never returned in API responses. Omit to leave the existing password unchanged.

outboundPhoneNumberstring

Updated default destination number for test calls placed from this number, in +E.164 format. Used to verify the number and trunk configuration are working correctly. Must be a valid number capable of receiving calls. Omit to leave the existing test number unchanged.

Example request

{
  "friendlyName": "Support Line - US",
  "inboundAgentId": "awTw7UKhOsLGiDbt",
  "outboundAgentId": "awTw7UKhOsLGiDbt",
  "terminationSipUri": "sip.telnyx.com",
  "trunkUsername": "my_trunk_user",
  "trunkPassword": "tr!nkP@ssword",
  "outboundPhoneNumber": "+14155552671"
}

Response

OK

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