API : PBX : SIP Phone models list
Introduction
This request will return the list of SIP phone models supported by the platform.
Request
| URL | https://api.telecomx.dk/pbx/sipphonemodels |
| Method | GET |
| Access level | VIEWER, MANAGE, OWNER, RESELLER or ADMIN. |
| Query | offset | [optional] Index of the first item to return, default 0. |
| limit | [optional] The number of items to return, default 50, min 1, max 500. |
| filter | [optional] Search query that will match against brand, model and description. |
| full | [optional] If true, complete sip phone model object will be returned instead of the condensed version. |
Query examples
https://api.telecomx.dk/pbx/sipphonemodels
https://api.telecomx.dk/pbx/sipphonemodels?filter=snom&full=true
Response
| JSON object |
| offset | Index of the first SIP phone model returned. |
| limit | Number of SIP phone models to return. Note that the actual number of returned items may be lower. |
| total | Number of SIP phone models that can be returned when offset and limit is not considered. This is to be used for paging through the data. |
| sipPhoneModels | Array of SIP phone models, see definition below |
| SIP phone model object |
| _id | Id | Unique ID of the model |
| brand | String | Name of brand: SNOM, MITEL, LG, YEALINK, CISCO, GIGASET, GENERIC. |
| brandName | String | Brand name for humans. |
| model | String | Name of the phone/adapter/base model. |
| picture | Id | Id of picture of the device in the GridStore, 200×200 pixels. |
| description | String | A short description of the device model and its capabilities. |
| SIP phone model object if full=true |
| _id | Id | Unique ID of the model |
| brand | String | Name of brand: SNOM, MITEL, LG, YEALINK, CISCO, GIGASET, GENERIC. |
| brandName | String | Brand name for humans. |
| model | String | Name of the phone/adapter/base model. |
| extensions | Number | Number of extensions the phone supports. Normally 1. This controls how many SIP phones can share the same MAC address and thus the same physical unit/base-unit (often used for wireless phone on a DECT base). |
| softkeys | Numbers | Number of softkeys the phone supports. |
| softkeyLabels | Boolean | True if the phone has softkeys that can show text labels. |
| softkeyCapabilities | Array | Array of softkey capabilities the phone supports: SPEEDDIAL, BLF, LINE, DND, ADDRESSBOOK, REDIAL, VOICEMAIL, TRANSFER, URL, HOLD, RECORD, MENU, SAVE, DELETE. |
| picture | Id | Id of picture of the device in the GridStore, 200×200 pixels. |
| description | String | A short description of the device model and its capabilities. |
| configurationTemplate | String | Configuration template for using when generating configuration file for provisioning. The templates can contain a number of variables - see list below. |
| capabilities | Object | Subsection with device capabilities |
| capabilities.provision | Boolean | True if the device can be provisioned. |
| capabilities.macRedirect | Boolean | True if the device model support a redirect service provided by the phone maker and as such must be registered with the makers redirect service. |
| capabilities.customRingtones | Boolean | True if device supports custom ringtones via SIP URL parameter. |
| capabilities.multipleHandsets | Boolean | True if device supports multiple handsets that needs to be configured with each their handset id. |
| capabilities.sipConfigReload | Boolean | True if device supports reload of configuration via SIP NOTIFY message. |
| capabilities.sipReboot | Boolean | True if device supports reboot via SIP NOTIFY message. |
| capabilities.callWaiting | Boolean | True if device supports call waiting. |
| capabilities.audio | Boolean | True if device supports configuration of speaker, microphone and ringer levels. |
| capabilities.headsetButton | Boolean | True if device has a configurable headset button (Mitel). |
| capabilities.dhsg | Boolean | True if device has DHSG feature (Mitel). |
| capabilities.displaySettings | Boolean | True if device supports display settings for brightness and background image. |
| audio | Object | Audio settings |
| audio.mic.min | Number | Min. microphone level. |
| audio.mic.max | Number | Max. microphone level. |
| audio.mic.default | Number | Default microphone level. |
| audio.speaker.min | Number | Min. speaker level. |
| audio.speaker.max | Number | Max. speaker level. |
| audio.speaker.default | Number | Default speaker level. |
| audio.ringer.min | Number | Min. ringer level. |
| audio.ringer.max | Number | Max. ringer level. |
| audio.ringer.default | Number | Default ringer level. |
| audio.ringtone.min | Number | Index of first standard ringtone. |
| audio.ringtone.max | Number | Index of last standard ringtone. |
| audio.ringtone.default | Number | Default ringtone index. |
| sidePanels | Array | Sidepanels selectable for the phone. |
| sidePanels[].name | String | Name of the panel. |
| sidePanels[].keys | Number | Number of keys on the panel. |
| sidePanels[].labels | Boolean | True if panel supports text labels. |
| sidePanelsMax | Number | Maximum number of side panels this phone supports. |
| requiredFirmware | String | Name of the firmware that the phone must be running. |
Note that properties holding no value may be omitted from the object.
Example - normal
{
offset: 0,
limit: 50,
total: 25,
sipPhoneModels: [
{
_id: '123456789012345678901234',
brand: 'SNOM',
brandName: 'Snom',
model: '370',
picture: '1234567890ABCDEF12345678',
description: 'Hardphone with 12 softkeys and greytone LCD screen'
},
{
...
}
]
Example - full=true
{
offset: 0,
limit: 50,
total: 25,
sipPhoneModels: [
{
_id: '123456789012345678901234',
brand: 'Snom',
model: '370',
picture: '1234567890ABCDEF12345678',
description: 'Hardphone with 12 softkeys and greytone LCD screen',
extensions: 1,
softkeys: 12,
softkeyLabels: false,
softkeyCapabilities: ['SPEEDDIAL', 'BLF', 'LINE', 'DND', 'ADDRESSBOOK', 'REDIAL', 'VOICEMAIL', 'TRANSFER', 'URL', 'HOLD', 'RECORD', 'MENU'],
capabilities: {
provision: true,
macRedirect: true,
customRingtones: true,
multipleHandsets: false,
sipConfigReload: true,
sipReboot: true,
callWaiting: true,
audio: true,
headsetButton: true,
dhsg: true,
displaySettings: true
},
audio: {
mic: {
min: 0,
max: 15,
default: 7
},
speaker: {
min: 0,
max: 15,
default: 7
},
ringer: {
min: 0,
max: 15,
default: 7
},
ringtone: {
min: 1,
max: 8,
default: 1
}
},
configurationTemplate: '...not shown here...',
sidePanels: [
{
name: 'E150',
keys: 24,
labels: true
},
{
name: E180',
keys: 48,
labels: true
}
],
sidepanelsMax: 3,
requiredFirmware: 'SIP-4.643'
},
{
...
}
]
Errors
| Error code | Message | Description |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
