VOXTELL API v2ConnectionsCreate a ConnectionCopy Pagepost https://{server}/ns-api/v2/connectionsRecent RequestsLog in to see full request historyTimeStatusUser Agent Retrieving recent requests…LoadingLoading…Body Paramsconnection-orig-match-patternstringrequiredThis is the connection's origination match patterndomainstringrequiredlength ≤ 64^[A-Za-z0-9._-]+|\*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 ().descriptionstringThis is the connection's descriptionconnection-term-match-patternstringDefaulted to connection-orig-match-patternconnection-audio-relay-enabledstringAvailable 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-addressstringThis is the connection's addressdial-planstringThis is the connection's dial plandial-policystringThis is the connection's dial policylimits-max-active-calls-origintegerThis is the connection's limit of maximum originating callslimits-max-active-calls-termintegerThis is the connection's limit of maximum terminating callslimits-max-active-calls-totalintegerThis is the connection's limit of maximum total callsconnection-linked-billing-userstringThis is the connection's linked billing userconnection-sip-registration-usernamestringThis is the connection's authorized usernameconnection-sip-registration-passwordstringThis is the connection's passwordconnection-sip-registration-realmstringThis is the connection's authentication realmconnection-orig-enabledstringenumDefaults to yesWhen enabled this setting will turn on voicemail for the user.yesyesnoAllowed:yesnoconnection-term-enabledstringenumDefaults to yesWhen enabled this setting will turn on voicemail for the user.yesyesnoAllowed:yesnoconnection-translation-request-hoststringThis is the connection's translation request host.connection-translation-destination-hoststringDefaults to ''This is the connection's translation destination host. This typically comes from the connection-orig-match-pattern. Defaults to ''connection-translation-request-userstringDefaults to ''This is the connection's translation request user. This is typically set to [*]. Defaults to ""connection-translation-destination-userstringDefaults to ''This is the connection's translation destination user. This is typically set to [*]. Defaults to ""connection-translation-source-userstringDefaults to ''This is the connection's translation source user. This is typically set to [*]. Defaults to ""connection-source-ip-checking-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-include-server-header-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-relay-comfort-noise-enabledstringDefaults to system-defaultThis 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-defaultconnection-pcmu-only-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-enforce-minimum-duration-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-bind-to-alternate-interface-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-block-video-in-sdp-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-sip-get-new-dialog-destination-fromstringDefaults to default-ipThis will set the new dialog destination. Values available are contact-header or via-header. Default would be default-ipconnection-sip-get-response-destination-fromstringDefaults to default-ipThis will set the response desination. Values available will be contact-header or via-header. Default will be default-ipconnection-require-encrypted-audio-enabledstringDefaults to noThis will set whether audio encryption is required. Options availabe are "optional" and "yes". Defaults to noconnection-sip-transport-protocolstringDefaults to UDPThis will set the SIP transport protocol. Options are "TCP and "TLS". Default will be UDPconnection-check-orig-matching-sip-headerstringDefaults to fromThis 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-enabledstringDefaults to system-defaultThis will set the SIP session timer. Options are setting to "no" or not setting at all, which will default to the system-defaultconnection-prevent-rtp-port-change-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-hide-post-dial-delay-with-ringback-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-remote-ringback-handlingstringDefaults to allowedThis 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-ringingstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-allow-mid-call-uri-updates-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-record-all-calls-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-custom-p-asserted-id-formatstringThis will set the PAId of the connection. Example input "sample" will translate to "PAId=sample" in call rulesconnection-require-sip-authentication-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-translation-source-hoststringutc-offsetstringThis is the utc offset of the connection. Example "-7" for US/Pacifictime-zonestringThis is the timezone of the connectionminimum-call-duration-secondsintegerDefaults to 0connection-sip-registration-expires-datetimestringconnection-sip-authenticate-as-client-enabledstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnoconnection-is-carrier-trunkstringenumDefaults to noThis setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.yesyesnoAllowed:yesnocall-routingstring | integer | number | nullarray | nullboolean | nullobject | nullCurrently not supported in V2 API.Response 202Updated 4 months ago Get All ConnectionsCount All ConectionsDid this page help you?YesNo