Phones

PreviousDestroy NextDestroy

Was this helpful?

List current user's IP phones

Retrieve a collection of IP Phones for current user.

get

/user/phones

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "items": [
    {
      "filename": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "password": "text",
      "timezone": "text",
      "ringtone": "text",
      "queue_ringtone": "text",
      "external_ringtone": "text",
      "date_format": "text",
      "time_format": "text",
      "powerled": "text",
      "backlight": "text",
      "screensaver": "text",
      "rps": true,
      "https": true,
      "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,
      "serial_number": "text",
      "door_password1": "text",
      "door_password2": "text",
      "url": "text",
      "language": "ENGLISH",
      "transfer": "BLIND",
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "codecs": [
        "text"
      ],
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "mac": "text"
    }
  ]
}

Assign phone to current user

Assign a phone to current user.

post

/user/phones

Authorizations

Body

filenamestringrequired

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

timezonestringrequired

The timezone of phone.

ringtonestring

The ringtone of phone.

queue_ringtonestring

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestring

The ringtone of phone for external calls.

date_formatstring

The date format of phone.

time_formatstring

The time format of phone.

powerledstring

The power led of phone.

backlightstring

The backlight of phone.

screensaverstring

The screensaver of phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

enable_lldpboolean · default: false

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: false

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: false

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7

VLAN priority for PC Port.

serial_numberstring

The serial number of phone.

door_password1string · min: 4 · max: 8

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8

The secondary door password of phone. Only numeric sequences are allowed.

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

transferstring · enum · default: BLINDrequired

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Options: BLIND, ATTENDED, NEW_CALL

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

codecsstring[]required

macall ofrequired

MAC address of this IP phone.

MAC address.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/user/phones' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "filename": "text",
    "vendor": "text",
    "model": "text",
    "password": "text",
    "timezone": "text",
    "ringtone": "text",
    "queue_ringtone": "text",
    "external_ringtone": "text",
    "date_format": "text",
    "time_format": "text",
    "powerled": "text",
    "backlight": "text",
    "screensaver": "text",
    "rps": true,
    "https": true,
    "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,
    "serial_number": "text",
    "door_password1": "text",
    "door_password2": "text",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ],
    "mac": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Success

Retrieve current user phone details

Retrieve phone details of current user.

get

/user/phones/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of phone.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "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,
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text",
  "url": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "codecs": [
    "text"
  ],
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "mac": "text"
}

Update a phone of current user

Update phone of current user by it's unique ID.

post

/user/phones/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of phone.

The unique ID of the resource.

Body

passwordstring

timezonestring

The timezone of phone.

ringtonestring

The ringtone of phone.

queue_ringtonestring

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestring

The ringtone of phone for external calls.

date_formatstring

The date format of phone.

time_formatstring

The time format of phone.

powerledstring

The power led of phone.

backlightstring

The backlight of phone.

screensaverstring

The screensaver of phone.

rpsboolean

Send to RPS or not.

httpsboolean

Whether to use https

enable_lldpboolean · default: false

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: false

Enable or disable VLAN for WAN Port.

wan_port_idinteger · min: 1 · max: 4094

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7

VLAN priority for WAN Port.

enable_vlan_pc_portboolean · default: false

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7

VLAN priority for PC Port.

serial_numberstring

The serial number of phone.

door_password1string · min: 4 · max: 8

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8

The secondary door password of phone. Only numeric sequences are allowed.

languagestring · enum

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

transferstring · enum · default: BLIND

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Options: BLIND, ATTENDED, NEW_CALL

interfacestring · 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:

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

preferred_transportstring · enum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

codecsstring[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/user/phones/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "text",
    "timezone": "text",
    "ringtone": "text",
    "queue_ringtone": "text",
    "external_ringtone": "text",
    "date_format": "text",
    "time_format": "text",
    "powerled": "text",
    "backlight": "text",
    "screensaver": "text",
    "rps": true,
    "https": true,
    "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,
    "serial_number": "text",
    "door_password1": "text",
    "door_password2": "text",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "codecs": [
      "text"
    ]
  }'

200

4XX

No body