Auto Provisioning

Manage your phone auto provisioning.

List firmware templates

get

List IP phones template files

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/templates/phones

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "filename": "text",
      "is_custom": true
    }
  ]
}

Create a new firmware template

post

Create a new firmware template into system.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

filenamestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

Responses

201

Created

application/json

4XX

Error

post

/templates/phones

HTTPcURLJavaScriptPython

POST /api/templates/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "filename": "text",
  "content": "text"
}

{
  "filename": "text"
}

Retrieve details of firmware template

get

Retrieve details of template file 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.

contentstringOptional

The file content of the template.

is_custombooleanOptional

Whether it's a customize template.

4XX

Error

get

/templates/phones/{filename}

HTTPcURLJavaScriptPython

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

{
  "filename": "text",
  "content": "text",
  "is_custom": true
}

Update firmware template

post

Update phone template.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Body

application/json

contentstringOptional

The file content of the template.

Responses

200

OK

No content

4XX

Error

post

/templates/phones/{filename}

HTTPcURLJavaScriptPython

POST /api/templates/phones/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "content": "text"
}

No content

Remove an firmware template

post

Remove custom template 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

204

No Content

4XX

Error

post

/templates/phones/{filename}/destroy

HTTPcURLJavaScriptPython

POST /api/templates/phones/{filename}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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
}

List IP phones

get

List IP phones

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/phones

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "extension_number": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "name": "text",
      "password": "text",
      "vm_pin": "text",
      "ip": "text",
      "mac": "text"
    }
  ]
}

Reprovision all phones

post

Re-provision all phones.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

No content

4XX

Error

post

/phones/reprovision

HTTPcURLJavaScriptPython

POST /api/phones/reprovision HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve Phone's detailed information.

get

Retrieve phone's detailed information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

application/json

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

fwverstringOptional

The firmware version of IP phone.

namestring · max: 1024Optional

The display name of user.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

vm_pinstringOptional

The voicemail PIN of the phone.

ipstringOptional

IP address.

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

404

Not Found

get

/phones/{mac}

HTTPcURLJavaScriptPython

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

{
  "extension_number": "text",
  "vendor": "text",
  "model": "text",
  "fwver": "text",
  "name": "text",
  "password": "text",
  "vm_pin": "text",
  "ip": "text",
  "mac": "text"
}

Check phone's assignee

get

Check phone's assignee by MAC.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

application/json

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

404

Not Found

get

/phones/{mac}/assignee

HTTPcURLJavaScriptPython

GET /api/phones/{mac}/assignee HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mac": "text",
  "extension_number": "text",
  "vendor": "text",
  "model": "text"
}

Reprovision a phone

post

Re-provision a phone by it's MAC address.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

4XX

Error

post

/phones/{mac}/reprovision

HTTPcURLJavaScriptPython

POST /api/phones/{mac}/reprovision HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reboot Phone

post

Reboot Phone

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

4XX

Error

post

/phones/{mac}/reboot

HTTPcURLJavaScriptPython

POST /api/phones/{mac}/reboot HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reject a phone

post

Reject a phone from auto provisioning.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

400

Invalid mac address.

post

/phones/{mac}/reject

HTTPcURLJavaScriptPython

POST /api/phones/{mac}/reject HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone models

get

List DECT phone models.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dect_phone_models

HTTPcURLJavaScriptPython

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

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

Retrieve details of DECT phone model

get

Retrieve details of DECT phone model.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Template XML file name for phone provisioning.

Responses

200

OK

application/json

templatestringOptional

Template XML file name for phone provisioning.

tonesstring[]Optional

A collection of ringtones.

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.

linesintegerRead-onlyOptional

The max lines of DECT phone.

4XX

Error

get

/dect_phone_models/{name}

HTTPcURLJavaScriptPython

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

{
  "template": "text",
  "languages": [
    "ENGLISH"
  ],
  "tones": [
    "text"
  ],
  "time_zones": [
    "text"
  ],
  "codecs": [
    "text"
  ],
  "lines": 1
}

List DECT phones

get

