Auto Provisioning

Manage your phone auto provisioning.

List firmware templates

get

List IP phones template files

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/templates/phones

GET /api/templates/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a new firmware template

post

Create a new firmware template into system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

filenamestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

Responses

201

Created

application/json

filenamestringOptional

Template XML file name for phone provisioning.

4XX

Error

post/templates/phones

POST /api/templates/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "filename": "example",
  "content": ""
}

{
  "filename": "xxxxxxxx"
}

Retrieve details of firmware template

get

Retrieve details of template file by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

application/json

filenamestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

is_custombooleanOptional

Whether it's a customize template.

4XX

Error

get/templates/phones/{filename}

GET /api/templates/phones/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update firmware template

post

Update phone template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Body

contentstringOptional

The file content of the template.

Responses

200

No content

4XX

Error

post/templates/phones/{filename}

POST /api/templates/phones/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "content": ""
}

No content

Remove an firmware template

post

Remove custom template by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

204

No Content

No content

4XX

Error

post/templates/phones/{filename}/destroy

POST /api/templates/phones/{filename}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List soft phone templates

get

List soft phones template files

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/templates/soft_phone

GET /api/templates/soft_phone HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "file_name": "example",
      "is_custom": true
    }
  ]
}

Create a new soft phone template

post

Create a new soft phone template into system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

file_namestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

Responses

201

Created

application/json

file_namestringOptional

Template XML file name for phone provisioning.

4XX

Error

post/templates/soft_phone

POST /api/templates/soft_phone HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "file_name": "example",
  "content": ""
}

{
  "file_name": "xxxxxxxx"
}

Retrieve details of soft phone template

get

Retrieve details of template file by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

application/json

file_namestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

is_custombooleanOptional

Whether it's a customize template.

4XX

Error

get/templates/soft_phone/{filename}

GET /api/templates/soft_phone/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "file_name": "example",
  "is_custom": true
}

Update soft phone template

post

Update soft phone template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Body

contentstringOptional

The file content of the template.

Responses

200

No content

4XX

Error

post/templates/soft_phone/{filename}

POST /api/templates/soft_phone/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "content": ""
}

No content

Remove an soft phone template

post

Remove custom template by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

204

No Content

No content

4XX

Error

post/templates/soft_phone/{filename}/destroy

POST /api/templates/soft_phone/{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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/phone_models

GET /api/phone_models HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Retrieve profile of firmware template

get

Retrieve phone template profile by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

application/json

filenamestringOptional

Template XML file name for phone provisioning.

languagesstring[]Optional

A collection of language tags.

country_tonesstring[]Optional

A collection of country tones.

ringtonesstring[]Optional

A collection of ringtones.

queue_ringtonesstring[]Optional

A collection of queue ringtones.

external_ringtonestring[]Optional

A collection of external ringtones.

date_formatsstring[]Optional

A collection of date formats.

time_formatsstring[]Optional

A collection of time formats.

powerledsstring[]Optional

A collection of time power leds.

backlightsstring[]Optional

A collection of time backlights.

screensaversstring[]Optional

A collection of screensavers.

time_zonesstring[]Optional

A collection of time zones.

codecsstring[]Optional

The list of currently enabled codec formats.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

4XX

Error

get/phone_models/{filename}

GET /api/phone_models/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": "example",
  "languages": [
    "English",
    "Chinese"
  ],
  "country_tones": [
    "Custom",
    "United States"
  ],
  "ringtones": [
    "Custom",
    "United States"
  ],
  "queue_ringtones": [
    "Custom",
    "United States"
  ],
  "external_ringtone": [
    "Custom",
    "United States"
  ],
  "date_formats": [],
  "time_formats": [],
  "powerleds": [],
  "backlights": [],
  "screensavers": [],
  "time_zones": [
    "GMT-5:00 US Eastern Time, New York"
  ],
  "codecs": [
    "PCMU",
    "PCMA",
    "G729",
    "G722"
  ],
  "enable_lldp": true,
  "enable_vlan_wan_port": true,
  "wan_port_id": 1000,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": true,
  "pc_port_id": 1000,
  "pc_port_priority": 1
}

List IP phones

