Dect phones

PreviousDect phone models NextDestroy

Was this helpful?

List DECT phones

get

/dect_phones

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/dect_phones' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Create a DECT phone

Create a DECT phone.

post

/dect_phones

Authorizations

Body

namestring · min: 1 · max: 64required

The name of DECT phone.

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_passwordstring

The user password.

engineer_passwordstring

The engineer password.

timezonestringrequired

The timezone of phone.

regionstring

The country or region name of phone.

tonestringrequired

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

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.

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

handset_languagestring · enum

The handset language.

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

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:

Options: WEB_DOMAIN, PUBLIC_IPV4, PUBLIC_IPV6, PRIVATE_IPV4, PRIVATE_IPV6, SBC_DOMAIN

preferred_transportstring · enumrequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

codecsstring[]required

macall ofrequired

MAC address of this IP phone.

MAC address.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/dect_phones' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "template": "text",
    "vendor": "text",
    "model": "text",
    "password": "text",
    "user_password": "text",
    "engineer_password": "text",
    "timezone": "text",
    "region": "text",
    "tone": "text",
    "rps": true,
    "https": true,
    "language": "ENGLISH",
    "handset_language": "ENGLISH",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ],
    "mac": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve DECT Phone's detailed information.

Retrieve DECT phone's detailed information.

get

/dect_phones/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of DECT phone.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/dect_phones/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

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

Update DECT phone

Update a DECT phone.

post

/dect_phones/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of DECT phone.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of DECT phone.

passwordstring

user_passwordstring

The user password.

engineer_passwordstring

The engineer password.

timezonestring

The timezone of phone.

regionstring

The country or region name of phone.

tonestring

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

languagestring · enum

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

handset_languagestring · enum

The handset language.

Options: ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, BULGARIAN

interfacestring · enum

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

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

Options: WEB_DOMAIN, PUBLIC_IPV4, PUBLIC_IPV6, PRIVATE_IPV4, PRIVATE_IPV6, SBC_DOMAIN

preferred_transportstring · enum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

codecsstring[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/dect_phones/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "password": "text",
    "user_password": "text",
    "engineer_password": "text",
    "timezone": "text",
    "region": "text",
    "tone": "text",
    "rps": true,
    "https": true,
    "language": "ENGLISH",
    "handset_language": "ENGLISH",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ]
  }'

200

4XX

No body