Auto Provisioning

Manage your phone auto provisioning.

List firmware templates

get

List IP phones template files

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

{
  "items": [
    {
      "filename": "text",
      "is_custom": true
    }
  ]
}

Create a new firmware template

post

Create a new firmware template into system.

Authorizations
Body
filenamestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

Responses
201
Created
application/json
post
POST /api/templates/phones HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "filename": "text",
  "content": "text"
}
{
  "filename": "text"
}

Retrieve details of firmware template

get

Retrieve details of template file by it's filename.

Authorizations
Path parameters
filenamestringRequired

Template XML file name for phone provisioning.

Responses
200
OK
application/json
get
GET /api/templates/phones/{filename} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": "text",
  "content": "text",
  "is_custom": true
}

Update firmware template

post

Update phone template.

Authorizations
Path parameters
filenamestringRequired

Template XML file name for phone provisioning.

Body
contentstringOptional

The file content of the template.

Responses
200
OK
post
POST /api/templates/phones/{filename} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "content": "text"
}
No content

Remove an firmware template

post

Remove custom template by it's filename.

Authorizations
Path parameters
filenamestringRequired

Template XML file name for phone provisioning.

Responses
204
No Content
post
POST /api/templates/phones/{filename}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List phone models

get

List IP phones models.

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

{
  "items": [
    {
      "filename": "text",
      "model": "text",
      "display_name": "text"
    }
  ]
}

Retrieve profile of firmware template

get

Retrieve phone template profile by it's filename.

Authorizations
Path parameters
filenamestringRequired

Template XML file name for phone provisioning.

Responses
200
OK
application/json
get
GET /api/phone_models/{filename} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": "text",
  "languages": [
    "ENGLISH"
  ],
  "ringtones": [
    "text"
  ],
  "queue_ringtones": [
    "text"
  ],
  "external_ringtone": [
    "text"
  ],
  "date_formats": [
    "text"
  ],
  "time_formats": [
    "text"
  ],
  "powerleds": [
    "text"
  ],
  "backlights": [
    "text"
  ],
  "screensavers": [
    "text"
  ],
  "time_zones": [
    "text"
  ],
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1
}

List IP phones

get

List IP phones

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

{
  "items": [
    {
      "extension_number": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "name": "text",
      "password": "text",
      "vm_pin": "text",
      "ip": "text",
      "mac": "text"
    }
  ]
}

Reprovision all phones

post

Re-provision all phones.

Authorizations
Responses
200
OK
post
POST /api/phones/reprovision HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve Phone's detailed information.

get

Retrieve phone's detailed information.

Authorizations
Path parameters
macstringRequired

MAC address.

Responses
200
OK
application/json
get
GET /api/phones/{mac} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "text",
  "vendor": "text",
  "model": "text",
  "fwver": "text",
  "name": "text",
  "password": "text",
  "vm_pin": "text",
  "ip": "text",
  "mac": "text"
}

Check phone's assignee

get

Check phone's assignee by MAC.

Authorizations
Path parameters
macstringRequired

MAC address.

Responses
200
OK
application/json
get
GET /api/phones/{mac}/assignee HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mac": "text",
  "extension_number": "text",
  "vendor": "text",
  "model": "text"
}

Reprovision a phone

post

Re-provision a phone by it's MAC address.

Authorizations
Path parameters
macstringRequired

MAC address.

Responses
200
OK
post
POST /api/phones/{mac}/reprovision HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reboot Phone

post

Reboot Phone

Authorizations
Path parameters
macstringRequired

MAC address.

Responses
200
OK
post
POST /api/phones/{mac}/reboot HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reject a phone

post

Reject a phone from auto provisioning.

Authorizations
Path parameters
macstringRequired

MAC address.

Responses
200
OK
post
POST /api/phones/{mac}/reject HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone models

get

List DECT phone models.

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

{
  "items": [
    {
      "filename": "text",
      "model": "text",
      "lines": 1,
      "display_name": "text"
    }
  ]
}

Retrieve details of DECT phone model

get

Retrieve details of DECT phone model.

Authorizations
Path parameters
namestringRequired

Template XML file name for phone provisioning.

Responses
200
OK
application/json
get
GET /api/dect_phone_models/{name} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "template": "text",
  "languages": [
    "ENGLISH"
  ],
  "tones": [
    "text"
  ],
  "time_zones": [
    "text"
  ],
  "codecs": [
    "text"
  ],
  "lines": 1
}

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

Delete a DECT phone

post

Delete a DECT phone by it's ID.

Authorizations
Path parameters
idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
POST /api/dect_phones/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone members

get

Retrieve a collection of DECT phone members.

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}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "extension_number": "text",
      "display_name": "text",
      "ipui": "text",
      "handset_index": "text"
    }
  ]
}

Update DECT phone member list

post

Update DECT phone member list.

Authorizations
Path parameters
idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
Responses
200
OK
post
POST /api/dect_phones/{id}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "items": [
    {
      "extension_number": "text",
      "ipui": "text",
      "handset_index": "text"
    }
  ]
}
No content

Check DECT phone member

get

Check if extension is in DECT phone member list.

Authorizations
Path parameters
idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Responses
200
OK
application/json
get
GET /api/dect_phones/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "extension_number": "text",
  "display_name": "text",
  "ipui": "text",
  "handset_index": "text"
}
PreviousAutomatic CallbackNextPush Notification