Create a Connection

post

https://{server}/ns-api/v2/connections

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

connection-orig-match-pattern

string

required

This is the connection's origination match pattern

domain

string

required

length ≤ 64

This is the domain that the token will be limited to.

description

string

This is the connection's description

connection-term-match-pattern

string

Defaulted to connection-orig-match-pattern

connection-audio-relay-enabled

string

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-address

string

This is the connection's address

dial-plan

string

This is the connection's dial plan

dial-policy

string

This is the connection's dial policy

limits-max-active-calls-orig

integer

This is the connection's limit of maximum originating calls

limits-max-active-calls-term

integer

This is the connection's limit of maximum terminating calls

limits-max-active-calls-total

integer

This is the connection's limit of maximum total calls

connection-linked-billing-user

string

This is the connection's linked billing user

connection-sip-registration-username

string

This is the connection's authorized username

connection-sip-registration-password

string

This is the connection's password

connection-sip-registration-realm

string

This is the connection's authentication realm

connection-orig-enabled

string

enum

Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:

connection-term-enabled

string

enum

Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:

connection-translation-request-host

string

This is the connection's translation request host.

connection-translation-destination-host

string

Defaults to ''

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

connection-translation-request-user

string

Defaults to ''

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

connection-translation-destination-user

string

Defaults to ''

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

connection-translation-source-user

string

Defaults to ''

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

connection-source-ip-checking-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-include-server-header-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-relay-comfort-noise-enabled

string

Defaults to system-default

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

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-enforce-minimum-duration-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-bind-to-alternate-interface-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-block-video-in-sdp-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-sip-get-new-dialog-destination-from

string

Defaults to default-ip

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-from

string

Defaults to default-ip

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

connection-require-encrypted-audio-enabled

string

Defaults to no

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

connection-sip-transport-protocol

string

Defaults to UDP

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

connection-check-orig-matching-sip-header

string

Defaults to from

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-enabled

string

Defaults to system-default

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

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-hide-post-dial-delay-with-ringback-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-remote-ringback-handling

string

Defaults to allowed

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

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-allow-mid-call-uri-updates-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-record-all-calls-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-custom-p-asserted-id-format

string

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

connection-require-sip-authentication-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-translation-source-host

string

utc-offset

string

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

time-zone

string

This is the timezone of the connection

minimum-call-duration-seconds

integer

Defaults to 0

connection-sip-registration-expires-datetime

string

connection-sip-authenticate-as-client-enabled

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

connection-is-carrier-trunk

string

enum

Defaults to no

This will enable IP checking. Default is no

Allowed:

call-routing

Currently not supported in V2 API.

Responses

202Accepted

400Bad Request

401Authentication Required

404Record not found