Skip to main content

SipTrunk

idstring<uuid>
labelstring
registrarUristring

Provider registration target, or the outbound SIP destination when authenticationMode is ip.

Example: sip:sip.provider.example
proxyUristring | nullnullable
outboundProxyUristring | nullnullable
transportstring

Possible values: [udp, tcp, tls]

authenticationModestring

Possible values: [registration, digest, ip]

usernamestring
authUsernamestring
providerProfilestring

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

fromDomainstring | nullnullable
fromUserModestring

Possible values: [e164, auth_username, custom]

customFromUserstring | nullnullable
expiresSecondsinteger
providerSourceIpsstring[]

Explicit inbound carrier source IPs or CIDRs trusted by IP authentication. These are separate from registrarUri, the outbound destination.

customHeaders object[]
  • Array [
  • namestringrequired

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

    valuestringrequired
  • ]
  • enabledboolean
    registrationStatusstring
    registrationLastCodeinteger | nullnullable
    registrationLastReasonstring | nullnullable
    contactUsernamestring
    contactUristring | nullnullable
    forcedSocketstring | nullnullable
    contactHostModestring

    Controls whether the OpenSIPS Contact header uses the tenant SIP domain or the edge public IP.

    Possible values: [sip_domain, public_ip]

    contactDomainstring
    publicIpstring | nullnullable
    sipDomainstring | nullnullable
    SipTrunk
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "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": 0,
    "providerSourceIps": [
    "string"
    ],
    "customHeaders": [
    {
    "name": "string",
    "value": "string"
    }
    ],
    "enabled": true,
    "registrationStatus": "string",
    "registrationLastCode": 0,
    "registrationLastReason": "string",
    "contactUsername": "string",
    "contactUri": "string",
    "forcedSocket": "string",
    "contactHostMode": "sip_domain",
    "contactDomain": "string",
    "publicIp": "string",
    "sipDomain": "string"
    }