Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Auto Provisioning

Retrieve DECT Phone's detailed information.

Retrieve DECT phone's detailed information.

get/dect_phones/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

Response

OK

idstring

The unique ID of the resource.

namestring

The name of DECT phone.

macstring

MAC address.

templatestring

Template XML file name for phone provisioning.

vendorstring

The phone vendor of IP phone.

modelstring

The name of IP phone model.

passwordstring

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_passwordstring

The user password.

engineer_passwordstring

The engineer password.

timezonestring

The timezone of phone.

regionstring

The country or region name of phone.

language'ENGLISH' | 'CHINESE' | 'DUTCH' | 'FRENCH' | 'GERMAN' | 'GREEK' | 'ITALIAN' | 'JAPANESE' | 'POLISH' | 'RUSSIAN' | 'SPANISH' | 'SWEDISH' | 'UKRAINIAN' | 'BULGARIAN'

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.

handset_language'ENGLISH' | 'CHINESE' | 'DUTCH' | 'FRENCH' | 'GERMAN' | 'GREEK' | 'ITALIAN' | 'JAPANESE' | 'POLISH' | 'RUSSIAN' | 'SPANISH' | 'SWEDISH' | 'UKRAINIAN' | 'BULGARIAN'

The handset language.

tonestring

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

codecsstring[]

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

linesinteger

The max lines of DECT phone.

interface'WEB_DOMAIN' | 'PUBLIC_IPV4' | 'PUBLIC_IPV6' | 'PRIVATE_IPV4' | 'PRIVATE_IPV6' | 'SBC_DOMAIN'

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

  • WEB_DOMAIN:
  • PUBLIC_IPV4:
  • PUBLIC_IPV6:
  • PRIVATE_IPV4:
  • PRIVATE_IPV6:
  • SBC_DOMAIN:
preferred_transport'UDP' | 'TCP' | 'TLS'

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
urlstring

Auto provision server URL.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}