Several configuration APIs allow you to manage the system, users, devices and features.
Registrations
Available in 14 starting with 14.10
View all registrations
Available in 14 starting with 14.10
Resource URI: /registrations
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Filtering Parameters:
Parameter | Description |
start | Required. The start date? |
limit | Required. The maximum number of results to be displayed. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves all registrations in the system.
Example: XML format
<Registrations>
<Registration>
<contact><sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
<expires>1414406900</expires>
<identity>300@dlu.ezuce.ro</identity>
<instrument />
<primary>10.5.0.151</primary>
<regCallId>YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
<uri><sip:300@dlu.ezuce.ro;transport=TCP></uri>
<secondsToExpire>3885026</secondsToExpire>
<status>active</status>
</Registration>
<Registrations>
<Registration>
<contact><sip:300@12.18.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
<expires>4005065</expires>
<identity>403@dlu.ezuce.ro</identity>
<instrument />
<primary>106.5.60.151</primary>
<regCallId>qWErtyu4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
<uri><sip:403@dlu.ezuce.ro;transport=TCP></uri>
<secondsToExpire>3885026</secondsToExpire>
<status>active</status>
</Registration>
</Registrations>
</Registrations>
JSON format
{
registrations:
{
secondsToExpire: 3885065
status: "active"
uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
primary: "10.521.0.751"
expires: 1414406900
identity: "300@dlu.ezuce.ro"
contact: "<sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
instrument: ""
regCallId: "YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
}-
-
}
{
registrations:
{
secondsToExpire: 4005065
status: "active"
uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
primary: "10.521.0.751"
expires: 1414406900
identity: "403@dlu.ezuce.ro"
contact: "<sip:3403@12.18.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
instrument: ""
regCallId: "qWErtyu4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
}-
-
}
Unsupported HTTP Method: PUT, POST, DELETE
Filter registrations by users
Available in 14 starting with 14.10
Resource URI: /registrations/user/{userId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
ID | The ID, name or the alias of the user. |
Specific Response Codes: N/A
Filtering Parameters:
Parameter | Description |
start | Required. The start date? |
limit | Required. The maximum number of results to be displayed. |
HTTP Method: GET
Retrieves registrations for the specified user.
Example: XML format
<Registrations>
<Registration>
<contact><sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
<expires>1414406900</expires>
<identity>300@dlu.ezuce.ro</identity>
<instrument />
<primary>10.521.0.751</primary>
<regCallId>YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
<uri><sip:300@dlu.ezuce.ro;transport=TCP></uri>
<secondsToExpire>3885026</secondsToExpire>
<status>active</status>
</Registration>
<Registrations>
JSON format
{
registrations:
{
secondsToExpire: 3885065
status: "active"
uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
primary: "10.521.0.751"
expires: 1414406900
identity: "300@dlu.ezuce.ro"
contact: "<sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
instrument: ""
regCallId: "YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
}-
-
}
{
HTTP Method: DELETE
Stops registrations for the specified user.
Unsupported HTTP Method: PUT, POST
Filter registrations by MAC addresses
Available in 14 starting with 14.10
Resource URI: /registrations/serialNo/{serialId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Registrations | The number of registrations for the specified serial number. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves registrations for the specified MAC addresses.
Example: XML format
<Registrations />
JSON format
{
registrations: [0]
}
HTTP Method: DELETE
Stops registrations for the specified MAC addresses.
Unsupported HTTP Method: PUT, POST
Filter registrations by IPs
Available in 14 starting with 14.10
Resource URI: /registrations/ip/{ip}
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 registrations for the specified IP.
Example: XML format
JSON format
HTTP Method: DELETE
Stops registrations for the specified IP.
Unsupported HTTP Method: PUT, POST
Filter registrations by call ID
Available in 14 starting with 14.10
Resource URI: /registrations/callId/{callId}
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 registrations for the specified call ID.
Example: XML format
JSON format
HTTP Method: DELETE
Stops registrations for the specified call ID.
Unsupported HTTP Method: PUT, POST
Filter registrations by servers
Available in 14 starting with 14.10
Resource URI: /registrations/server/{serverId}
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
Retrieve registrations for server based on internal ID or FQDN.
HTTP Method: DELETE
Stops registrations for the specified server.
Unsupported HTTP Method: PUT, POST
Page groups
Available in 14 starting with 14.10
View or create page groups
Available in 14 starting with 14.10
Resource URI: /pagegroups
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
ID | Unique identification number of the page group. |
enabeled | The status of the page group. Displays True if it is enabled or False if it is disabled. |
GroupNumber | Group number. |
timeout | Timeout, measured in seconds. |
sound | Name of the of the file representing the sound to be played. |
description | Short description provided by the user. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves all the page groups defined in the system.
Example: XML format
<Groups>
<Group>
<id>1</id>
<enabled>true</enabled>
<pageGroupNumber>13</pageGroupNumber>
<timeout>60</timeout>
<sound>notice.wav</sound>
<description>Paging group for team WS.</description>
</Group>
<Group>
<id>2</id>
<enabled>true</enabled>
<pageGroupNumber>9</pageGroupNumber>
<timeout>45</timeout>
<sound>notice.wav</sound>
<description>Paging group for team YTM.</description>
</Group>
</Groups>
JSON format
{
groups: [2]
0: {
enabled: true
id: 1
description: "Paging group for team WS."
timeout: 60
pageGroupNumber: 13
sound: "notice.wav"
users: null
}-
1: {
enabled: true
id: 2
description: "Paging group for team YTM."
timeout: 45
pageGroupNumber: 9
sound: "notice.wav"
users: null
}-
-
}
HTTP Method: POST
Creates new page group
Unsupported HTTP Method: PUT, DELETE
View or modify page groups based on page group ID
Available in 14 starting with 14.10
Resource URI: /pagegroups/{pagegroupId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
ID | Unique identification number of the page group. |
enabeled | The status of the page group. Displays True if it is enabled or False if it is disabled. |
pageGroupNumber | Page group number. |
timeout | Timeout, measured in seconds. |
sound | Name of the of the file representing the sound to be played. |
description | Short description provided by the user. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves page groups with the specified ID.
Example: XML format
<Group>
<id>1</id>
<enabled>true</enabled>
<pageGroupNumber>13</pageGroupNumber>
<timeout>60</timeout>
<sound>notice.wav</sound>
<description>Paging group for team WS.</description>
</Group>
JSON format
{
enabled: true
id: 1
description: "Paging group for team WS."
timeout: 60
pageGroupNumber: 13
sound: "notice.wav"
users: null
}
}
HTTP Method: PUT
Modifies page groups with the specified ID.
HTTP Method: DELETE
Deletes page groups with the specified ID.
Unsupported HTTP Method: PUT, POST
Manage page groups services
Available in 14 starting with 14.10
Resource URI: /pagegroups/settings
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
path | |
type | |
value | |
defaultValue | |
label |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves general service options for the page groups in the system.
Example: XML format
<Settings>
<Setting>
<path>page-config/prefix</path>
<type>string</type>
<value>*77</value>
<defaultValue>*77</defaultValue>
<label>Paging prefix</label>
</Setting>
<Setting>
<path>page-config/sip.trace</path>
<type>enum</type>
<options>
<entry>
<key>NONE</key>
</entry>
<entry>
<key>DEBUG</key>
</entry>
<entry>
<key>TRACE</key>
</entry>
</options>
<value>NONE</value>
<defaultValue>NONE</defaultValue>
<label>SIP Trace Level</label>
</Setting>
<Setting>
<path>page-config/sip.tcpPort</path>
<type>integer</type>
<value>5160</value>
<defaultValue>5160</defaultValue>
<label>SIP TCP Port</label>
</Setting>
<Setting>
<path>page-config/sip.udpPort</path>
<type>integer</type>
<value>5160</value>
<defaultValue>5160</defaultValue>
<label>SIP UDP Port</label>
</Setting>
<Setting>
<path>page-config/sip.tlsPort</path>
<type>integer</type>
<value>5161</value>
<defaultValue>5161</defaultValue>
<label>SIP TLS Port</label>
</Setting>
<Setting>
<path>page-config/rtp.port</path>
<type>integer</type>
<value>8500</value>
<defaultValue>8500</defaultValue>
<label>SIP RTP Port</label>
</Setting>
<Setting>
<path>page-config/max.sessions</path>
<type>integer</type>
<value>50</value>
<defaultValue>50</defaultValue>
</Setting>
<Setting>
<path>page-config/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>
</Settings>
JSON format
{
settings: [8]
0: {
path: "page-config/prefix"
type: "string"
options: null
value: "*77"
defaultValue: "*77"
label: "Paging prefix"
description: null
}-
1: {
path: "page-config/sip.trace"
type: "enum"
options: {
NONE: null
DEBUG: null
TRACE: null
}-
value: "NONE"
defaultValue: "NONE"
label: "SIP Trace Level"
description: null
}-
2: {
path: "page-config/sip.tcpPort"
type: "integer"
options: null
value: "5160"
defaultValue: "5160"
label: "SIP TCP Port"
description: null
}-
3: {
path: "page-config/sip.udpPort"
type: "integer"
options: null
value: "5160"
defaultValue: "5160"
label: "SIP UDP Port"
description: null
}-
4: {
path: "page-config/sip.tlsPort"
type: "integer"
options: null
value: "5161"
defaultValue: "5161"
label: "SIP TLS Port"
description: null
}-
5: {
path: "page-config/rtp.port"
type: "integer"
options: null
value: "8500"
defaultValue: "8500"
label: "SIP RTP Port"
description: null
}-
6: {
path: "page-config/max.sessions"
type: "integer"
options: null
value: "50"
defaultValue: "50"
label: null
description: null
}-
7: {
path: "page-config/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
}-
-
}
HTTP Method: PUT
Stops registrations for the specified call ID.
HTTP Method: DELETE
Stops registrations for the specified call ID.
Unsupported HTTP Method: PUT, POST
View or create new prompt message
Available in 14 starting with 14.10
Resource URI: /pagegroups/prompts
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 of page groups prompts.
Example: XML format
<Files>
<File>
<name>attention.wav</name>
<size>71796</size>
<path>/var/sipxdata/sipxpage/music/attention.wav</path>
</File>
<File>
<name>TadaTada.wav</name>
<size>70104</size>
<path>/var/sipxdata/sipxpage/music/TadaTada.wav</path>
</File>
<File>
<name>fluffy.wav</name>
<size>100564</size>
<path>/var/sipxdata/sipxpage/music/fluffy.wav</path>
</File>
<File>
<name>notice.wav</name>
<size>34566</size>
<path>/var/sipxdata/sipxpage/music/notice.wav</path>
</File>
<File>
<name>fanfare.wav</name>
<size>34904</size>
<path>/var/sipxdata/sipxpage/music/fanfare.wav</path>
</File>
<File>
<name>reveille.wav</name>
<size>56566</size>
<path>/var/sipxdata/sipxpage/music/reveille.wav</path>
</File>
<File>
<name>nowhearthis.wav</name>
<size>51150</size>
<path>/var/sipxdata/sipxpage/music/nowhearthis.wav</path>
</File>
</Files>
JSON format
{
files: [7]
0: {
type: null
path: "/var/sipxdata/sipxpage/music/attention.wav"
name: "attention.wav"
size: 71796
}-
1: {
type: null
path: "/var/sipxdata/sipxpage/music/TadaTada.wav"
name: "TadaTada.wav"
size: 70104
}-
2: {
type: null
path: "/var/sipxdata/sipxpage/music/fluffy.wav"
name: "fluffy.wav"
size: 100564
}-
3: {
type: null
path: "/var/sipxdata/sipxpage/music/notice.wav"
name: "notice.wav"
size: 34566
}-
4: {
type: null
path: "/var/sipxdata/sipxpage/music/fanfare.wav"
name: "fanfare.wav"
size: 34904
}-
5: {
type: null
path: "/var/sipxdata/sipxpage/music/reveille.wav"
name: "reveille.wav"
size: 56566
}-
6: {
type: null
path: "/var/sipxdata/sipxpage/music/nowhearthis.wav"
name: "nowhearthis.wav"
size: 51150
}-
-
}
HTTP Method: POST
Uploads new prompt message.
Unsupported HTTP Method: PUT, DELETE
Download page group prompt
Available in 14 starting with 14.10
Resource URI: /pagegroups/prompts/{promptName}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Downloads prompt messages based on the specified file name.
Example: N/A
HTTP Method: DELETE
Deletes prompt messages based on the specified file name.
Unsupported HTTP Method: PUT, POST
Stream to page group prompt
Available in 14 starting with 14.10
Resource URI: /pagegroups/prompts/{promptName}/stream
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Example: N/A
Unsupported HTTP Method: PUT, POST, DELETE
Park orbit
Available in 14 starting with 14.10
View system orbits
Available in 14 starting with 14.10
Resource URI: /orbits
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
Downloads prompt messages based on the specified file name.
Example: XML format
<Orbit><id>%s</id><name>remoteOrbit</name>"
"<enabled>true</enabled><extension>5678</extension><description>remote orbit</description><music>default.wav</music>"
"<server>remote.example.org</server></Orbit>"
JSON format
"{\"orbits\":[{\"id\":%s,\"name\":\"primaryOrbit\",\"enabled\":true,\"extension\":\"1234\","
"\"description\":\"custom orbit\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"}]}"
HTTP Method: POST
Deletes prompt messages based on the specified file name.
Unsupported HTTP Method: PUT, DELETE
View or modify system orbits
Available in 14 starting with 14.10
Resource URI: /orbits/{orbitId}
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 orbit with the specified ID.
Example: XML format
<Orbits><Orbit><id>%s</id><name>primaryOrbit</name>"
"<enabled>true</enabled><extension>1234</extension><description>custom orbit</description><music>default.wav</music>"
"<server>primary.example.org</server></Orbit>"
"<Orbit><id>%s</id><name>remoteOrbit</name><enabled>false</enabled><extension>5678</extension>"
"<description>remote orbit changed</description><music>default.wav</music><server>primary.example.org</server></Orbit></Orbits>",
JSON format
"{\"orbits\":[{\"id\":%s,\"name\":\"primaryOrbit\",\"enabled\":true,\"extension\":\"1234\","
"\"description\":\"custom orbit\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"},"
"{\"id\":%s,\"name\":\"remoteOrbit\",\"enabled\":false,\"extension\":\"5678\","
"\"description\":\"remote orbit changed\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"}]}",
HTTP Method: PUT
Modifies orbit based with the specified ID.
HTTP Method: DELETE
Deletes orbit based with the specified ID.
Unsupported HTTP Method: PUT, POST
Manage orbit options
Available in 14 starting with 14.10
Resource URI: /orbits/{orbitId}/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 service options for the specified orbit ID.
Example: XML format
><Setting><path>general/parkTimeout</path>"
"<type>integer</type><value>120</value><defaultValue>120</defaultValue><label>Park time-out</label>"
"<description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description></Setting>"
JSON format
"{\"path\":\"general/parkTimeout\",\"type\":\"integer\",\"options\":null,\"value\":\"120\",\"defaultValue\":\"120\","
"\"label\":\"Park time-out\",\"description\":\"Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.\"}"
HTTP Method: PUT
Modifies service options for the specified orbit ID.
HTTP Method: DELETE
Deletes service options for the specified orbit ID.
Unsupported HTTP Method: PUT, POST
Manage orbit services
Available in 14 starting with 14.10
Resource URI: /orbits/{orbitId}/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 general service options.
Example: XML format
<Settings>
<Setting>
<path>general/enableTimeout</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Enable time-out</label>
<description>If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed.</description>
</Setting>
<Setting>
<path>general/parkTimeout</path>
<type>integer</type>
<value>120</value>
<defaultValue>120</defaultValue>
<label>Park time-out</label>
<description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description>
</Setting>
<Setting>
<path>general/multipleCalls</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Allow multiple calls</label>
<description>If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked.</description>
</Setting>
<Setting>
<path>general/allowTransfer</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Allow transfer</label>
<description>If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section.</description>
</Setting>
<Setting>
<path>general/transferKey</path>
<type>string</type>
<value>0</value>
<defaultValue>0</defaultValue>
<label>Transfer key</label>
<description>Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled.</description>
</Setting>
</Settings>
JSON format
{
settings:
{
path: "general/enableTimeout"
type: "boolean"
options: null
value: "1"
defaultValue: "1"
label: "Enable time-out"
description: "If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed."
}-
{
path: "general/parkTimeout"
type: "integer"
options: null
value: "120"
defaultValue: "120"
label: "Park time-out"
description: "Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled."
}-
{
path: "general/multipleCalls"
type: "boolean"
options: null
value: "1"
defaultValue: "1"
label: "Allow multiple calls"
description: "If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked."
}-
{
path: "general/allowTransfer"
type: "boolean"
options: null
value: "1"
defaultValue: "1"
label: "Allow transfer"
description: "If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section."
}-
{
path: "general/transferKey"
type: "string"
options: null
value: "0"
defaultValue: "0"
label: "Transfer key"
description: "Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled."
}-
-
}<Settings>
<Setting>
<path>general/enableTimeout</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Enable time-out</label>
<description>If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed.</description>
</Setting>
<Setting>
<path>general/parkTimeout</path>
<type>integer</type>
<value>120</value>
<defaultValue>120</defaultValue>
<label>Park time-out</label>
<description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description>
</Setting>
<Setting>
<path>general/multipleCalls</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Allow multiple calls</label>
<description>If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked.</description>
</Setting>
<Setting>
<path>general/allowTransfer</path>
<type>boolean</type>
<value>1</value>
<defaultValue>1</defaultValue>
<label>Allow transfer</label>
<description>If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section.</description>
</Setting>
<Setting>
<path>general/transferKey</path>
<type>string</type>
<value>0</value>
<defaultValue>0</defaultValue>
<label>Transfer key</label>
<description>Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled.</description>
</Setting>
</Settings>
HTTP Method: PUT
Modifies general service options.
HTTP Method: DELETE
Deletes general service options.
Unsupported HTTP Method: PUT, POST
View or create new prompt message
Available in 14 starting with 14.10
Resource URI: /orbits/prompts
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 of orbit prompts.
Example: XML format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Files>
<File>
<name>default.wav</name>
<size>4029662</size>
<path>/var/sipxdata/parkserver/music/default.wav</path>
</File>
</Files>
JSON format
{
files: [1]
0: {
type: null
path: "/var/sipxdata/parkserver/music/default.wav"
name: "default.wav"
size: 4029662
}-
-
}
HTTP Method: POST
Uploads new prompt message.
Unsupported HTTP Method: PUT, DELETE
Download orbit prompt
Available in 14 starting with 14.10
Resource URI: /orbits/prompts/{promptName}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Downloads prompt messages based on the specified file name.
Example: N/A
HTTP Method: DELETE
Deletes prompt messages based on the specified file name.
Unsupported HTTP Method: PUT, POST
Stream to orbit prompt
Available in 14 starting with 14.10
Resource URI: /orbits/prompts/{promptName}/stream
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Example: N/A
Unsupported HTTP Method: PUT, POST, DELETE
Proxy
Available in 14 starting with 14.10
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
My buddy
Available in 14 starting with 14.10
View My buddy settings
Available in 14 starting with 14.10
Resource URI: /imbot/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 My buddy settings in the system.
Example: XML format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Settings>
<Setting>
<path>imbot/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>imbot/_imbot.paUserName</path>
<type>string</type>
<value>mybuddy</value>
<defaultValue>mybuddy</defaultValue>
<label>IM ID</label>
<description>The ID under which ImBot feature is visible in the contact list.</description>
</Setting>
<Setting>
<path>imbot/imbot.paPassword</path>
<type>string</type>
<label>IM password</label>
<description>If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP.</description>
</Setting>
</Settings>
JSON format
{
settings: [3]
0: {
path: "imbot/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
}-
1: {
path: "imbot/_imbot.paUserName"
type: "string"
options: null
value: "mybuddy"
defaultValue: "mybuddy"
label: "IM ID"
description: "The ID under which ImBot feature is visible in the contact list."
}-
2: {
path: "imbot/imbot.paPassword"
type: "string"
options: null
value: null
defaultValue: null
label: "IM password"
description: "If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP."
}-
-
}
Unsupported HTTP Method: PUT, POST, DELETE
View or modify My buddy settings
Available in 14 starting with 14.10
Resource URI: /imbot/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 My buddy options for the setting from the specified path.
Example: XML format
<Setting>
<path>imbot/_imbot.paUserName</path>
<type>string</type>
<value>mybuddy</value>
<defaultValue>mybuddy</defaultValue>
<label>IM ID</label>
<description>The ID under which ImBot feature is visible in the contact list.</description>
</Setting>
JSON format
{
path: "imbot/_imbot.paUserName"
type: "string"
options: null
value: "mybuddy"
defaultValue: "mybuddy"
label: "IM ID"
description: "The ID under which ImBot feature is visible in the contact list."
}
HTTP Method: PUT
Modifies My buddy options for the setting from the specified path.
HTTP Method: DELETE
Deletes My buddy options for the setting from the specified path.
Unsupported HTTP Method: POST
Registrar
Available in 14 starting with 14.10
View registrar settings
Available in 14 starting with 14.10
Resource URI: /registrar/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 registrars' settings in the system.
Example: XML format
<Settings>
<Setting>
<path>registrar-config/SIP_REGISTRAR_TCP_PORT</path>
<type>integer</type>
<value>5070</value>
<defaultValue>5070</defaultValue>
<label>TCP Port</label>
<description />
</Setting>
<Setting>
<path>registrar-config/SIP_REGISTRAR_UDP_PORT</path>
<type>integer</type>
<value>5070</value>
<defaultValue>5070</defaultValue>
<label>UDP Port</label>
<description />
</Setting>
<Setting>
<path>registrar-config/SIP_REGISTRAR_REG_EVENT_PORT</path>
<type>integer</type>
<value>5075</value>
<defaultValue>5075</defaultValue>
<label>Registrar Event Port</label>
<description />
</Setting>
<Setting>
<path>registrar-config/SIP_REGISTRAR_XMLRPC_PORT</path>
<type>integer</type>
<value>5077</value>
<defaultValue>5077</defaultValue>
<label>XMLRPC Port</label>
<description />
</Setting>
<Setting>
<path>registrar-config/_SIP_REGISTRAR_PRESENCE_PORT</path>
<type>integer</type>
<value>9096</value>
<defaultValue>9096</defaultValue>
<label>Presence Port</label>
<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
{
settings: [35]
0: {
path: "registrar-config/SIP_REGISTRAR_TCP_PORT"
type: "integer"
options: null
value: "5070"
defaultValue: "5070"
label: "TCP Port"
description: ""
}-
1: {
path: "registrar-config/SIP_REGISTRAR_UDP_PORT"
type: "integer"
options: null
value: "5070"
defaultValue: "5070"
label: "UDP Port"
description: ""
}-
2: {
path: "registrar-config/SIP_REGISTRAR_REG_EVENT_PORT"
type: "integer"
options: null
value: "5075"
defaultValue: "5075"
label: "Registrar Event Port"
description: ""
}-
3: {
path: "registrar-config/SIP_REGISTRAR_XMLRPC_PORT"
type: "integer"
options: null
value: "5077"
defaultValue: "5077"
label: "XMLRPC Port"
description: ""
}-
4: {
path: "registrar-config/_SIP_REGISTRAR_PRESENCE_PORT"
type: "integer"
options: null
value: "9096"
defaultValue: "9096"
label: "Presence Port"
description: ""
}
Unsupported HTTP Method: PUT, POST, DELETE
View or modify registrar settings
Available in 14 starting with 14.10
Resource URI: /registrar/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 registrars' options for the setting from the specified path.
Example: XML format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Setting>
<path>other/SIPX_SEND_TRYING_FOR_NIST</path>
<type>boolean</type>
<value>true</value>
<defaultValue>true</defaultValue>
<label>Send 'Trying' response on registrations</label>
<description>By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this.</description>
</Setting>
JSON format
{
path: "other/SIPX_SEND_TRYING_FOR_NIST"
type: "boolean"
options: null
value: "true"
defaultValue: "true"
label: "Send 'Trying' response on registrations"
description: "By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this."
}
HTTP Method: PUT
Modifies registrars' options options for the setting from the specified path.
HTTP Method: DELETE
Deletes registrars' options options for the setting from the specified path.
Unsupported HTTP Method: POST
Shared Appearance Agent (SAA)
Available in 14 starting with 14.10
View SAA settings
Available in 14 starting with 14.10
Resource URI: /saa/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 SAA settings in the system.
Example: XML format
<Settings>
<Setting>
<path>Uniteme-saa-config/server-udp-port</path>
<type>integer</type>
<value>5170</value>
<defaultValue>5170</defaultValue>
<label>UDP Port</label>
</Setting>
<Setting>
<path>Uniteme-saa-config/server-tcp-port</path>
<type>integer</type>
<value>5170</value>
<defaultValue>5170</defaultValue>
<label>TCP Port</label>
</Setting>
<Setting>
<path>Uniteme-saa-config/log-level</path>
<type>enum</type>
<options>
<entry>
<key>3</key>
<value>ERR</value>
</entry>
<entry>
<key>2</key>
<value>CRIT</value>
</entry>
<entry>
<key>1</key>
<value>ALERT</value>
</entry>
<entry>
<key>0</key>
<value>EMERG</value>
</entry>
<entry>
<key>7</key>
<value>DEBUG</value>
</entry>
<entry>
<key>6</key>
<value>INFO</value>
</entry>
<entry>
<key>5</key>
<value>NOTICE</value>
</entry>
<entry>
<key>4</key>
<value>WARNING</value>
</entry>
</options>
<value>5</value>
<defaultValue>5</defaultValue>
<label>Log Level</label>
</Setting>
<Setting>
<path>Uniteme-saa-config/server-min-expires</path>
<type>integer</type>
<value>300</value>
<defaultValue>300</defaultValue>
<label>Minimum Expires</label>
<description>Minimum number of seconds after which the subscribe expires</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/server-default-expires</path>
<type>integer</type>
<value>3600</value>
<defaultValue>3600</defaultValue>
<label>Default Expires</label>
<description>Default number of seconds after which the subscribe expires</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/server-max-expires</path>
<type>integer</type>
<value>86400</value>
<defaultValue>86400</defaultValue>
<label>Maximum Expires</label>
<description>Maximum number of seconds after which the subscribe expires</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/notification-interval</path>
<type>integer</type>
<value>1000</value>
<defaultValue>1000</defaultValue>
<label>Notification Interval</label>
<description>The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/enable-stack-logs</path>
<type>boolean</type>
<value>false</value>
<defaultValue>false</defaultValue>
<label>Enable Stack Logs</label>
<description>If checked SAA will save in the log file also the logs generated by the internal stack</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/max-udp-notify-body-size</path>
<type>integer</type>
<value>64512</value>
<defaultValue>64512</defaultValue>
<label>Maximum UDP NOTIFY Body Size</label>
<description>Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers.</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/max-tcp-notify-body-size</path>
<type>integer</type>
<value>10485760</value>
<defaultValue>10485760</defaultValue>
<label>Maximum TCP NOTIFY Body Size</label>
<description>Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb.</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/max-notify-resend-interval-sec</path>
<type>integer</type>
<value>300</value>
<defaultValue>300</defaultValue>
<label>Maximum notify resend interval</label>
<description>Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval.</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/max-instances-per-line</path>
<type>integer</type>
<value>63</value>
<defaultValue>63</defaultValue>
<label>Maximum appearances per line</label>
<description>Maximum number of appearances for a shared line.</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/max-appearances-per-line</path>
<type>integer</type>
<value>24</value>
<defaultValue>24</defaultValue>
<label>Maximum instances per line</label>
<description>Maximum number of instances for a shared line.</description>
</Setting>
<Setting>
<path>Uniteme-saa-config/subscription-restart-interval</path>
<type>integer</type>
<value>86400</value>
<defaultValue>86400</defaultValue>
<label>Subscription restart interval</label>
<description>Time in seconds after which SAA client subscriptions are restarted.</description>
</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>
settings: [17]
0: {
path: "Uniteme-saa-config/server-udp-port"
type: "integer"
options: null
value: "5170"
defaultValue: "5170"
label: "UDP Port"
description: null
}-
1: {
path: "Uniteme-saa-config/server-tcp-port"
type: "integer"
options: null
value: "5170"
defaultValue: "5170"
label: "TCP Port"
description: null
}-
2: {
path: "Uniteme-saa-config/log-level"
type: "enum"
options: {
0: "EMERG"
1: "ALERT"
2: "CRIT"
3: "ERR"
4: "WARNING"
5: "NOTICE"
6: "INFO"
7: "DEBUG"
}-
value: "5"
defaultValue: "5"
label: "Log Level"
description: null
}-
3: {
path: "Uniteme-saa-config/server-min-expires"
type: "integer"
options: null
value: "300"
defaultValue: "300"
label: "Minimum Expires"
description: "Minimum number of seconds after which the subscribe expires"
}-
4: {
path: "Uniteme-saa-config/server-default-expires"
type: "integer"
options: null
value: "3600"
defaultValue: "3600"
label: "Default Expires"
description: "Default number of seconds after which the subscribe expires"
}-
5: {
path: "Uniteme-saa-config/server-max-expires"
type: "integer"
options: null
value: "86400"
defaultValue: "86400"
label: "Maximum Expires"
description: "Maximum number of seconds after which the subscribe expires"
}-
6: {
path: "Uniteme-saa-config/notification-interval"
type: "integer"
options: null
value: "1000"
defaultValue: "1000"
label: "Notification Interval"
description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"
}-
7: {
path: "Uniteme-saa-config/enable-stack-logs"
type: "boolean"
options: null
value: "false"
defaultValue: "false"
label: "Enable Stack Logs"
description: "If checked SAA will save in the log file also the logs generated by the internal stack"
}-
8: {
path: "Uniteme-saa-config/max-udp-notify-body-size"
type: "integer"
options: null
value: "64512"
defaultValue: "64512"
label: "Maximum UDP NOTIFY Body Size"
description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."
}-
9: {
path: "Uniteme-saa-config/max-tcp-notify-body-size"
type: "integer"
options: null
value: "10485760"
defaultValue: "10485760"
label: "Maximum TCP NOTIFY Body Size"
description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."
}-
10: {
path: "Uniteme-saa-config/max-notify-resend-interval-sec"
type: "integer"
options: null
value: "300"
defaultValue: "300"
label: "Maximum notify resend interval"
description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."
}-
11: {
path: "Uniteme-saa-config/max-instances-per-line"
type: "integer"
options: null
value: "63"
defaultValue: "63"
label: "Maximum appearances per line"
description: "Maximum number of appearances for a shared line."
}-
12: {
path: "Uniteme-saa-config/max-appearances-per-line"
type: "integer"
options: null
value: "24"
defaultValue: "24"
label: "Maximum instances per line"
description: "Maximum number of instances for a shared line."
}-
13: {
path: "Uniteme-saa-config/subscription-restart-interval"
type: "integer"
options: null
value: "86400"
defaultValue: "86400"
label: "Subscription restart interval"
description: "Time in seconds after which SAA client subscriptions are restarted."
}-
14: {
path: "resource-limits/fd-soft"
type: "integer"
options: null
value: "32768"
defaultValue: "32768"
label: "FD Soft"
description: "FD Soft resource limit"
}-
15: {
path: "resource-limits/fd-hard"
type: "integer"
options: null
value: "65536"
defaultValue: "65536"
label: "FD Hard"
description: "FD Hard resource limit"
}-
16: {
path: "resource-limits/core-enabled"
type: "boolean"
options: null
value: "false"
defaultValue: "false"
label: "Core Enabled"
description: "Core Enabled resource limit"
}-
-
}
JSON format
{
settings: [17]
0: {
path: "Uniteme-saa-config/server-udp-port"
type: "integer"
options: null
value: "5170"
defaultValue: "5170"
label: "UDP Port"
description: null
}-
1: {
path: "Uniteme-saa-config/server-tcp-port"
type: "integer"
options: null
value: "5170"
defaultValue: "5170"
label: "TCP Port"
description: null
}-
2: {
path: "Uniteme-saa-config/log-level"
type: "enum"
options: {
0: "EMERG"
1: "ALERT"
2: "CRIT"
3: "ERR"
4: "WARNING"
5: "NOTICE"
6: "INFO"
7: "DEBUG"
}-
value: "5"
defaultValue: "5"
label: "Log Level"
description: null
}-
3: {
path: "Uniteme-saa-config/server-min-expires"
type: "integer"
options: null
value: "300"
defaultValue: "300"
label: "Minimum Expires"
description: "Minimum number of seconds after which the subscribe expires"
}-
4: {
path: "Uniteme-saa-config/server-default-expires"
type: "integer"
options: null
value: "3600"
defaultValue: "3600"
label: "Default Expires"
description: "Default number of seconds after which the subscribe expires"
}-
5: {
path: "Uniteme-saa-config/server-max-expires"
type: "integer"
options: null
value: "86400"
defaultValue: "86400"
label: "Maximum Expires"
description: "Maximum number of seconds after which the subscribe expires"
}-
6: {
path: "Uniteme-saa-config/notification-interval"
type: "integer"
options: null
value: "1000"
defaultValue: "1000"
label: "Notification Interval"
description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"
}-
7: {
path: "Uniteme-saa-config/enable-stack-logs"
type: "boolean"
options: null
value: "false"
defaultValue: "false"
label: "Enable Stack Logs"
description: "If checked SAA will save in the log file also the logs generated by the internal stack"
}-
8: {
path: "Uniteme-saa-config/max-udp-notify-body-size"
type: "integer"
options: null
value: "64512"
defaultValue: "64512"
label: "Maximum UDP NOTIFY Body Size"
description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."
}-
9: {
path: "Uniteme-saa-config/max-tcp-notify-body-size"
type: "integer"
options: null
value: "10485760"
defaultValue: "10485760"
label: "Maximum TCP NOTIFY Body Size"
description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."
}-
10: {
path: "Uniteme-saa-config/max-notify-resend-interval-sec"
type: "integer"
options: null
value: "300"
defaultValue: "300"
label: "Maximum notify resend interval"
description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."
}-
11: {
path: "Uniteme-saa-config/max-instances-per-line"
type: "integer"
options: null
value: "63"
defaultValue: "63"
label: "Maximum appearances per line"
description: "Maximum number of appearances for a shared line."
}-
12: {
path: "Uniteme-saa-config/max-appearances-per-line"
type: "integer"
options: null
value: "24"
defaultValue: "24"
label: "Maximum instances per line"
description: "Maximum number of instances for a shared line."
}-
13: {
path: "Uniteme-saa-config/subscription-restart-interval"
type: "integer"
options: null
value: "86400"
defaultValue: "86400"
label: "Subscription restart interval"
description: "Time in seconds after which SAA client subscriptions are restarted."
}-
14: {
path: "resource-limits/fd-soft"
type: "integer"
options: null
value: "32768"
defaultValue: "32768"
label: "FD Soft"
description: "FD Soft resource limit"
}-
15: {
path: "resource-limits/fd-hard"
type: "integer"
options: null
value: "65536"
defaultValue: "65536"
label: "FD Hard"
description: "FD Hard resource limit"
}-
16: {
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 SAA settings
Available in 14 starting with 14.10
Resource URI: /saa/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 SAA options for the setting from the specified path.
Example: XML format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Setting>
<path>Uniteme-saa-config/subscription-restart-interval</path>
<type>integer</type>
<value>86400</value>
<defaultValue>86400</defaultValue>
<label>Subscription restart interval</label>
<description>Time in seconds after which SAA client subscriptions are restarted.</description>
</Setting>
JSON format
{
path: "Uniteme-saa-config/subscription-restart-interval"
type: "integer"
options: null
value: "86400"
defaultValue: "86400"
label: "Subscription restart interval"
description: "Time in seconds after which SAA client subscriptions are restarted."
}
HTTP Method: PUT
Modifies SAA options options for the setting from the specified path.
HTTP Method: DELETE
Deletes SAA options options for the setting from the specified path.
Unsupported HTTP Method: POST
REST servers
Available in 14 starting with 14.10
View REST servers settings
Available in 14 starting with 14.10
Resource URI: /restserver/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 REST servers settings in the system.
Example: XML format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Settings>
<Setting>
<path>rest-config/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>rest-config/sipPort</path>
<type>integer</type>
<value>6050</value>
<defaultValue>6050</defaultValue>
<label>Sip Port</label>
</Setting>
<Setting>
<path>rest-config/httpPort</path>
<type>integer</type>
<value>6667</value>
<defaultValue>6667</defaultValue>
<label>Http Port</label>
</Setting>
<Setting>
<path>rest-config/publicHttpPort</path>
<type>integer</type>
<value>6666</value>
<defaultValue>6666</defaultValue>
<label>Public Http Port</label>
</Setting>
</Settings>
JSON format
{
settings: [4]
0: {
path: "rest-config/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
}-
1: {
path: "rest-config/sipPort"
type: "integer"
options: null
value: "6050"
defaultValue: "6050"
label: "Sip Port"
description: null
}-
2: {
path: "rest-config/httpPort"
type: "integer"
options: null
value: "6667"
defaultValue: "6667"
label: "Http Port"
description: null
}-
3: {
path: "rest-config/publicHttpPort"
type: "integer"
options: null
value: "6666"
defaultValue: "6666"
label: "Public Http Port"
description: null
}-
-
}
Unsupported HTTP Method: PUT, POST, DELETE
View or modify REST servers settings
Available in 14 starting with 14.10
Resource URI: /restserver/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 REST servers options for the setting from the specified path.
Example: XML format
<Setting>
<path>rest-config/httpPort</path>
<type>integer</type>
<value>6667</value>
<defaultValue>6667</defaultValue>
<label>Http Port</label>
</Setting>
JSON format
{
path: "rest-config/httpPort"
type: "integer"
options: null
value: "6667"
defaultValue: "6667"
label: "Http Port"
description: null
}
HTTP Method: PUT
Modifies REST servers options options for the setting from the specified path.
HTTP Method: DELETE
Deletes REST servers options options for the setting from the specified path.
Unsupported HTTP Method: POST
Schedules
Available in 14 starting with 14.10
View all general schedules
Available in 14 starting with 14.10
Resource URI: /schedules/general
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
Retrieve all general schedules.
Example: XML format
"<Schedules><Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
"<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
"</workingHours></workingTime></Schedule></Schedules>", schedule.getId()), schedules);
JSON format
"{\"schedules\":[{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\","\"workingTime\":{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}]}", schedule.getId()), schedules);
Unsupported HTTP Method: POST, PUT, DELETE
View all schedules for a group ID
Available in 14 starting with 14.10
Resource URI: /schedules/group/{groupId}
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
Retrieve schedules for the specified group ID.
Example: XML format
JSON format
Unsupported HTTP Method: POST, PUT, DELETE
View all schedules for a user ID
Available in 14 starting with 14.10
Resource URI: /schedules/user/{userId}/all
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
Retrieve schedules for the specified user ID.
Example: XML format
<Schedules>
<Schedule>
<id>2</id>
<name>User200</name>
<description>desc</description>
<userId>10</userId>
<groupId>-1</groupId>
<type>user</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T11:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>WEEKEND</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
<Schedule>
<id>3</id>
<name>Cust</name>
<description>desc</description>
<userId>-1</userId>
<groupId>13</groupId>
<type>group</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T02:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>FRIDAY</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
</Schedules>
JSON format
{
schedules: [2]
0: {
id: 2
name: "User200"
description: "desc"
userId: 10
groupId: -1
type: "S"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 32400000
stop: 64800000
scheduledDay: "Weekend"
}-
-
}-
}-
1: {
id: 3
name: "Cust"
description: "desc"
userId: -1
groupId: 13
type: "U"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 0
stop: 64800000
scheduledDay: "Friday"
}-
-
}-
}-
-
}
Unsupported HTTP Method: POST, PUT, DELETE
View personal schedules for a user ID
Available in 14 starting with 14.10
Resource URI: /schedules/user/{userId}/personal
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
Retrieve personal schedules for the specified user ID.
Example: XML format
<Schedules>
<Schedule>
<id>2</id>
<name>User200</name>
<description>desc</description>
<userId>10</userId>
<groupId>-1</groupId>
<type>user</type>
<workingTime>
<workingHours>
<enabled>false</enabled>
<start>1970-01-01T11:00:00+02:00</start>
<stop>1970-01-01T20:00:00+02:00</stop>
<scheduledDay>WEEKEND</scheduledDay>
</workingHours>
</workingTime>
</Schedule>
</Schedules>
JSON format
{
schedules: [1]
0: {
id: 2
name: "User200"
description: "desc"
userId: 10
groupId: -1
type: "S"
workingTime: {
workingHours: [1]
0: {
enabled: false
start: 32400000
stop: 64800000
scheduledDay: "Weekend"
}-
-
}-
}-
-
}
HTTP Method: POST
Create a personal schedule for the specified user ID.
Unsupported HTTP Method: PUT, DELETE
View description for a schedule ID
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}
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
View the description for the specified schedule ID.
Example: XML format
"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
"<Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
"<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
"</workingHours></workingTime></Schedule>",
schedule.getId()), scheduleXml);
JSON format
"{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\",\"workingTime\":"
+ "{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}",
HTTP Method: PUT
Update the description for the specified schedule ID.
HTTP Method: DELETE
Delete the description for the specified schedule ID.
Unsupported HTTP Method: POST
Add periods to a schedule ID
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}/period
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: POST
Create a personal schedule for the specified user ID.
{\"enabled\":false,\"start\":34400000,\"stop\":64800000,\"scheduledDay\":\"Monday\"}"
Unsupported HTTP Method: GET, PUT, DELETE
Delete index periods from a schedule ID?
Available in 14 starting with 14.10
Resource URI: /schedules/{scheduleId}/period/{index}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: DELETE
Create a personal schedule for the specified user ID.
Unsupported HTTP Method: GET, PUT, DELETE