Skip to end of metadata
Go to start of metadata

Send a Phone Profile

curl --insecure -X PUT https://superadmin:12345678@[servername or  IP]/sipxconfig/api/phones/0004f280cc95/sendProfile/restart

Create a phone

Resource URI: /phones
Default Resource Properties:

Property

Description

serialNumber

The serial number of the phone.

model

Phone model.

description

Short description provided by the user.

Specific Response Codes: N/A
HTTP Method: GET
Examples: XML format
<phones>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"<description>Phone 1 - YES</description>
</phone>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"
<description>NO - duplicate serial number</description> </phone>
</phones>
JSON format
{
"phones": {

"phone": [


{
"serialNumber": "000000c0ffea",
"model": "testPhoneModel",
"description": "Phone 1 - YES"
},
{
"serialNumber": "000000c0ffeb",
"model": "testPhoneModel",
"description": "NO - duplicate serial number"
}
]}
}
HTTP Method: POST
Creates a new phone.
Unsupported HTTP Methods: PUT, DELETE


Retrieve phone profile

Resource URI: /phones/{serialNumber}/profile/{name}
Default Resource Properties: N/A
Specific Response Codes: Error 404 when {serialNumber} or {name} not found.
HTTP Method: GET
Retrieves phone profile representation given phone serial number and file name
Unsupported HTTP Methods: POST, PUT, DELETE

View phone models

Available in 14 starting with 14.10

Resource URI: /phones/models

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

modelId

Model unique identification number

label

Model label.


Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description


Specific Response Codes: N/A

HTTP Method: GET

Retrieves a list with all the phone models available in the system.

Example: XML format

<Models><Model><modelId>SPA501G</modelId><label>Cisco SPA501G</label></Model><Model><modelId>SPA502G</modelId><label>Cisco SPA502G</label></Model><Models>

JSON format

{"models":[{"modelId":"SPA501G","label":"Cisco SPA501G","vendor":null,"versions":null},{"modelId":"SPA502G","label":"Cisco SPA502G","vendor":null,"versions":null}]}

HTTP Method: PUT

Updates the settings of the gateway. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.

Unsupported HTTP Method: POST

View or create a phone

Available in 14 starting with 14.10

Resource URI: /phones

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

ID

Phone unique identification number.

serialNo

Phone serial number.

description

Short description provided by the user.

label

Label of the phone model.

vendor

Vendor of the phone model.

lines

Lines associated with the phone ID.

ID

Model unique identification number.

uri

The URI for the Uniteme instance.

user

User name.

userID

User unique identification number.

displayName

The display name for the user.

password

The password associated with the user.

registrationServer

Name of the registration server.

lines

Lines associated with the model ID.

id

Group ID.

name

Name of the group.

description

Short description provided by the user.

weight



Specific Response Codes: N/A

HTTP Method: GET

Retrieves all phones.

Example: XML format

><Phones>

<Phone>

<id>1</id>

<serialNo>111111111111</serialNo>

<description>desc</description>

<Model>

<modelId>counterpathCMCEnterprise

</modelId>

<label>Bria 3.x</label>

<vendor>Counterpath</vendor>

</Model><Lines><Line><id>1</id>

<uri>"banaanab"<sip:200@workezuce.ro></uri>

<user>200</user>

<userId>200</userId>

<displayName>bana anab</displayName>

<password>123</password>

<registrationServer>work-ezuce.ro</registrationServer>

</Line></Lines>

<Groups><Group>

<id>13</id>

<name>bria</name>

<description>desc</description>

<weight>3</weight>

</Group></Groups>

</Phone></Phones>

JSON format

{"phones":[{"id":1,"serialNo":"111111111111","deviceVersion":null,"description":"desc","model":{"modelId":"counterpathCMCEnterprise","label":"Bria 3.x","vendor":"Counterpath","versions":null},"lines":[{"id":1,"uri":"\"bana anab\"<sip:200@work-ezuce.ro>","user":"200","userId":"200","extension":null,"displayName":"bana anab","password":"123","registrationServer":"work-ezuce.ro","registrationServerPort":null,"voicemail":null}],"groups":[{"id":13,"name":"bria","description":"desc","weight":3,"count":null}]}]}

HTTP Method: POST

Creates a new phone.

Unsupported HTTP Method: PUT, DELETE


View or modify a phone

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

Phone

The phones related information is similar to the one described under /phones and phones/models


Specific Response Codes: N/A

HTTP Method: GET

Retrieve details for the phone with the specified phone ID or MAC.

Example: XML format

<Phone>

<id>6</id>

<serialNo>0004f26ad217</serialNo>

<deviceVersion>polycom4.1.5</deviceVersion>

<description>Auto-provisioned ID: F58 Version: 5.1.1.2990</description>

<Model>

<modelId>polycomVVX600</modelId>

<label>Polycom VVX 600</label>

<vendor>Polycom</vendor>

<Versions>

<Version>polycom4.1.X</Version>

<Version>polycom4.1.2</Version>

<Version>polycom4.1.3</Version>

<Version>polycom4.1.5</Version>

<Version>polycom4.1.6</Version>

<Version>polycom5.0.0</Version>

<Version>polycom5.0.1</Version>

<Version>polycom5.0.2</Version>

</Versions>

</Model>

<Lines>

<Line>

<id>9</id>

<uri>sip:300@dlu.ezuce.ro</uri>

<user>300</user>

<userId>300</userId>

<password>123</password>