List DECT phones

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dect_phones

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "mac": "text",
      "template": "text",
      "vendor": "text",
      "model": "text",
      "password": "text",
      "user_password": "text",
      "engineer_password": "text",
      "timezone": "text",
      "region": "text",
      "language": "ENGLISH",
      "handset_language": "ENGLISH",
      "tone": "text",
      "rps": true,
      "https": true,
      "codecs": [
        "text"
      ],
      "lines": 1,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "url": "text"
    }
  ]
}

Create a DECT phone

post

Create a DECT phone.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestring · min: 1 · max: 64Required

The name of DECT phone.

macall ofRequired

MAC address of this IP phone.

stringOptional

MAC address.

templatestringRequired

Template XML file name for phone provisioning.

vendorstringRequired

The phone vendor of IP phone.

modelstringRequired

The name of IP phone model.

passwordstringRequired

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

timezonestringRequired

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestring · enumRequired

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

handset_languagestring · enumOptional

The handset language.

Possible values:

tonestringRequired

The tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Required

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

interfacestring · enumRequired

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

Possible values:

preferred_transportstring · enumRequired

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Possible values:

Responses

201

Created

application/json

4XX

Error

post

/dect_phones

HTTPcURLJavaScriptPython

POST /api/dect_phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "name": "text",
  "mac": "text",
  "template": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "user_password": "text",
  "engineer_password": "text",
  "timezone": "text",
  "region": "text",
  "language": "ENGLISH",
  "handset_language": "ENGLISH",
  "tone": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve DECT Phone's detailed information.

get

Retrieve DECT phone's detailed information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of DECT phone.

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

templatestringOptional

Template XML file name for phone provisioning.

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

timezonestringOptional

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

handset_languagestring · enumOptional

The handset language.

Possible values:

tonestringOptional

The tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

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

linesintegerRead-onlyOptional

The max lines of DECT phone.

interfacestring · enumOptional

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Possible values:

urlstringOptional

Auto provision server URL.

404

Not Found

get

/dect_phones/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "mac": "text",
  "template": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "user_password": "text",
  "engineer_password": "text",
  "timezone": "text",
  "region": "text",
  "language": "ENGLISH",
  "handset_language": "ENGLISH",
  "tone": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "lines": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "url": "text"
}

Update DECT phone

post

Update a DECT phone.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

namestring · min: 1 · max: 64Optional

The name of DECT phone.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

timezonestringOptional

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

handset_languagestring · enumOptional

The handset language.

Possible values:

tonestringOptional

The tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

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

interfacestring · enumOptional

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Possible values:

Responses

200

OK

No content

4XX

Error

post

/dect_phones/{id}

HTTPcURLJavaScriptPython

POST /api/dect_phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "name": "text",
  "password": "text",
  "user_password": "text",
  "engineer_password": "text",
  "timezone": "text",
  "region": "text",
  "language": "ENGLISH",
  "handset_language": "ENGLISH",
  "tone": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP"
}

No content

Delete a DECT phone

post

Delete a DECT phone by it's ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/dect_phones/{id}/destroy

HTTPcURLJavaScriptPython

POST /api/dect_phones/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone members

get

Retrieve a collection of DECT phone members.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/dect_phones/{id}/members

HTTPcURLJavaScriptPython

GET /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "extension_number": "text",
      "display_name": "text",
      "ipui": "text",
      "handset_index": "text"
    }
  ]
}

Update DECT phone member list

post

Update DECT phone member list.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

Responses

200

OK

No content

4XX

Error

post

/dect_phones/{id}/members

HTTPcURLJavaScriptPython

POST /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "items": [
    {
      "extension_number": "text",
      "ipui": "text",
      "handset_index": "text"
    }
  ]
}

No content

Check DECT phone member

get

Check if extension is in DECT phone member list.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

application/json

idall ofRead-onlyOptional

The unique ID of extension.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberall ofOptional

The extension number of extension.

string · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

display_nameall ofRead-onlyOptional

The display name of extension.

string · max: 1024Optional

The display name of user.

ipuistringOptional

The International Portable User Identity.

handset_indexstringOptional

The handset index.

404

Not Found

get

/dect_phones/{id}/members/{extension_number}

HTTPcURLJavaScriptPython

GET /api/dect_phones/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "extension_number": "text",
  "display_name": "text",
  "ipui": "text",
  "handset_index": "text"
}