get

List IP phones

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/phones

GET /api/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "extension_number": "101",
      "vendor": "",
      "model": "",
      "fwver": "",
      "name": "example",
      "password": "",
      "vm_pin": "",
      "ip": "127.0.0.1",
      "mac": "00:1A:2B:3C:4D:5E",
      "status": "OFFLINE"
    }
  ]
}

Reprovision all phones

post

Re-provision all phones.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

No content

4XX

Error

post/phones/reprovision

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

application/json

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

fwverstringOptional

The firmware version of IP phone.

namestring · min: 1 · max: 128Optional

The display name of user.

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

vm_pinstringOptional

The voicemail PIN of the phone.

ipstringOptional

IP address.

macstringOptional

MAC address.

statusstring · enumOptional

The status of phone.
Can be either:

ONLINE: The phone is online.
OFFLINE: The phone is offline.

Possible values:

404

Not Found

get/phones/{mac}

GET /api/phones/{mac} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "101",
  "vendor": "",
  "model": "",
  "fwver": "",
  "name": "example",
  "password": "xxxxxx",
  "vm_pin": "",
  "ip": "127.0.0.1",
  "mac": "00:1A:2B:3C:4D:5E",
  "status": "OFFLINE"
}

Check phone's assignee

get

Check phone's assignee by MAC.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

application/json

macstringOptional

MAC address.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

404

Not Found

get/phones/{mac}/assignee

GET /api/phones/{mac}/assignee HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mac": "00:1A:2B:3C:4D:5E",
  "extension_number": "101",
  "vendor": "",
  "model": ""
}

Reprovision a phone

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

No content

4XX

Error

post/phones/{mac}/reprovision

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

No content

4XX

Error

post/phones/{mac}/reboot

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

No content

400

Invalid mac address.

post/phones/{mac}/reject

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/dect_phone_models

GET /api/dect_phone_models HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "filename": "example",
      "model": "",
      "lines": 50,
      "display_name": "example"
    }
  ]
}

Retrieve details of DECT phone model

get

Retrieve details of DECT phone model.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Template XML file name for phone provisioning.

Responses

200

application/json

templatestringOptional

Template XML file name for phone provisioning.

languagesstring[]Optional

A collection of language tags.

tonesstring[]Optional

A collection of ringtones.

time_zonesstring[]Optional

A collection of time zones.

codecsstring[]Optional

The list of currently enabled codec formats.

linesintegerRead-onlyOptional

The max lines of DECT phone.

4XX

Error

get/dect_phone_models/{name}

GET /api/dect_phone_models/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "template": "",
  "languages": [
    "English",
    "Chinese"
  ],
  "tones": [
    "Custom",
    "United States"
  ],
  "time_zones": [
    "GMT-5:00 US Eastern Time, New York"
  ],
  "codecs": [
    "PCMU",
    "PCMA",
    "G729",
    "G722"
  ],
  "lines": 50
}

List DECT phones

get

List DECT phones

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/dect_phones

GET /api/dect_phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "mac": "00:1A:2B:3C:4D:5E",
      "template": "",
      "vendor": "",
      "model": "",
      "password": "",
      "user_password": "",
      "engineer_password": "",
      "provisioning_pin": "123456",
      "timezone": "",
      "region": "",
      "language": "en-US",
      "handset_language": "en-US",
      "tone": "",
      "rps": false,
      "https": false,
      "codecs": [
        "PCMU",
        "PCMA",
        "G729",
        "G722"
      ],
      "lines": 50,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "url": "https://example.com",
      "firmware": "example",
      "status": [
        {
          "display_name": "abc",
          "extension_number": "101",
          "status": "OFFLINE"
        }
      ]
    }
  ]
}

Create a DECT phone

post

Create a DECT phone.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of DECT phone.

macstringRequired

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

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

provisioning_pinstringOptional

The provisioning PIN for auto-provisioning authentication. This PIN is used to verify the phone during auto-provisioning download. It follows the same validation rules as the extension user's VOICEMAIL PIN. Can be empty, but if verification is enabled and this is empty, authentication will fail.

timezonestringRequired

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestringRequired

