Dect phones

List DECT phones

get

List DECT phones

Authorizations
Responses
200
OK
application/json
get
GET /api/dect_phones HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

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.

stringOptional

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.

Possible values:
handset_languagestring · enumOptional

The handset language.

Possible values:
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:
Possible values:
preferred_transportstring · enumRequired

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
Possible values:
Responses
201
Created
application/json
post
POST /api/dect_phones HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "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"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve DECT Phone's detailed information.

get

Retrieve DECT phone's detailed information.

Authorizations
Path parameters
idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/dect_phones/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update DECT phone

post

Update a DECT phone.

Authorizations
Path parameters
idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
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.

Possible values:
handset_languagestring · enumOptional

The handset language.

Possible values:
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:
Possible values:
preferred_transportstring · enumOptional

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
Possible values:
Responses
200
OK
post
POST /api/dect_phones/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "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"
}
No content
PreviousDect phone modelsNextDestroy