Skip to end of metadata
Go to start of metadata

View proxy settings

Available in 14 starting with 14.10

Resource URI: /proxy/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves a list with all the proxy settings in the system.

Example: XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<Settings>

<Setting>

<path>proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES</path>

<type>integer</type>

<value>20</value>

<defaultValue>20</defaultValue>

<label>Default Serial Fork Expiration</label>

<description>Number of seconds that each phone in a sequential series is allowed to ring with no answer before the next alternative is tried. The most common case for this is a user with one phone and a voice mailbox - the phone will ring for this many seconds and then roll over to voice mail.</description>

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES</path>

<type>integer</type>

<value>300</value>

<defaultValue>300</defaultValue>

<label>Default Expiration</label>

<description>Number of seconds a call is allowed to go unanswered; if this many seconds pass, the call request is returned with an error.</description>

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_LOG_LEVEL</path>

<type>enum</type>

<options>

<entry>

<key>NOTICE</key>

</entry>

<entry>

<key>CRIT</key>

</entry>

<entry>

<key>EMERG</key>

</entry>

<entry>

<key>WARNING</key>

</entry>

<entry>

<key>ERR</key>

</entry>

<entry>

<key>INFO</key>

</entry>

<entry>

<key>ALERT</key>

</entry>

<entry>

<key>DEBUG</key>

</entry>

</options>

<value>NOTICE</value>

<defaultValue>NOTICE</defaultValue>

<label>Log Level</label>

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM</path>

<type>string</type>

<label>Authenticate Algorithm</label>

<description>The algorithm used in authentication</description>

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_MAX_FORWARDS</path>

<type>integer</type>

<label>Maximum Forwards</label>

<description>(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination.</description>

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT</path>

<type>integer</type>

<label>Stale TCP Timeout</label>

<description />

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME</path>

<type>boolean</type>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Ensure TCP Lifetime</label>

<description />

</Setting>

<Setting>

<path>proxy-configuration/SIPX_PROXY_RELAY_ALLOWED</path>

<type>boolean</type>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Allow Non-Local Domain Relay</label>

<description>If checked, proxy can act as a relay for non-local domain transactions. If you are using external phone features for phone lines, you must allow relaying.</description>

</Setting>

</setting>

JSON format

{

settings: [26]

0: {

path: "proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES"

type: "integer"

options: null

value: "20"

defaultValue: "20"

label: "Default Serial Fork Expiration"

description: "Number of seconds that each phone in a sequential series is allowed to ring with no answer before the next alternative is tried. The most common case for this is a user with one phone and a voice mailbox - the phone will ring for this many seconds and then roll over to voice mail."

}-

1: {

path: "proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES"

type: "integer"

options: null

value: "300"

defaultValue: "300"

label: "Default Expiration"

description: "Number of seconds a call is allowed to go unanswered; if this many seconds pass, the call request is returned with an error."

}-

2: {

path: "proxy-configuration/SIPX_PROXY_LOG_LEVEL"

type: "enum"

options: {

NOTICE: null

CRIT: null

EMERG: null

WARNING: null

ERR: null

INFO: null

ALERT: null

DEBUG: null

}-

value: "NOTICE"

defaultValue: "NOTICE"

label: "Log Level"

description: null

}-

3: {

path: "proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM"

type: "string"

options: null

value: null

defaultValue: null

label: "Authenticate Algorithm"

description: "The algorithm used in authentication"

}-

4: {

path: "proxy-configuration/SIPX_PROXY_MAX_FORWARDS"

type: "integer"

options: null

value: null

defaultValue: null

label: "Maximum Forwards"

description: "(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination."

}-

5: {

path: "proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT"

type: "integer"

options: null

value: null

defaultValue: null

label: "Stale TCP Timeout"

description: ""

}-

6: {

path: "proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME"

type: "boolean"

options: null

value: "0"

defaultValue: "0"

label: "Ensure TCP Lifetime"

description: ""

}-

7: {

path: "proxy-configuration/SIPX_PROXY_RELAY_ALLOWED"

type: "boolean"

options: null

value: "1"

defaultValue: "1"

label: "Allow Non-Local Domain Relay"

description: "If checked, proxy can act as a relay for non-local domain transactions. If you are using external phone features for phone lines, you must allow relaying."

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify proxy settings

Available in 14 starting with 14.10

Resource URI: /proxy/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves CDR options for the setting from the specified path.

Example: XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<Setting>

<path>msftxchghack/EXCHANGE_SERVER_FQDN</path>

<type>string</type>

<label>Trusted Microsoft Exchange Server</label>

<description>Fully Qualified Domain Name of Trusted Microsoft Exchange Server</description>

</Setting>

JSON format

{

path: "msftxchghack/EXCHANGE_SERVER_FQDN"

type: "string"

options: null

value: null

defaultValue: null

label: "Trusted Microsoft Exchange Server"

description: "Fully Qualified Domain Name of Trusted Microsoft Exchange Server"

}

HTTP Method: PUT

Modifies proxy options for the setting from the specified path.

HTTP Method: DELETE

Deletes proxy options for the setting from the specified path.

Unsupported HTTP Method: POST

  • No labels