Dect phones

List DECT phones

get

List DECT phones

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

{
  "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"
    }
  ]
}

OK

Create a DECT phone

post

Create a DECT phone.

Authorizations

Body

namestring · min: 1 · max: 64required

The name of DECT phone.

macall ofrequired

MAC address of this IP phone.

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.

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

handset_languagestring · enumoptional

The handset language.

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

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:

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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",
    "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"
  }'

application/json

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve DECT Phone's detailed information.

get

Retrieve DECT phone's detailed information.

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

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

200

404

200

{
  "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"
}

OK

Update DECT phone

post

Update a DECT phone.

Authorizations

Path parameters

idall ofrequired

The unique ID of DECT phone.

The unique ID of the resource.

Body

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.

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

handset_languagestring · enumoptional

The handset language.

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

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:

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

preferred_transportstring · enumoptional

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

Options: UDP, TCP, TLS

Responses

cURL

JavaScript

Python

HTTP

cURL

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",
    "language": "ENGLISH",
    "handset_language": "ENGLISH",
    "tone": "text",
    "rps": true,
    "https": true,
    "codecs": [
      "text"
    ],
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP"
  }'

application/json

200

4XX

200

No body

OK