Language for strings displayed on Phone Display LCD.

handset_languagestringOptional

The handset language.

tonestringRequired

The country tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Required

The list of currently enabled codec formats.

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

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/dect_phones

POST /api/dect_phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 369

{
  "name": "example",
  "mac": "00:1A:2B:3C:4D:5E",
  "template": "",
  "vendor": "",
  "model": "",
  "password": "",
  "user_password": "",
  "engineer_password": "",
  "provisioning_pin": "123456",
  "timezone": "",
  "region": "",
  "language": "English",
  "handset_language": "English",
  "tone": "",
  "rps": false,
  "https": false,
  "codecs": [
    "PCMU",
    "PCMA",
    "G729",
    "G722"
  ],
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP"
}

{
  "id": "xxxxxxxx"
}

Retrieve DECT Phone's detailed information.

get

Retrieve DECT phone's detailed information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of DECT phone.

macstringOptional

MAC address.

templatestringOptional

Template XML file name for phone provisioning.

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

passwordstringOptional

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

provisioning_pinstringOptional

timezonestringOptional

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestringOptional

Language for strings displayed on Phone Display LCD.

handset_languagestringOptional

The handset language.

tonestringOptional

The country tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

The list of currently enabled codec formats.

linesintegerRead-onlyOptional

The max lines of DECT phone.

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:

urlstringOptional

Auto provision server URL.

firmwarestringOptional

The firmware of phone.

404

Not Found

get/dect_phones/{id}

GET /api/dect_phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "name": "example",
  "mac": "00:1A:2B:3C:4D:5E",
  "template": "",
  "vendor": "",
  "model": "",
  "password": "",
  "user_password": "",
  "engineer_password": "",
  "provisioning_pin": "123456",
  "timezone": "",
  "region": "",
  "language": "en-US",
  "handset_language": "en-US",
  "tone": "",
  "rps": false,
  "https": false,
  "codecs": [
    "PCMU",
    "PCMA",
    "G729",
    "G722"
  ],
  "lines": 50,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "url": "https://example.com",
  "firmware": "example",
  "status": [
    {
      "display_name": "abc",
      "extension_number": "101",
      "status": "OFFLINE"
    }
  ]
}

Update DECT phone

post

Update a DECT phone.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of DECT phone.

passwordstringOptional

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

provisioning_pinstringOptional

timezonestringOptional

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestringOptional

Language for strings displayed on Phone Display LCD.

handset_languagestringOptional

The handset language.

tonestringOptional

The country tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

The list of currently enabled codec formats.

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

No content

4XX

Error

post/dect_phones/{id}

POST /api/dect_phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "name": "example",
  "password": "",
  "user_password": "",
  "engineer_password": "",
  "provisioning_pin": "123456",
  "timezone": "",
  "region": "",
  "language": "en-US",
  "handset_language": "en-US",
  "tone": "",
  "rps": false,
  "https": false,
  "codecs": [
    "PCMU",
    "PCMA",
    "G729",
    "G722"
  ],
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP"
}

No content

Delete a DECT phone

post

Delete a DECT phone by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

4XX

Error

post/dect_phones/{id}/destroy

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

4XX

Error

get/dect_phones/{id}/members

GET /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "xxxxxx",
      "extension_number": "101",
      "display_name": "example",
      "ipui": "",
      "handset_index": ""
    }
  ]
}

Update DECT phone member list

post

Update DECT phone member list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

Responses

200

No content

4XX

Error

post/dect_phones/{id}/members

POST /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "items": [
    {
      "extension_number": "101",
      "ipui": "",
      "handset_index": ""
    }
  ]
}

No content

Check DECT phone member

get

Check if extension is in DECT phone member list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

display_namestring · min: 1 · max: 128Optional

The display name of user.

ipuistringOptional

The International Portable User Identity.

handset_indexstringOptional

The handset index.

404

Not Found

get/dect_phones/{id}/members/{extension_number}

GET /api/dect_phones/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "extension_number": "101",
  "display_name": "example",
  "ipui": "",
  "handset_index": ""
}

PreviousAutomatic Callback

NextPush Notification

Last updated 14 days ago

Was this helpful?