Skip to end of metadata
Go to start of metadata

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

  • No labels