Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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": {

...

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

...

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

...

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

...

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

...

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

...

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

...

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

...