Variables reference

Data types

  • The boolean type is represented by the empty string for FALSE and “1” for TRUE
  • The integer type is the zero or any positive integer
  • The string type is for any other string

Indexed variables

Some variables are marked as indexed. That means their scope actual name ends with a _N suffix, where N is an integer.

For instance the account_username variable is an indexed variable, so in the scope it becomes account_username_1 or account_username_2 etc.

Read only access

Some variables are marked as read-only. Tancredi does not enforce any access control: it only means that those variables are not designed to be modified by the administrative API.

Variables list

account_always_fwd_target

Read-only access

Indexed by account

Unconditionally forward incoming calls to the given extension. Set to empty string to disable.

string

account_busy_fwd_target

Read-only access

Indexed by account

If busy, forward incoming calls to the given extension. Set to empty string to disable.

string

account_call_waiting

Read-only access

Indexed by account

Account call waiting

string

account_cftimeout

Read-only access

Indexed by account

Timeout for the account call forward

integer

account_display_name

Indexed by account

SIP line and account label for the phone UI

string

account_dnd_allow

Indexed by account

Grant the phone user to change DnD status.

boolean

account_dnd_enable

Read-only access

Indexed by account

Do not disturb switch.

boolean

account_dtmf_type

Indexed by account

Type of DTMF transport.

string - one of inband, rfc4733, sip_info

account_encryption

Indexed by account

If true, use SIPS and RTP encryption.

boolean

account_extension

Indexed by account

The extension number of the account.

string

account_fwd_allow

Indexed by account

Grant the phone user to change the call forward setting.

boolean

account_password

Indexed by account

SIP password.

string

account_timeout_fwd_target

Read-only access

Indexed by account

If not answered, forward incoming calls to the given extension. Set to empty string to disable.

string

account_username

Indexed by account

SIP user name.

string

account_voicemail

Indexed by account

Voicemail function/service code.

string

adminpw

Phone and web UI admin password.

string

background_file

Name of a file under the backgrounds/ directory, e.g. mywallpaper.png. If the file does not exist an empty string is forcibly returned.

