Phones

List current user's IP phones

get

Retrieve a collection of IP Phones for current user.

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": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "mac": "text",
      "filename": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "password": "text",
      "language": "ENGLISH",
      "transfer": "BLIND",
      "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,
      "codecs": [
        "text"
      ],
      "enable_lldp": true,
      "enable_vlan_wan_port": true,
      "wan_port_id": 1,
      "wan_port_priority": 1,
      "enable_vlan_pc_port": true,
      "pc_port_id": 1,
      "pc_port_priority": 1,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "serial_number": "text",
      "door_password1": "text",
      "door_password2": "text",
      "url": "text"
    }
  ]
}

Assign phone to current user

post

Assign a phone to current user.

Authorizations

Body

macall ofrequired

MAC address of this IP phone.

MAC address.

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

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: "BLIND"required

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

timezonestringrequired

The timezone of phone.

ringtonestringoptional

The ringtone of phone.

queue_ringtonestringoptional

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

external_ringtonestringoptional

The ringtone of phone for external calls.

date_formatstringoptional

The date format of phone.

time_formatstringoptional

The time format of phone.

powerledstringoptional

The power led of phone.

backlightstringoptional

The backlight of phone.

screensaverstringoptional

The screensaver of 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.

enable_lldpboolean · default: falseoptional

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: falseoptional

Enable or disable VLAN for WAN Port.

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_portboolean · default: falseoptional

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7optional

VLAN priority for PC Port.

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

serial_numberstringoptional

The serial number of phone.

door_password1string · min: 4 · max: 8optional

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

door_password2string · min: 4 · max: 8optional

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

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 '{
    "mac": "text",
    "filename": "text",
    "vendor": "text",
    "model": "text",
    "password": "text",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "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,
    "codecs": [
      "text"
    ],
    "enable_lldp": true,
    "enable_vlan_wan_port": true,
    "wan_port_id": 1,
    "wan_port_priority": 1,
    "enable_vlan_pc_port": true,
    "pc_port_id": 1,
    "pc_port_priority": 1,
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "serial_number": "text",
    "door_password1": "text",
    "door_password2": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Success

Retrieve current user phone details

get

Retrieve phone details of current user.

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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "mac": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "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,
  "codecs": [
    "text"
  ],
  "enable_lldp": true,
  "enable_vlan_wan_port": true,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": true,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text",
  "url": "text"
}

Update a phone of current user

post

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

Authorizations

Path parameters

idall ofrequired

The unique ID of phone.

The unique ID of the resource.

Body

passwordstringoptional

languagestring · enumoptional

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

transferstring · enum · default: "BLIND"optional

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

timezonestringoptional

The timezone of phone.

ringtonestringoptional

The ringtone of phone.

queue_ringtonestringoptional

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

external_ringtonestringoptional

The ringtone of phone for external calls.

date_formatstringoptional

The date format of phone.

time_formatstringoptional

The time format of phone.

powerledstringoptional

The power led of phone.

backlightstringoptional

The backlight of phone.

screensaverstringoptional

The screensaver of 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.

enable_lldpboolean · default: falseoptional

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean · default: falseoptional

Enable or disable VLAN for WAN Port.

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_portboolean · default: falseoptional

Enable or disable VLAN for PC Port.

pc_port_idinteger · min: 1 · max: 4094optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7optional

VLAN priority for PC Port.

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:

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

preferred_transportstring · enumoptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

serial_numberstringoptional

The serial number of phone.

door_password1string · min: 4 · max: 8optional

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

door_password2string · min: 4 · max: 8optional

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

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",
    "language": "ENGLISH",
    "transfer": "BLIND",
    "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,
    "codecs": [
      "text"
    ],
    "enable_lldp": true,
    "enable_vlan_wan_port": true,
    "wan_port_id": 1,
    "wan_port_priority": 1,
    "enable_vlan_pc_port": true,
    "pc_port_id": 1,
    "pc_port_priority": 1,
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "serial_number": "text",
    "door_password1": "text",
    "door_password2": "text"
  }'

200

4XX

No body

PreviousDestroy NextDestroy

Was this helpful?

List current user's IP phones

Assign phone to current user

Show child attributes

Retrieve current user phone details

Show child attributes

Update a phone of current user

Show child attributes