View IVR settings
Available in 14 starting with 14.10
Resource URI: /ivr/settings
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
path | Path to the setting. |
type | Setting type. Possible options are string, boolean or enum. |
options | Available setting options. |
value | The current selected option of the setting. |
defaultValue | The default value of the setting. |
label | Setting label. |
description | Short description provided by the user. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves all the IVR settings.
Example: XML format
<Settings>
<Setting>
<path>ivr/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>Logging Level</label>
</Setting>
<Setting>
<path>ivr/audio.format</path>
<type>enum</type>
<options>
<entry>
<key>mp3</key>
</entry>
<entry>
<key>wav</key>
</entry>
</options>
<value>wav</value>
<defaultValue>wav</defaultValue>
<label>Voicemail encoding format</label>
<description>The encoding format to be used for storing voicemails</description>
</Setting>
<Setting>
<path>ivr/record.rate</path>
<type>enum</type>
<options>
<entry>
<key>8000</key>
</entry>
<entry>
<key>16000</key>
</entry>
</options>
<value>8000</value>
<defaultValue>8000</defaultValue>
<label>Record rate</label>
<description>Rate (in Hz) to be used for recording voicemails</description>
</Setting>
<Setting>
<path>ivr/record.time</path>
<type>integer</type>
<value>300</value>
<defaultValue>300</defaultValue>
<label>Time limit</label>
<description>Maximum duration (in seconds) of the voicemail recording.</description>
</Setting>
<Setting>
<path>ivr/fax.format</path>
<type>enum</type>
<options>
<entry>
<key>pdf</key>
</entry>
<entry>
<key>tiff</key>
</entry>
</options>
<value>pdf</value>
<defaultValue>pdf</defaultValue>
<label>Fax Format</label>
<description>The file format for receiving faxes</description>
</Setting>
<Setting>
<path>ivr/ivr.publicHttpPort</path>
<type>integer</type>
<value>8085</value>
<defaultValue>8085</defaultValue>
<label>Public HTTP port</label>
</Setting>
<Setting>
<path>ivr/ivr.httpPort</path>
<type>integer</type>
<value>8086</value>
<defaultValue>8086</defaultValue>
<label>HTTP port</label>
</Setting>
<Setting>
<path>ivr/ivr.voiceMailExpiry</path>
<type>integer</type>
<value>7</value>
<defaultValue>7</defaultValue>
<label>Voice Mail expiration</label>
<description>The number of days a voice mail message in the Trash folder is retained.</description>
</Setting>
<Setting>
<path>ivr/ivr.mwiTimeout</path>
<type>integer</type>
<value>5</value>
<defaultValue>5</defaultValue>
<label>Notify timeout</label>
<description>Time (in seconds) to wait for MWI Notify response</description>
</Setting>
<Setting>
<path>ivr/ivr.updaterConnectTimeoutMS</path>
<type>integer</type>
<value>5000</value>
<defaultValue>5000</defaultValue>
<label>Database Connection timeout</label>
<description>Timeout (in milliseconds) for global database connection.</description>
</Setting>
<Setting>
<path>ivr/ivr.updaterSocketTimeoutMS</path>
<type>integer</type>
<value>5000</value>
<defaultValue>5000</defaultValue>
<label>Database Socket timeout</label>
<description>Timeout (in milliseconds) for global database socket.</description>
</Setting>
</Settings>
JSON format
{
settings:
0: {
path: "ivr/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: "Logging Level"
description: null
}-
{
path: "ivr/audio.format"
type: "enum"
options: {
mp3: null
wav: null
}-
value: "wav"
defaultValue: "wav"
label: "Voicemail encoding format"
description: "The encoding format to be used for storing voicemails"
}-
{
path: "ivr/record.rate"
type: "enum"
options: {
8000: null
16000: null
}-
value: "8000"
defaultValue: "8000"
label: "Record rate"
description: "Rate (in Hz) to be used for recording voicemails"
}-
{
path: "ivr/record.time"
type: "integer"
options: null
value: "300"
defaultValue: "300"
label: "Time limit"
description: "Maximum duration (in seconds) of the voicemail recording."
}-
{
path: "ivr/fax.format"
type: "enum"
options: {
pdf: null
tiff: null
}-
value: "pdf"
defaultValue: "pdf"
label: "Fax Format"
description: "The file format for receiving faxes"
}-
{
path: "ivr/ivr.publicHttpPort"
type: "integer"
options: null
value: "8085"
defaultValue: "8085"
label: "Public HTTP port"
description: null
}-
{
path: "ivr/ivr.httpPort"
type: "integer"
options: null
value: "8086"
defaultValue: "8086"
label: "HTTP port"
description: null
}-
{
path: "ivr/ivr.voiceMailExpiry"
type: "integer"
options: null
value: "7"
defaultValue: "7"
label: "Voice Mail expiration"
description: "The number of days a voice mail message in the Trash folder is retained."
}-
{
path: "ivr/ivr.mwiTimeout"
type: "integer"
options: null
value: "5"
defaultValue: "5"
label: "Notify timeout"
description: "Time (in seconds) to wait for MWI Notify response"
}-
{
path: "ivr/ivr.updaterConnectTimeoutMS"
type: "integer"
options: null
value: "5000"
defaultValue: "5000"
label: "Database Connection timeout"
description: "Timeout (in milliseconds) for global database connection."
}-
{
path: "ivr/ivr.updaterSocketTimeoutMS"
type: "integer"
options: null
value: "5000"
defaultValue: "5000"
label: "Database Socket timeout"
description: "Timeout (in milliseconds) for global database socket."
}-
-
}
HTTP Method: PUT
Updates the settings of the gateway. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.
Unsupported HTTP Method: POST
View IVR settings from path
Available in 14 starting with 14.10
Resource URI: /ivr/setting/{pathToService}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
setting | The ivr setting related information is similar to the one described under /ivr/settings. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves the IVR settings from the specified path.
Example: XML format (The example below used the log.level path)
<Setting>
<path>ivr/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>Logging Level</label></Setting>
JSON format
{"path":"ivr/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":"Logging Level","description":null}
HTTP Method: PUT
Updates the settings of the IVR. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.
Unsupported HTTP Method: POST