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