v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Connections

Get All Connections for a Domain

get/domains/{domain}/connections

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Query parameters

device-sip-registration-uristring

termination-matchstring

resellerstring

route-chainstring

user-scopestring

Response

connection-orig-match-patternstring required

This is the connection's origination match pattern

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

descriptionstring

This is the connection's description

connection-term-match-patternstring

Defaulted to connection-orig-match-pattern

connection-audio-relay-enabledstring

Available options are "yes", "optional", "no". "Yes" will set the connection audio realy to "automatic". "Optional" will set it to "none". "No" will set it to "never". Default will be "yes".

connection-addressstring

This is the connection's address

dial-planstring

This is the connection's dial plan

dial-policystring

This is the connection's dial policy

limits-max-active-calls-originteger

This is the connection's limit of maximum originating calls

limits-max-active-calls-terminteger

This is the connection's limit of maximum terminating calls

limits-max-active-calls-totalinteger

This is the connection's limit of maximum total calls

connection-linked-billing-userstring

This is the connection's linked billing user

connection-sip-registration-usernamestring

This is the connection's authorized username

connection-sip-registration-passwordstring

This is the connection's password

connection-sip-registration-realmstring

This is the connection's authentication realm

connection-orig-enabled'yes' | 'no'

connection-term-enabled'yes' | 'no'

connection-translation-request-hoststring

This is the connection's translation request host.

connection-translation-destination-hoststring

This is the connection's translation destination host. This typically comes from the connection-orig-match-pattern. Defaults to ''

connection-translation-request-userstring

This is the connection's translation request user. This is typically set to [*]. Defaults to ""

connection-translation-destination-userstring

This is the connection's translation destination user. This is typically set to [*]. Defaults to ""

connection-translation-source-userstring

This is the connection's translation source user. This is typically set to [*]. Defaults to ""

connection-source-ip-checking-enabled'yes' | 'no'

connection-include-server-header-enabled'yes' | 'no'

connection-relay-comfort-noise-enabledstring

This will set whether there is an RTP Relay comfort noise. Can be set to yes or no. If not set, will be set to system-default

connection-pcmu-only-enabled'yes' | 'no'

connection-enforce-minimum-duration-enabled'yes' | 'no'

connection-bind-to-alternate-interface-enabled'yes' | 'no'

connection-block-video-in-sdp-enabled'yes' | 'no'

connection-sip-get-new-dialog-destination-fromstring

This will set the new dialog destination. Values available are contact-header or via-header. Default would be default-ip

connection-sip-get-response-destination-fromstring

This will set the response desination. Values available will be contact-header or via-header. Default will be default-ip

connection-require-encrypted-audio-enabledstring

This will set whether audio encryption is required. Options availabe are "optional" and "yes". Defaults to no

connection-sip-transport-protocolstring

This will set the SIP transport protocol. Options are "TCP and "TLS". Default will be UDP

connection-check-orig-matching-sip-headerstring

This will set whether to check whether the origination matches the SIP header. Options are "to", "request", or "contact". Default will default to "from"

connection-sip-session-timer-enabledstring

This will set the SIP session timer. Options are setting to "no" or not setting at all, which will default to the system-default

connection-prevent-rtp-port-change-enabled'yes' | 'no'

connection-hide-post-dial-delay-with-ringback-enabled'yes' | 'no'

connection-remote-ringback-handlingstring

This will set the remote ringback handling. Options are "no-ringback" and "local-only". Default will be set to "allowed".

connection-block-media-in-sip-180-ringing'yes' | 'no'

connection-allow-mid-call-uri-updates-enabled'yes' | 'no'

connection-record-all-calls-enabled'yes' | 'no'

connection-custom-p-asserted-id-formatstring

This will set the PAId of the connection. Example input "sample" will translate to "PAId=sample" in call rules

connection-require-sip-authentication-enabled'yes' | 'no'

connection-translation-source-hoststring

utc-offsetstring

This is the utc offset of the connection. Example "-7" for US/Pacific

time-zonestring

This is the timezone of the connection

minimum-call-duration-secondsinteger

connection-sip-registration-expires-datetimestring

connection-sip-authenticate-as-client-enabled'yes' | 'no'

connection-is-carrier-trunk'yes' | 'no'

active-calls-max-last-monthinteger

active-calls-max-this-monthinteger

active-calls-orig-currentinteger

active-calls-orig-since-startupinteger

active-calls-term-currentinteger

active-calls-term-since-startupinteger

connection-sip-registration-datetimestring

last-modified-datetimestring

Example response

[
  {
    "domain": "example.com",
    "connection-translation-destination-host": "[*]",
    "connection-translation-request-user": "[*]",
    "connection-translation-destination-user": "[*]",
    "connection-translation-source-user": "[*]",
    "connection-relay-comfort-noise-enabled": "yes",
    "connection-sip-get-new-dialog-destination-from": "contact-header",
    "connection-sip-get-response-destination-from": "contact-header",
    "connection-require-encrypted-audio-enabled": "optional",
    "connection-sip-transport-protocol": "TCP",
    "connection-check-orig-matching-sip-header": "to",
    "connection-sip-session-timer-enabled": "no",
    "connection-remote-ringback-handling": "no-ringback",
    "connection-custom-p-asserted-id-format": "sample",
    "utc-offset": "-7",
    "time-zone": "US/Pacific"
  }
]