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