Dect phones

List DECT phones

GEThttp://127.0.0.1:8888/api/dect_phones

Response

Body

itemsarray of object

Request

const response = await fetch('http://127.0.0.1:8888/api/dect_phones', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": {},
      "name": "text",
      "mac": {},
      "template": "text",
      "vendor": "text",
      "model": "text",
      "password": "text",
      "timezone": "text",
      "region": "text",
      "language": "ENGLISH",
      "tone": "text",
      "rps": false,
      "https": false,
      "codecs": [
        "text"
      ],
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "url": "text"
    }
  ]
}

Create a DECT phone

Create a DECT phone.

POSThttp://127.0.0.1:8888/api/dect_phones

Body

name*string

The name of DECT phone.

mac*all of

MAC address of this IP phone.

template*string

Template XML file name for phone provisioning.

vendor*string

The phone vendor of IP phone.

model*string

The name of IP phone model.

password*string

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".

timezone*string

The timezone of phone.

regionstring

The country or region name of phone.

language*enum

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.

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

tone*string

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

codecs*array of string

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

interface*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:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transport*enum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

Response

Created

Body

idall of

The unique ID of DECT phone.

Request

const response = await fetch('http://127.0.0.1:8888/api/dect_phones', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "mac": {},
      "template": "text",
      "vendor": "text",
      "model": "text",
      "password": "text",
      "timezone": "text",
      "language": "ENGLISH",
      "tone": "text",
      "codecs": [
        "text"
      ],
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP"
    }),
});
const data = await response.json();

Response

{
  "id": {}
}

Retrieve DECT Phone's detailed information.

Retrieve DECT phone's detailed information.

GEThttp://127.0.0.1:8888/api/dect_phones/{id}

Path parameters

id*all of

The unique ID of DECT phone.

Response

Body

idall of

The unique ID of DECT phone.

namestring

The name of DECT phone.

macall of

MAC address of this IP phone.

templatestring

Template XML file name for phone provisioning.

vendorstring

The phone vendor of IP phone.

modelstring

The name of IP phone model.

passwordstring

timezonestring

The timezone of phone.

regionstring

The country or region name of phone.

languageenum

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

tonestring

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

codecsarray of string

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

linesinteger

The max lines of DECT phone.

interfaceenum

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

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

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

urlstring

Auto provision server URL.

Request

const response = await fetch('http://127.0.0.1:8888/api/dect_phones/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {},
  "name": "text",
  "mac": {},
  "template": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "timezone": "text",
  "region": "text",
  "language": "ENGLISH",
  "tone": "text",
  "rps": false,
  "https": false,
  "codecs": [
    "text"
  ],
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "url": "text"
}

Update DECT phone

Update a DECT phone.

POSThttp://127.0.0.1:8888/api/dect_phones/{id}

Path parameters

id*all of

The unique ID of DECT phone.

Body

namestring

The name of DECT phone.

passwordstring

timezonestring

The timezone of phone.

regionstring

The country or region name of phone.

languageenum

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

tonestring

The tone set of DECT phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

codecsarray of string

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

interfaceenum

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

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

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/dect_phones/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousDect phone models NextDestroy

const response = await fetch('http://127.0.0.1:8888/api/dect_phones', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "mac": {}, "template": "text", "vendor": "text", "model": "text", "password": "text", "timezone": "text", "language": "ENGLISH", "tone": "text", "codecs": [ "text" ], "interface": "WEB_DOMAIN", "preferred_transport": "UDP" }), }); const data = await response.json();

{ "id": {}, "name": "text", "mac": {}, "template": "text", "vendor": "text", "model": "text", "password": "text", "timezone": "text", "region": "text", "language": "ENGLISH", "tone": "text", "rps": false, "https": false, "codecs": [ "text" ], "interface": "WEB_DOMAIN", "preferred_transport": "UDP", "url": "text" }