Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Several configuration APIs allow you to manage the system, users, devices and features.

Table of Contents

IVR

Available in 14 starting with 14.10

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

DNS

Available in 14 starting with 14.10

View DNS settings

Available in 14 starting with 14.10

Resource URI: /dns/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 the settings for all DNSs in the system.

Example: XML format

<Settings>

<Setting>

<path>named-config/forwarders/forwarder_0</path>

<type>string</type>

<value>192.168.1.1</value>

<label>Primary External DNS server</label>

<description>DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8.</description>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_1</path>

<type>string</type>

<label>Secondary External DNS server</label>

<description>In the event the primary DNS server is unavailable, system will use this server.</description>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_2</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_3</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_4</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>acl/ips</path>

<type>string</type>

<value>192.168.1.171,127.0.0.0/8</value>

<defaultValue>192.168.1.171,127.0.0.0/8</defaultValue>

<label>Allow Recursion ACL</label>

<description>Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver.</description>

</Setting>

<Setting>

<path>sys/unmanaged</path>

<type>boolean</type>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Unmanaged Service</label>

<description>Company or ITSP DNS servers to resolve ALL names instead of local DNS servers.</description>

</Setting>

JSON format

{

Wiki Markup
settings: \[11\]

0: {

path: "named-config/forwarders/forwarder_0"

type: "string"

options: null

value: "192.168.1.1"

defaultValue: null

label: "Primary External DNS server"

description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."

}-

1: {

path: "named-config/forwarders/forwarder_1"

type: "string"

options: null

value: null

defaultValue: null

label: "Secondary External DNS server"

description: "In the event the primary DNS server is unavailable, system will use this server."

}-

2: {

path: "named-config/forwarders/forwarder_2"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

3: {

path: "named-config/forwarders/forwarder_3"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

4: {

path: "named-config/forwarders/forwarder_4"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

5: {

path: "acl/ips"

type: "string"

options: null

value: "192.168.1.171,127.0.0.0/8"

defaultValue: "192.168.1.171,127.0.0.0/8"

label: "Allow Recursion ACL"

description: "Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver."

}-

6: {

path: "sys/unmanaged"

type: "boolean"

options: null

value: "0"

defaultValue: "0"

label: "Unmanaged Service"

description: "Company or ITSP DNS servers to resolve ALL names instead of local DNS servers."

}-

7: {

path: "sys/unmanaged_servers/unmanaged_0"

type: "string"

options: null

value: null

defaultValue: null

label: "Primary Unmanaged DNS server"

description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."

}

}

Unsupported HTTP Method: PUT, POST, DELETE

View DNS settings from path

Available in 14 starting with 14.10

Resource URI: /dns/settings/{settingPath}

Default Resource Properties:

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

Property

Description

setting

The dns setting related information is similar to the one described under /dns/settings.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the DNS settings from the specified path.

Example: XML format

<Setting>

<path>named-config/forwarders/forwarder_3</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

JSON format

{

path: "named-config/forwarders/forwarder_3"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}

HTTP Method: PUT

Updates the settings of the DNS from the specified path. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the DNS from the specified path.

Unsupported HTTP Method: POST

View DNS adviser results

Available in 14 starting with 14.10

Resource URI: /dns/advisor/server/{serverId}

Default Resource Properties:

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

Property

Description

Missing naptr records

List of the missing NAPTR records, if any.

Missing a records

List of missing A records, if any.

Specific Response Codes: N/A

HTTP Method: GET

Checks the DNS settings and if the settings are correct, no result is returned. Otherwise, it retrieves the missing configurations.

Example: plain text only

;; Missing naptr records

ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2U" "" _sip._udp

ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2T" "" _sip._tcp

;; Missing a records

Uniteme_1410.ezuce.ro IN A 19.18.1.175

Unsupported HTTP Method: PUT, POST, DELETE

Message Waiting Indication (MWI)

Available in 14 starting with 14.10

View MWI settings

Available in 14 starting with 14.10

Resource URI: /mwi/settings

Default Resource Properties:

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

...

Property

...

Description

...

path

...

type

...

value

...

defaultValue

...

description

Specific Response Codes: N/A

HTTP Method: GET

Retrieves tall MWI settings.

Example: XML format

<Settings>

<Setting>

<path>status-config/SIP_STATUS_TCP_PORT</path>

<type>integer</type>

<value>5110</value>

<defaultValue>5110</defaultValue>

<label>MWI TCP Port</label>

</Setting>

<Setting>

<path>status-config/SIP_STATUS_UDP_PORT</path>

<type>integer</type>

<value>5110</value>

<defaultValue>5110</defaultValue>

<label>MWI UDP Port</label>

</Setting>

<Setting>

<path>status-config/SIP_STATUS_HTTP_PORT</path>

<type>integer</type>

<value>8100</value>

<defaultValue>8100</defaultValue>

<label>MWI HTTP Port</label>

</Setting>

<Setting>

<path>status-config/SIP_STATUS_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>

<description>Handling of SUBSCRIBE/NOTIFY messages for voicemail notification control (MWI)</description>

</Setting>

<Setting>

<path>status-config/SIP_STATUS_MAX_EXPIRES</path>

<type>integer</type>

<label>Max expires</label>

</Setting>

<Setting>

<path>status-config/SIP_STATUS_MIN_EXPIRES</path>

<type>integer</type>

<label>Min expires</label>

</Setting>

<Setting>

<path>resource-limits/fd-soft</path>

<type>integer</type>

<value>32768</value>

<defaultValue>32768</defaultValue>

<label>FD Soft</label>

<description>FD Soft resource limit</description>

</Setting>

<Setting>

<path>resource-limits/fd-hard</path>

<type>integer</type>

<value>65536</value>

<defaultValue>65536</defaultValue>

<label>FD Hard</label>

<description>FD Hard resource limit</description>

</Setting>

<Setting>

<path>resource-limits/core-enabled</path>

<type>boolean</type>

<value>false</value>

<defaultValue>false</defaultValue>

<label>Core Enabled</label>

<description>Core Enabled resource limit</description>

</Setting>

</Settings>

JSON format

{

Wiki Markup
settings: \[9\]

0: {

path: "status-config/SIP_STATUS_TCP_PORT"

type: "integer"

options: null

value: "5110"

defaultValue: "5110"

label: "MWI TCP Port"

description: null

}-

1: {

path: "status-config/SIP_STATUS_UDP_PORT"

type: "integer"

options: null

value: "5110"

defaultValue: "5110"

label: "MWI UDP Port"

description: null

}-

2: {

path: "status-config/SIP_STATUS_HTTP_PORT"

type: "integer"

options: null

value: "8100"

defaultValue: "8100"

label: "MWI HTTP Port"

description: null

}-

3: {

path: "status-config/SIP_STATUS_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: "Handling of SUBSCRIBE/NOTIFY messages for voicemail notification control (MWI)"

}-

4: {

path: "status-config/SIP_STATUS_MAX_EXPIRES"

type: "integer"

options: null

value: null

defaultValue: null

label: "Max expires"

description: null

}-

5: {

path: "status-config/SIP_STATUS_MIN_EXPIRES"

type: "integer"

options: null

value: null

defaultValue: null

label: "Min expires"

description: null

}-

6: {

path: "resource-limits/fd-soft"

type: "integer"

options: null

value: "32768"

defaultValue: "32768"

label: "FD Soft"

description: "FD Soft resource limit"

}-

7: {

path: "resource-limits/fd-hard"

type: "integer"

options: null

value: "65536"

defaultValue: "65536"

label: "FD Hard"

description: "FD Hard resource limit"

}-

8: {

path: "resource-limits/core-enabled"

type: "boolean"

options: null

value: "false"

defaultValue: "false"

label: "Core Enabled"

description: "Core Enabled resource limit"

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify MWI settings

Available in 14 starting with 14.10

Resource URI: /mwi/settings/{settingPath}

Default Resource Properties:

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

Property

Description

setting

The MWI setting related information is similar to the one described under /mwi/settings.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the MWI settings from the specified path.

Example: XML format

<Setting>

<path>status-config/SIP_STATUS_MAX_EXPIRES</path>

<type>integer</type>

<label>Max expires</label>

</Setting>

JSON format

{

path: "status-config/SIP_STATUS_MAX_EXPIRES"

type: "integer"

options: null

value: null

defaultValue: null

label: "Max expires"

description: null

}

HTTP Method: PUT

Updates the settings of the MWI from the specified path. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the MWI from the specified path.

Unsupported HTTP Method: POST

Phone Groups

Available in 14 starting with 14.10

View or create phone groups

Available in 14 starting with 14.10

Resource URI:/phoneGroups

Default Resource Properties:

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

...

Property

...

Description

...

id

...

Group unique identification number.

...

name

...

Group name.

...

description

...

Short description provided by the user.

...

weight

Specific Response Codes: N/A

HTTP Method: GET

Retrieves all phone groups.

Example: XML format

<Groups>

<Group>

<id>7</id>

<name>SSComm</name>

<description>desc</description>

<weight>3</weight>

</Group>

<Group>

<id>8</id>

<name>ExpertsComm</name>

<description>desc</description>

<weight>4</weight>

</Group>

</Groups>

JSON format

{

Wiki Markup
groups: \[2\]

0: {

id: 7

name: "SSComm"

description: "desc"

weight: 3

count: null

}-

1: {

id: 8

name: "ExpertsComm"

description: "desc"

weight: 4

count: null

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify phone groups

Available in 14 starting with 14.10

Resource URI: /phoneGroups/{phoneGroupId}

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 the phone group with the specified ID.

Example: XML format

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

<group>

<id>7</id>

<name>SSComm</name>

<description>desc</description>

<weight>3</weight>

</group>

JSON format

{

id: 7

name: "SSComm"

description: "desc"

weight: 3

count: null

}

HTTP Method: PUT

Updates the phone group. PUT data is plain text.
HTTP Method: DELETE
Deletes the phone group.

Unsupported HTTP Method: POST

Move phone group up in a phone group

Available in 14 starting with 14.10

Resource URI: /{groupId}/up

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: PUT

Move the phone group up. PUT data is plain text.

Unsupported HTTP Method: GET, POST, DELETE

Move phone group down in a phone group

Available in 14 starting with 14.10

Resource URI: /{groupId}/down

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: PUT

Move the phone group down. PUT data is plain text.

Unsupported HTTP Method: GET, POST, DELETE

View settings for specific models in a phone group

Available in 14 starting with 14.10

Resource URI: /{groupId}/models

Default Resource Properties:

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

Property

Description

modelId

Model ID.

label

Model label.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves all phone models in the specified group ID.

Example: XML format

<Models>

<Model>

<modelId>SPA501G</modelId>

<label>Cisco SPA501G</label>

</Model>

<Model>

<modelId>SPA502G</modelId>

<label>Cisco SPA502G</label>

</Model>

<Model>

<modelId>SPA504G</modelId>

<label>Cisco SPA504G</label>

</Model>

<Model>

<modelId>SPA508G</modelId>

<label>Cisco SPA508G</label>

</Model>

<Model>

<modelId>SPA509G</modelId>

<label>Cisco SPA509G</label>

</Model>

<Model>

<modelId>SPA525G</modelId>

<label>Cisco SPA525G</label>

</Model>

<Model>

<modelId>yealinkPhoneVP530</modelId>

<label>Yealink VP530</label>

<vendor>Yealink</vendor>

<Versions>

<Version>yealink7X</Version>

</Versions>

</Model>

<Model>

<modelId>yealinkPhoneW52</modelId>

<label>Yealink W52</label>

<vendor>Yealink</vendor>

<Versions>

<Version>yealink7X</Version>

</Versions>

</Model>

</Models>

JSON format

{

models:

{

modelId: "SPA501G"

label: "Cisco SPA501G"

vendor: null

versions: null

}-

{

modelId: "SPA502G"

label: "Cisco SPA502G"

vendor: null

versions: null

}-

{

modelId: "SPA504G"

label: "Cisco SPA504G"

vendor: null

versions: null

}-

{

modelId: "SPA508G"

label: "Cisco SPA508G"

vendor: null

versions: null

}-

{

modelId: "SPA509G"

label: "Cisco SPA509G"

vendor: null

versions: null

}-

{

modelId: "SPA525G"

label: "Cisco SPA525G"

vendor: null

versions: null

}-

{

modelId: "aastra53i"

label: "Aastra SIP IP 53i"

vendor: "Aastra"

versions: null

}

{

modelId: "yealinkPhoneVP530"

label: "Yealink VP530"

vendor: "Yealink"

Wiki Markup
versions: \[1\]

0: "yealink7X"

-

}-

{

modelId: "yealinkPhoneW52"

label: "Yealink W52"

vendor: "Yealink"

Wiki Markup
versions: \[1\]

0: "yealink7X"

-

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or modify all settings for a phone model in a phone group

Available in 14 starting with 14.10

Resource URI: /{groupId}/model/{modelName}/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 the phone group with the specified ID.

Example: XML format

<Settings>

<Setting>

<path>System/Restricted_Access_Domains</path>

<type>string</type>

<label>Restricted Access Domains</label>

</Setting>

<Setting>

<path>System/Enable_Web_Server</path>

<type>boolean</type>

<value>yes</value>

<defaultValue>yes</defaultValue>

<label>Enable Web Server</label>

</Setting>

<Setting>

<path>System/HostName</path>

<type>string</type>

<label>HostName</label>

</Setting>

<Setting>

<path>System/Domain</path>

<type>string</type>

<label>Domain</label>

</Setting>

<Setting>

<path>System/Primary_DNS</path>

<type>string</type>

<label>Primary DNS</label>

</Setting>

<Setting>

<path>System/Secondary_DNS</path>

<type>string</type>

<label>Secondary DNS</label>

</Setting>

<Setting>

<path>User/Headset_Volume</path>

<type>integer</type>

<value>10</value>

<defaultValue>10</defaultValue>

<label>Headset Volume</label>

</Setting>

<Setting>

<path>User/LCD_Contrast</path>

<type>integer</type>

<value>8</value>

<defaultValue>8</defaultValue>

<label>LCD Contrast</label>

</Setting>

<Setting>

<path>User/Back_Light_Timer</path>

<type>enum</type>

<options>

<entry>

<key>Always On</key>

</entry>

<entry>

<key>20 s</key>

</entry>

<entry>

<key>no</key>

</entry>

<entry>

<key>10 s</key>

</entry>

</options>

<label>Back Light Timer</label>

</Setting>

</Settings>

JSON format

{

settings:

{

path: "System/Restricted_Access_Domains"

type: "string"

options: null

value: null

defaultValue: null

label: "Restricted Access Domains"

description: null

}-

{

path: "System/Enable_Web_Server"

type: "boolean"

options: null

value: "yes"

defaultValue: "yes"

label: "Enable Web Server"

description: null

{

path: "System/Domain"

type: "string"

options: null

value: null

defaultValue: null

label: "Domain"

description: null

}-

{

path: "System/Primary_DNS"

type: "string"

options: null

value: null

defaultValue: null

label: "Primary DNS"

description: null

}-

{

path: "System/Secondary_DNS"

type: "string"

options: null

value: null

defaultValue: null

label: "Secondary DNS"

description: null

}

{

path: "User/Back_Light_Timer"

type: "enum"

options: {

Always On: null

20 s: null

no: null

10 s: null

}-

value: null

defaultValue: null

label: "Back Light Timer"

description: null

}

}

HTTP Method: PUT

Updates the phone group. PUT data is plain text.
HTTP Method: DELETE
Deletes the phone group.

Unsupported HTTP Method: POST

View or modify one setting for a phone model in a phone group

Available in 14 starting with 14.10

Resource URI: /{groupId}/model/{modelName}/settings/{path:.*}

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 the setting in the specified path.

Example: XML format

<Setting>

<path>System/Restricted_Access_Domains</path>

<type>string</type>

<label>Restricted Access Domains</label>

</Setting>

JSON format

{

path: "System/Restricted_Access_Domains"

type: "string"

options: null

value: null

defaultValue: null

label: "Restricted Access Domains"

description: null

}

HTTP Method: PUT

Updates the setting in the specified path. PUT data is plain text.
HTTP Method: DELETE
Reverts the setting to the default value.

Unsupported HTTP Method: POST

Music on Hold (MOH)

Available in 14 starting with 14.10

View MOH settings

Available in 14 starting with 14.10

Resource URI: /moh/settings

Default Resource Properties:

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

...

Property

...

Description

...

dnsManager

...

Name of the DNS manager.

...

dnsTestContext

Specific Response Codes: N/A

HTTP Method: GET

Retrieves all MOH settings.

Example: XML format

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

<Settings>

<Setting>

<path>moh-config/MOH_SOURCE</path>

<type>enum</type>

<options>

<entry>

<key>FILES_SRC</key>

<value>System Music Directory</value>

</entry>

<entry>

<key>NONE</key>

<value>None</value>

</entry>

<entry>

<key>SOUNDCARD_SRC</key>

<value>Sound Card</value>

</entry>

</options>

<value>FILES_SRC</value>

<defaultValue>FILES_SRC</defaultValue>

<label>Music On Hold Source</label>

<description>Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold.</description>

</Setting>

JSON format

{

Wiki Markup
settings: \[1\]

0: {

path: "moh-config/MOH_SOURCE"

type: "enum"

options: {

FILES_SRC: "System Music Directory"

NONE: "None"

SOUNDCARD_SRC: "Sound Card"

}-

value: "FILES_SRC"

defaultValue: "FILES_SRC"

label: "Music On Hold Source"

description: "Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold."

}-

-

}

Unsupported HTTP Method: PUT, POST, DELETE

View or change MOH settings

Available in 14 starting with 14.10

Resource URI: /moh/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 the setting in the specified path.

Example: XML format

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

<Setting>

<path>moh-config/MOH_SOURCE</path>

<type>enum</type>

<options>

<entry>

<key>FILES_SRC</key>

<value>System Music Directory</value>

</entry>

<entry>

<key>NONE</key>

<value>None</value>

</entry>

<entry>

<key>SOUNDCARD_SRC</key>

<value>Sound Card</value>

</entry>

</options>

<value>FILES_SRC</value>

<defaultValue>FILES_SRC</defaultValue>

<label>Music On Hold Source</label>

<description>Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold.</description>

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

<Models>

<Model>

<modelId>SPA501G</modelId>

<label>Cisco SPA501G</label>

</Model>

<Model>

<modelId>SPA502G</modelId>

<label>Cisco SPA502G</label>

</Model>

<Model>

<modelId>SPA504G</modelId>

<label>Cisco SPA504G</label>

</Model>

<Model>

<modelId>SPA508G</modelId>

<label>Cisco SPA508G</label>

</Model>

<Model>

<modelId>SPA509G</modelId>

<label>Cisco SPA509G</label>

</Model>

<Model>

<modelId>SPA525G</modelId>

<label>Cisco SPA525G</label>

</Model>

<Model>

<modelId>yealinkPhoneVP530</modelId>

<label>Yealink VP530</label>

<vendor>Yealink</vendor>

<Versions>

<Version>yealink7X</Version>

</Versions>

</Model>

<Model>

<modelId>yealinkPhoneW52</modelId>

<label>Yealink W52</label>

<vendor>Yealink</vendor>

<Versions>

<Version>yealink7X</Version>

</Versions>

</Model>

</Models>

JSON format

{

path: "moh-config/MOH_SOURCE"

type: "enum"

options: {

FILES_SRC: "System Music Directory"

NONE: "None"

SOUNDCARD_SRC: "Sound Card"

}-

value: "FILES_SRC"

defaultValue: "FILES_SRC"

label: "Music On Hold Source"

description: "Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold."

}

HTTP Method: PUT

Updates the setting in the specified path. PUT data is plain text.
HTTP Method: DELETE
Reverts the setting to the default value.

Unsupported HTTP Method: POST

View prompt MOH messages

Available in 14 starting with 14.10

Resource URI: /moh/prompts

Default Resource Properties:

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

...

Property

...

Description

...

dnsManager

...

Name of the DNS manager.

...

dnsTestContext

Specific Response Codes: N/A

HTTP Method: GET

Retrieves all MOH prompt messages.

Example: XML format

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

<Files>

<File>

<name>default.wav</name>

<size>4029662</size>

<path>/var/sipxdata/mediaserver/data/moh/default.wav</path>

</File>

</Files>

JSON format

{

Wiki Markup
files: \[1\]

0: {

type: null

path: "/var/sipxdata/mediaserver/data/moh/default.wav"

name: "default.wav"

size: 4029662

}-

-

}

HTTP Method: POST

Uploads new prompt messages.

Unsupported HTTP Method: PUT, DELETE

Download MOH prompt

Available in 14 starting with 14.10

Resource URI: /moh/prompts/{promptName}

Default Resource Properties:

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

...

Property

...

Description

...

dnsManager

...

Name of the DNS manager.

...

dnsTestContext

Specific Response Codes: N/A

HTTP Method: GET

Downloads the MOH prompt messages based on the file name. For example, use /moh/prompts/default.wav.

Example: N/A

HTTP Method: DELETE

Deletes the specified prompt message.

Unsupported HTTP Method: PUT, POST

Stream to MOH prompt

Available in 14 starting with 14.10

Resource URI: /moh/prompts/{promptName}/stream

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: GET

Can be called by clients to stream prompts.

Example: N/A

Unsupported HTTP Method: PUT, POST, DELETE

Registrations

Available in 14 starting with 14.10

...