Phone models

List phone models

get

List IP phones models.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get/phone_models

HTTPcURLJavaScriptPython

GET /api/phone_models HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "filename": "text",
      "model": "text",
      "display_name": "text"
    }
  ]
}

Retrieve profile of firmware template

get

Retrieve phone template profile by it's filename.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

OK

application/json

filenamestringOptional

Template XML file name for phone provisioning.

ringtonesstring[]Optional

A collection of ringtones.

queue_ringtonesstring[]Optional

A collection of queue ringtones.

external_ringtonestring[]Optional

A collection of external ringtones.

date_formatsstring[]Optional

A collection of date formats.

time_formatsstring[]Optional

A collection of time formats.

powerledsstring[]Optional

A collection of time power leds.

backlightsstring[]Optional

A collection of time backlights.

screensaversstring[]Optional

A collection of screensavers.

time_zonesstring[]Optional

A collection of time zones.

codecsstring[]Optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

4XX

Error

get/phone_models/{filename}

HTTPcURLJavaScriptPython

GET /api/phone_models/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": "text",
  "languages": [
    "ENGLISH"
  ],
  "ringtones": [
    "text"
  ],
  "queue_ringtones": [
    "text"
  ],
  "external_ringtone": [
    "text"
  ],
  "date_formats": [
    "text"
  ],
  "time_formats": [
    "text"
  ],
  "powerleds": [
    "text"
  ],
  "backlights": [
    "text"
  ],
  "screensavers": [
    "text"
  ],
  "time_zones": [
    "text"
  ],
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1
}