POportsip
Auto Provisioning

Create a DECT phone

Create a DECT phone.

post/dect_phones

Request

Request body

namestring required

The name of DECT phone.

macstring required

MAC address.

templatestring required

Template XML file name for phone provisioning.

vendorstring required

The phone vendor of IP phone.

modelstring required

The name of IP phone model.

passwordstring required

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 required

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' required

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 required

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

codecsstring[] required

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

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

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' required

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:

Response

Created

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Changes

No recorded changes to this operation across all 1 revision of this API.