Skip to main content

SipTrunkPatchRequest

All fields are optional on PATCH. Include password only to rotate the stored provider secret.

labelstring
registrarUristring

Provider registrar SIP URI or host. For IP authentication, this is the outbound SIP destination. Include a non-standard port when needed, for example sip:registrar.example.com:5070.

Example: sip:sip.provider.example
proxyUristring
outboundProxyUristring

Optional outbound SIP proxy used by the OpenSIPS registration projection.

outboundDialPrefixPolicy object

Provider-facing dial-prefix policy. OpenSIPS applies it after final destination selection; Retell/API destinations remain unchanged.

defaultPrefixstringrequired

Possible values: <= 32 characters, Value must match regular expression ^[0-9*#]*$

Default value:
stripLeadingPlusbooleanrequired
Default value: true
rules object[]required

Possible values: <= 50

  • Array [
    • namestringrequired

    Possible values: non-empty and <= 80 characters

    matchTypestringrequired

    Match the first X normalized destination digits, or a three-digit North American Numbering Plan area code.

    Possible values: [starts_with, nanp_area_code]

    matchValuestringrequired

    Possible values: Value must match regular expression ^[0-9]{1,15}$

    dialPrefixstringrequired

    Possible values: <= 32 characters, Value must match regular expression ^[0-9*#]*$

    priorityintegerrequired

    Possible values: >= 1 and <= 10000

    enabledbooleanrequired
  • ]
    • deviceConcurrencyLimitinteger | nullnullable

    Optional hard limit for simultaneous carrier-facing calls on this SIP extension/device. Applies to inbound and outbound provider legs.

    Possible values: >= 1 and <= 1000

    Default value: null
    devicePoolKeystring | nullnullable

    Optional tenant-scoped key shared by interchangeable SIP devices. Use the same key on each extension in a provider account; outbound calls are atomically sent to the least-loaded available member. Requires deviceConcurrencyLimit.

    Possible values: Value must match regular expression ^[A-Za-z0-9][A-Za-z0-9._:-]{0,79}$

    Default value: null
    transportstring

    Possible values: [udp, tcp, tls]

    authenticationModestring

    IP authentication requires providerSourceIps and no password. Registration and digest authentication require a password.

    Possible values: [registration, digest, ip]

    Default value: registration
    usernamestring
    authUsernamestring

    Optional SIP digest auth username. Defaults to username when omitted.

    providerProfilestring

    Possible values: [default, telnyx_like, voipms_like, bandwidth_like, custom]

    Default value: default
    fromDomainstring
    fromUserModestring

    Possible values: [e164, auth_username, custom]

    Default value: e164
    customFromUserstring
    expiresSecondsinteger

    Possible values: >= 60 and <= 3600

    Default value: 300
    providerSourceIpsstring[]

    Inbound carrier source IPs or CIDRs required for IP authentication; IP authentication rejects an empty list. For topology hiding, keep a non-empty carrier allowlist and authorize the sipsandwich public service VIP in both signaling directions. They are not derived from the outbound registrarUri.

    customHeaders object[]

    Possible values: <= 20

  • Array [
    • namestringrequired

    Possible values: Value must match regular expression ^[A-Za-z0-9-]+$

    valuestringrequired
  • ]
    • contactHostModestring

    Use public_ip when the carrier rejects FQDN values in the REGISTER Contact header.

    Possible values: [sip_domain, public_ip]

    Default value: sip_domain
    enabledboolean
    topologyHidingEnabledboolean

    Opt in to signaling-only SIP topology hiding. New connections default to off; when reconciling an existing connection, omitting this field preserves its current value and explicit false disables it. Requires IP or digest authentication; registration-mode connections are unsupported because their REGISTER Contact and send socket are node-specific. Keep providerSourceIps non-empty as the carrier source allowlist and authorize the sipsandwich public service VIP in both signaling directions. The deployment readiness gate must be ready before enabling. Media and SDP are unchanged.

    dedicatedSipIpEnabledboolean

    Opt this connection into the configured shared dedicated SIP IP pool. Requires a paid, ready entitlement and a certified pool; it does not allocate a tenant-exclusive address.

    Default value: false
    SipTrunkPatchRequest
    {
      "label": "string",
      "registrarUri": "sip:sip.provider.example",
      "proxyUri": "string",
      "outboundProxyUri": "string",
      "outboundDialPrefixPolicy": {
        "defaultPrefix": "",
        "stripLeadingPlus": true,
        "rules": [
          {
            "name": "string",
            "matchType": "starts_with",
            "matchValue": "string",
            "dialPrefix": "string",
            "priority": 0,
            "enabled": true
          }
        ]
      },
      "deviceConcurrencyLimit": null,
      "devicePoolKey": null,
      "transport": "udp",
      "authenticationMode": "registration",
      "username": "string",
      "authUsername": "string",
      "providerProfile": "default",
      "fromDomain": "string",
      "fromUserMode": "e164",
      "customFromUser": "string",
      "expiresSeconds": 300,
      "providerSourceIps": [
        "string"
      ],
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "contactHostMode": "sip_domain",
      "enabled": true,
      "topologyHidingEnabled": true,
      "dedicatedSipIpEnabled": false
    }