string - must match the regexp `[a-z0-9A-Z_-.]+

backlight_time

Seconds before the phone backlight goes off.

integer - 0 = never goes off, N > 0 is the number of seconds to wait among the allowed values: 3, 5, 7, 10, 15, 30, 60, 120, 300, 600, 1200 ,1800, 2400, 3000, 3600.

brightness

Set a custom brightness for phone display.

integer - range 0-9

call_waiting_off

Function/service code to disable the call waiting tone.

string

call_waiting_on

Function/service code to enable the call waiting tone.

string

call_waiting_tone

Emit a tone when a call is waiting.

boolean

cap_background_file

Read-only access

Capability to use a custom background. boolean

boolean

cap_backlight_time_blacklist

Read-only access

Comma separated list of backlight_time values not supported by the phone

string - one of: 0, 3, 5, 7, 10, 15, 30, 60, 120, 300, 600, 1200 ,1800, 2400, 3000, 3600

cap_brightness

Read-only access

Capability to set a custom brightness.

boolean

cap_contrast

Read-only access

Capability to change display contrast.

boolean

cap_date_format_blacklist

Read-only access

List of valid date_format values not supported by the phone. Must be a comma separated list of values among those allowed for date_format.

string

cap_dss_transfer_blacklist

Read-only access

Comma separate list of dss_transfer modes that are not supported by the phone.

string

cap_expkey_count

Read-only access

Number of expansion keys available in a single expansion module.

integer

cap_expkey_type_blacklist

Read-only access

Comma separated list of expkey_type values, not allowed by the phone.

string

cap_expmodule_count

Read-only access

Number of pluggable expansion modules.

integer

cap_ldap_tls_blacklist

Read-only access

List of valid ldap_tls values that are not supported by the phone LDAP client library.

string

cap_linekey_count

Read-only access

Number of line keys available in the phone.

integer

cap_linekey_type_blacklist

Read-only access

Comma separated list of linekey_type values, not allowed by the phone.

string

cap_ringtone_blacklist

Read-only access

Comma separated list of ringtone identifiers not supported by the phone. E.g. -1 (custom ringtone)

string

cap_ringtone_count

Read-only access

Number of ringtones supported by the phone.

integer

cap_screensaver_file

Read-only access

Capability to use a custom screensaver.

boolean

cap_screensaver_time_blacklist

Read-only access

Comma separated list of screensaver_time values not supported by the phone.

string - one of: 0, 3, 5, 7, 10, 15, 30, 60, 120, 300, 600, 1200 ,1800, 2400, 3000, 3600

cap_softkey_count

Read-only access

Number of soft keys available in the phone.

integer

cap_softkey_type_blacklist

Read-only access

Comma separated list of softkey_type values, not allowed by the phone.

string

cfalwaysoff

Function/service code to disable unconditioned call forward.

string

cfalwayson

Function/service code to enable unconditioned call forward.

string

cfbusyoff

Function/service code to disable call forward on busy.

string

cfbusyon

Function/service code to enable call forward on busy.

string

cftimeout

Wait the given number of seconds until the call forward is considered not answered.

integer

cftimeoutoff

Function/service code to disable call forward on busy after timeout.

string

cftimeouton

Function/service code to enable call forward on busy after timeout.

string

contrast

Set a custom contrast for phone display.

integer - range 0-9

date_format

Date display format in the phone UI

string - one of “” (empty string),DD MM YY, DD MM YYYY, DD MMM WW, DD MMM YY, DD MMM YYYY, WWW DD MMM, WWW MMM DD, MM DD YY, MM DD YYYY, MMM DD WW, YY MM DD, YYYY MM DD

dndoff

Function/service code to disable DnD

string

dndon

Function/service code to enable DnD

string

dndtoggle

Function/service code to toggle DnD state. If enabled turn it disabled and vice-versa.

string

dss_transfer

Call transfer mode.

string - one of verify,attended,blind

expkey_label

Indexed by expkey

Expansion label. See the softkey_type description for more information.

string

expkey_type

Indexed by expkey

Expansion key type. See the softkey_type description for more information.

string

expkey_value

Indexed by expkey

Expansion key value. See the softkey_type description for more information.

string

firmware_file

Name of a file under the firmware/ directory, e.g. myrom-1.2.3b.z. If the file does not exist an empty string is forcibly returned.

string - must match the regexp [a-z0-9A-Z_-\.]+

hostname

Host name or IP address of the PBX host.

string - IP/host name

language

Phone UI language. Must be an ISO 639-1 language code (e.g. it, en…)

string

ldap_base

istinguished Name for search base; e.g. dc=phonebook,dc=example,dc=com

string

ldap_mainphone_number_attr

LDAP entry attribute with the contact main phone number.

string

ldap_mobilephone_number_attr

LDAP entry attribute with the contact mobile phone number.

string

ldap_name_attr

LDAP attributes list (space separated) containing the contact name part(s), e.g. cn o

string

ldap_name_display

Template string for displaying the contact name. The string can use %-prefixed placeholders that refer to the selected LDAP entry attributes, e.g. %cn %o

string

ldap_name_filter

LDAP search by name filter. The placeholder % is replaced by the name to search.

``

ldap_number_filter

LDAP search by number filter. The placeholder % is replaced by the number to search.

string

ldap_otherphone_number_attr

LDAP entry attribute with the contact additional phone number.

string

ldap_password

LDAP password if authentication is required.

string

ldap_port

TCP port number of the LDAP phonebook server. Required if different than the usual 389 (ldap) and 636 (ldaps).

integer

ldap_server

Host name or IP address of the LDAP phonebook server.

string - hostname or IP

ldap_tls

Enable and set the TLS method for LDAP connections.

string - one of none,starttls,ldaps

ldap_user

LDAP user name if authentication is required.

string

linekey_label

Indexed by linekey

Line key label string. Some linekey_type may allow to customize the line key label.

string

linekey_type

Indexed by linekey

Line key type/function code. See the Line key types section.

string

linekey_value

Indexed by linekey

Line key value string. The meaning and the fact of being compulsory depends on the linekey_type.

string

mac

Read-only access

The phone MAC address in IEEE 802 notation, e.g. 11-22-33-AA-BB-CC

string

model

Read-only access

The parent scope identifier (model)

string

ntp_server

Host name or IP address of the network time (NTP) server.

string - IP/host name

outbound_proxy2_$line

string

`` - Backup outbound proxy IP/host name

outbound_proxy2port$line

integer

`` - Backup outbound proxy port

outbound_proxy_$line

string

`` - Outbound proxy IP/host name

outbound_proxy_port_$line

integer

`` - Outbound proxy port

pickup_direct

Direct pickup code.

string

pickup_group

Group pickup code.

string

provisioning_complete

Read-only access

The provisioning is considered complete when the phone uses tok2 for authentication. The temporary tok1 token is invalidated.

boolean

provisioning_freq

Set how often the phone requests the provisioning file.

string - one of everyday, never

provisioning_url1

Read-only access

This is a complete provisioning URI, obtained from the scheme, hostname, path, tok2 and filename parts.

string

provisioning_url2

Read-only access

This is a complete provisioning URI, obtained from the scheme, hostname, path, tok1 and filename parts.

string

provisioning_url_filename

URI file name component. It can be empty for some phones, or correspond to the literal phone MAC address, MAC placeholders or whatever.

string

provisioning_url_path

Basic URI path component, that is prefixed to the security token and file name components, e.g. /provisioning/.

string

provisioning_url_scheme

URI scheme to fetch the provisioning resources.

string - one of http, https

queuetoggle

Function/service code

string

ringtone

Ringtone type selector. See also cap_ringtone_count.

integer - 0 == silent, -1 => use ringtone_file, N>0 phone builtin ringtone N

ringtone_file

Name of a file under the ringtones/ directory, e.g. mymusic.wav. If the file does not exist an empty string is forcibly returned.

string - must match the regexp [a-z0-9A-Z_-\.]+

screensaver_file

Name of a file under the screensavers/ directory, e.g. mywallpaper.png. If the file does not exist an empty string is forcibly returned.

string - must match the regexp `[a-z0-9A-Z_-.]+