<registrationServer>dluca.ezuce.ro</registrationServer>

<registrationServerPort>0</registrationServerPort>

</Line>

</Lines>

</Phone>

JSON format

{

id: 6

serialNo: "0004f26ad217"

deviceVersion: "polycom4.1.5"

description: "Auto-provisioned ID: F58 Version: 5.1.1.2990 "

model: {

modelId: "polycomVVX600"

label: "Polycom VVX 600"

vendor: "Polycom"

versions: [8]

0: "polycom4.1.X"

1: "polycom4.1.2"

2: "polycom4.1.3"

3: "polycom4.1.5"

4: "polycom4.1.6"

5: "polycom5.0.0"

6: "polycom5.0.1"

7: "polycom5.0.2"

-

}-

lines: [1]

0: {

id: 9

uri: "sip:300@dlu.ezuce.ro"

user: "300"

userId: "300"

extension: null

displayName: null

password: "123"

registrationServer: "dlu.ezuce.ro"

registrationServerPort: "0"

voicemail: null

}-

-

groups: null

}

HTTP Method: PUT

Modify the phone with the specified phone ID or MAC.

HTTP Method: DELETE

Delete the phone with the specified phone ID or MAC.

Unsupported HTTP Method: POST


View or delete phones from groups

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}/groups

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

Retrieve the group/s for the specified phone ID.

Example: XML format

<Groups>

<Group>

<id>7</id>

<name>SSComm</name>

<description>desc</description>

<weight>2</weight>

</Group>

</Groups>

JSON format

{

groups: [1]

0: {

id: 7

name: "SSComm"

description: "desc"

weight: 2

count: null

}-

-

}

HTTP Method: DELETE

Delete the groups for the specified phone ID.

Unsupported HTTP Method: POST, PUT


Delete or add phones in groups

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}/groups/{groupName}

Default Resource Properties: N/A

Specific Response Codes: N/A

HTTP Method: POST

Add a phone in the specified group name.

Example: N/A

HTTP Method: DELETE

Delete a phone from the specified group name.

Unsupported HTTP Method: GET, PUT


View group settings

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

path

Setting path.

type

Setting type. Possible values are string or boolean.

value


defaultValue

Default value.

label

Label setting.

description

Short description provided by the user.


Specific Response Codes: N/A

HTTP Method: GET

Retrieve the setting or settings from the group from the specified path.

Example: XML format

<Setting>

<path>lcl/datetime/date.format</path>

<type>string</type>

<value>D,Md</value>

<defaultValue>D,Md</defaultValue>

<label>Format</label>

<description>Controls the format of the date string (D = day of week, d = day of the month, M = month), e.g. D,dM = "Thursday, 3 July" or "Md,D = July 3, Thursday". The field may contain 0, 1 or 2 commas, which can occur only between characters and only one at a time i.e. 'D,,dM' is illegal.</description>

</Setting>

JSON format

{

path: "lcl/datetime/date.format"

type: "string"

options: null

value: "D,Md"

defaultValue: "D,Md"

label: "Format"

description: "Controls the format of the date string (D = day of week, d = day of the month, M = month), e.g. D,dM = "Thursday, 3 July" or "Md,D = July 3, Thursday". The field may contain 0, 1 or 2 commas, which can occur only between characters and only one at a time i.e. 'D,,dM' is illegal."

}

HTTP Method: PUT

Update the setting or settings from the group from the specified path.

HTTP Method: DELETE

Delete the setting or settings from the group from the specified path.

Unsupported HTTP Method: POST


Delete or add lines to a phone ID

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}/lines

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Line unique identification number

uri

URI for the line

user

User name.

userId

User unique identification number.

password

User password.

registrationServer

Name of the registration server.

registrationServerPort

Number of the registration server port.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve the lines for the phone with the specified ID.

Example: XML format

<Lines>

<Line>

<id>9</id>

<uri>sip:300@dlu.ezuce.ro</uri>

<user>300</user>

<userId>300</userId>

<password>123</password>

<registrationServer>dlu.ezuce.ro</registrationServer>

<registrationServerPort>0</registrationServerPort>

</Line>

</Lines>

JSON format

{

lines: [1]

0: {

id: 9

uri: "sip:300@dluca.ezuce.ro"

user: "300"

userId: "300"

extension: null

displayName: null

password: "123"

registrationServer: "dluca.ezuce.ro"

registrationServerPort: "0"

voicemail: null

}-

-

}

HTTP Method: POST

Add a new line for the phone with the specified ID.

HTTP Method: DELETE

Delete the setting or settings from the group from the specified path.

Unsupported HTTP Method: PUT


View or modify group settings

Available in 14 starting with 14.10

Resource URI: /phones/{phoneId}/lines/{lineId}/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

path

Setting path.

type

Setting type.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve the group setting or settings, from the specified path.

Example: XML format

<Setting>

<path>line-dialplan/digitmap/digitmap</path>

<type>string</type>

<description>When present, this attribute overrides the global dial plan defined Phone's Dial Plan settings</description>

</Setting>

JSON format

{

path: "line-dialplan/digitmap/digitmap"

type: "string"

options: null

value: null

defaultValue: null

label: null

description: "When present, this attribute overrides the global dial plan defined Phone's Dial Plan settings"

}

HTTP Method: PUT

Modify the group setting or settings, from the specified path.

HTTP Method: DELETE

Delete the group setting or settings, from the specified path.

Unsupported HTTP Method: POST


  • No labels