Phones

List user's IP phones

Retrieve a collection of IP Phones.

GEThttp://127.0.0.1:8888/api/users/{id}/phones

Path parameters

id*all of

The unique ID of user.

Response

Body

itemsarray of object

Request

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": {},
      "mac": {},
      "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": false,
      "https": false,
      "codecs": [
        "text"
      ],
      "enable_lldp": false,
      "enable_vlan_wan_port": false,
      "wan_port_id": 0,
      "wan_port_priority": 0,
      "enable_vlan_pc_port": false,
      "pc_port_id": 0,
      "pc_port_priority": 0,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "serial_number": "text",
      "door_password1": "text",
      "door_password2": "text",
      "url": "text"
    }
  ]
}

Assign phone to user

Assign a phone to user.

POSThttp://127.0.0.1:8888/api/users/{id}/phones

Path parameters

id*all of

The unique ID of user.

Body

mac*all of

MAC address of this IP phone.

filename*string

Template XML file name for phone provisioning.

vendor*string

The phone vendor of IP phone.

model*string

The name of IP phone model.

password*string

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

language*enum

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.

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

transfer*enum

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.

BLINDATTENDEDNEW_CALL

timezone*string

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

codecs*array of string

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpboolean

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean

Enable or disable VLAN for WAN Port.

wan_port_idinteger

VLAN ID for WAN PORT.

wan_port_priorityinteger

VLAN priority for WAN Port.

enable_vlan_pc_portboolean

Enable or disable VLAN for PC Port.

pc_port_idinteger

VLAN ID for PC PORT.

pc_port_priorityinteger

VLAN priority for PC Port.

interface*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:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transport*enum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

serial_numberstring

The serial number of phone.

door_password1string

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

door_password2string

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

Response

Success

Body

idall of

The unique ID of phone.

Request

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mac": {},
      "filename": "text",
      "vendor": "text",
      "model": "text",
      "password": "text",
      "language": "ENGLISH",
      "transfer": "BLIND",
      "timezone": "text",
      "codecs": [
        "text"
      ],
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP"
    }),
});
const data = await response.json();

Response

{
  "id": {}
}

Retrieve user phone details

Retrieve phone details of user.

GEThttp://127.0.0.1:8888/api/users/{id}/phones/{phone_id}

Path parameters

id*all of

The unique ID of user.

phone_id*all of

The unique ID of phone.

Response

Body

idall of

The unique ID of phone.

macall of

MAC address of this IP phone.

filenamestring

Template XML file name for phone provisioning.

vendorstring

The phone vendor of IP phone.

modelstring

The name of IP phone model.

passwordstring

languageenum

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

transferenum

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.

BLINDATTENDEDNEW_CALL

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

codecsarray of string

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpboolean

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean

Enable or disable VLAN for WAN Port.

wan_port_idinteger

VLAN ID for WAN PORT.

wan_port_priorityinteger

VLAN priority for WAN Port.

enable_vlan_pc_portboolean

Enable or disable VLAN for PC Port.

pc_port_idinteger

VLAN ID for PC PORT.

pc_port_priorityinteger

VLAN priority for PC Port.

interfaceenum

The interface type for QR code or auto provisioning.
Can be neither:

WEB_DOMAIN:
PUBLIC_IPV4:
PUBLIC_IPV6:
PRIVATE_IPV4:
PRIVATE_IPV6:
SBC_DOMAIN:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

serial_numberstring

The serial number of phone.

door_password1string

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

door_password2string

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

urlstring

Auto provision server URL.

Request

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones/{phone_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {},
  "mac": {},
  "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": false,
  "https": false,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 0,
  "wan_port_priority": 0,
  "enable_vlan_pc_port": false,
  "pc_port_id": 0,
  "pc_port_priority": 0,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text",
  "url": "text"
}

Update a phone of user

Update phone of user by it's unique ID.

POSThttp://127.0.0.1:8888/api/users/{id}/phones/{phone_id}

Path parameters

id*all of

The unique ID of user.

phone_id*all of

The unique ID of phone.

Body

passwordstring

languageenum

ENGLISHCHINESEDUTCHFRENCHGERMANGREEKITALIANJAPANESEPOLISHRUSSIANSPANISHSWEDISHUKRAINIANBULGARIAN

transferenum

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.

BLINDATTENDEDNEW_CALL

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

codecsarray of string

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpboolean

Enable or disable Link Layer Discovery Protocol.

enable_vlan_wan_portboolean

Enable or disable VLAN for WAN Port.

wan_port_idinteger

VLAN ID for WAN PORT.

wan_port_priorityinteger

VLAN priority for WAN Port.

enable_vlan_pc_portboolean

Enable or disable VLAN for PC Port.

pc_port_idinteger

VLAN ID for PC PORT.

pc_port_priorityinteger

VLAN priority for PC Port.

interfaceenum

The interface type for QR code or auto provisioning.
Can be neither:

WEB_DOMAIN:
PUBLIC_IPV4:
PUBLIC_IPV6:
PRIVATE_IPV4:
PRIVATE_IPV6:
SBC_DOMAIN:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

UDPTCPTLS

serial_numberstring

The serial number of phone.

door_password1string

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

door_password2string

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

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones/{phone_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousDestroy NextDestroy

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones/{phone_id}', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "id": {}, "mac": {}, "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": false, "https": false, "codecs": [ "text" ], "enable_lldp": false, "enable_vlan_wan_port": false, "wan_port_id": 0, "wan_port_priority": 0, "enable_vlan_pc_port": false, "pc_port_id": 0, "pc_port_priority": 0, "interface": "WEB_DOMAIN", "preferred_transport": "UDP", "serial_number": "text", "door_password1": "text", "door_password2": "text", "url": "text" }

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/phones', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "mac": {}, "filename": "text", "vendor": "text", "model": "text", "password": "text", "language": "ENGLISH", "transfer": "BLIND", "timezone": "text", "codecs": [ "text" ], "interface": "WEB_DOMAIN", "preferred_transport": "UDP" }), }); const data = await response.json();