screensaver_time

Seconds the screen saver starts.

integer - 0 = never starts, N > 0 is the number of seconds to wait among the allowed values: 3, 5, 7, 10, 15, 30, 60, 120, 300, 600, 1200 ,1800, 2400, 3000, 3600.

short_mac

Read-only access

The phone MAC address in hexadecimal notation, e.g. 112233aabbcc

string

sip_tls_port

TCP port number of the PBX host that phones connect to with SIPS protocol.

integer

sip_udp_port

UDP port number of the PBX host that phones connect to with SIP protocol.

integer

softkey_label

Indexed by softkey

Soft key label string. Some softkey_type may allow to customize the soft key label.

string

softkey_type

Indexed by softkey

Soft key type/function code. See the appropriate Soft key types section.

string

softkey_value

Indexed by softkey

Soft key value string. The meaning and the fact of being compulsory depends on the softkey_type.

string

time_format

Time display format in the phone UI

string - one of 12,24

timezone

Local timezone of the phone. - Must be a valid TZ database entry (https://www.iana.org/time-zones). Run timedatectl list-timezones for a list of valid strings.

string

tok1

Read-only access

Temporary authentication token. It is invalidated once tok2 is used for the first time.

string

tok2

Read-only access

Final authentication token. Once it is used, tok1 is invalidated.

string

tonezone

Local tones code for the call state (busy, ringing, off-hook?). Must be an ISO 3166-1 alpha-2 country code (e.g. it, es, gb?)

string

userpw

Phone and web UI user password.

string

vlan_id_pcport

VLAN VID for PC/DATA ethernet port.

integer - empty/0 = disabled, range 1-4095

vlan_id_phone

VLAN VID for phone ethernet port.

integer - empty/0 = disabled, range 1-4095

Line key types

TypeDescriptionValueLabel
[empty string]The line key is not available or not assigned  
blfMonitor the state of an extension and depending on that do a pickup or speed dial when pushedTarget extensionFree text label
conferenceActive calls are joined together in a conference call, where all partecipants can talk and hear the others simultaneouslyN/AN/A
direct_pickupAnswer a ringing call directed to the given extensionThe extension numberFree text label
dndEnable/disable the do not disturb state (DND). If enabled all incoming calls are rejectedN/AN/A
dtmfPlay a DTMF (dial tones) sequenceThe symbols corresponding to the tonesFree text label
forwardEnable/disable the forward state. If enabled all incoming calls are forwarded to the given numberThe phone or extension numberFree text label
group_pickupAnswer a ringing call directed to an extension of your pickup groupN/AN/A
holdPut the current call on holdN/AFree text label, empty for default
ldapDisplay the LDAP address bookN/AFree text label, empty for default
lineSelect another lineN/AFree text label, empty for default
multicast_pagingDirectly speak to an extension configured for multicast pagingThe extension numberFree text label, empty for default
phone_lockLock the phone interface. The unlock code is set elsewhere.N/AFree text label, empty for default
prefixAdd the configured digits to the dialling numberThe prefix digitsFree text label, empty for default
queuetoggleSpeed dial to enter/exit a queue with the function code held by the queuetoggle variableN/AFree text label
recallCall the last dialled numberN/AFree text label, empty for default
recordStart recording the active call audioN/AFree text label, empty for default
speed_dialCall a number pressing the buttonThe number to callFree text label
transferTransfer the active call to the configured number or to a newly dialled numberSet a number for fixed transfer or leave emptyFree text label
urlSend an HTTP GET requestThe URL to be requestedFree text label
voice_mailCall the voice mailbox extensionN/AN/A

Soft key types

TypeDescriptionValueLabel
[empty string]The soft key is not available or not assignedN/AN/A
dndEnable/disable the do not disturb state (DND). If enabled all incoming calls are rejectedN/AN/A
forwardEnable/disable the forward state. If enabled all incoming calls are forwarded to the given numberThe phone or extension numberFree text label
group_pickupAnswer a ringing call directed to an extension of your pickup groupN/AN/A
historyAccess the phone call history screenN/AFree text label, empty for default
ldapDisplay the LDAP address bookN/AFree text label, empty for default
menuAccess the phone settings menuN/AFree text label, empty for default
pick_upAnswer a ringing call directed to the given extensionThe extension numberFree text label
prefixAdd the configured digits to the dialling numberThe prefix digitsFree text label, empty for default
recallCall the last dialled numberN/AFree text label, empty for default
speed_dialCall a number pressing the buttonThe number to callFree text label
statusDisplay the phone status (e.g. registration, firmware…)N/AFree text label, empty for default

Copyright © 2020 Nethesis Srl