Child pages
  • Phone Groups Rest
Skip to end of metadata
Go to start of metadata

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

{

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"

versions: [1]

0: "yealink7X"

-

}-

{

modelId: "yealinkPhoneW52"

label: "Yealink W52"

vendor: "Yealink"

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


  • No labels