Skip to main content

SipTrunkCreateRequest

labelstringrequired
registrarUristringrequired

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.

transportstringrequired

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
usernamestringrequired
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. 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
    SipTrunkCreateRequest
    {
    "label": "string",
    "registrarUri": "sip:sip.provider.example",
    "proxyUri": "string",
    "outboundProxyUri": "string",
    "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"
    }