Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

User

Retrieve user phone details

Retrieve phone details of user.

get/users/{id}/phones/{phone_id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the user.

phone_idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the phone.

Response

OK

idstring

The unique ID of the resource.

macstring

MAC address.

filenamestring

Template XML file name for phone provisioning.

vendorstring

The phone vendor of IP phone.

modelstring

The name of IP phone model.

passwordstring

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'ENGLISH' | 'CHINESE' | 'DUTCH' | 'FRENCH' | 'GERMAN' | 'GREEK' | 'ITALIAN' | 'JAPANESE' | 'POLISH' | 'RUSSIAN' | 'SPANISH' | 'SWEDISH' | 'UKRAINIAN' | 'BULGARIAN'

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.

transfer'BLIND' | 'ATTENDED' | 'NEW_CALL'

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

codecsstring[]

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'WEB_DOMAIN' | 'PUBLIC_IPV4' | 'PUBLIC_IPV6' | 'PRIVATE_IPV4' | 'PRIVATE_IPV6' | 'SBC_DOMAIN'

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

  • WEB_DOMAIN:
  • PUBLIC_IPV4:
  • PUBLIC_IPV6:
  • PRIVATE_IPV4:
  • PRIVATE_IPV6:
  • SBC_DOMAIN:
preferred_transport'UDP' | 'TCP' | 'TLS'

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
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.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}