KalliopeCTI
N.B.: The KalliopeCTI 4 version 4.5.23 manual for the client installation and configuration is available here.
To download the client for your operating system, visit www.kalliopbx.com and go to section Download --> Applications
Introduction
KalliopeCTI 4 (or KCTI 4) is an accessory application of the KalliopePBX V4 VoIP PBX that helps you use its services and access information.
KCTI 4 (available in Free, Pro, and Phone modes) is a cross-platform application on Windows, Mac OS X, and Ubuntu. A KCTI 4 Pro or Phone license includes a license for the KCTI Mobile app for Android and iOS.
The KalliopeCTI Mobile user manual can be found here.
The following table lists the features available with each mode.
- |
KCTI 4 Free | KCTI 4 Pro |
KCTI 4 Phone |
KCTI 4 Mobile
|
|---|---|---|---|---|
-
| ||||
| Extension phonebook | ✓ |
✓ |
✓ |
✓
|
| Shared phonebook | ✓ |
✓ |
✓ |
✓
|
| CDR | ✓ |
✓ |
✓ |
✓
|
| Click-to-call | ✓ |
✓ |
✓ |
✓
|
| Inbound call notification | ✓ |
✓ |
✓ |
✓
|
| Instant Messaging | ✓ |
✓ |
✓ |
✓
|
| Presence | ✓ |
✓ |
✓ |
✓
|
| Opening custom URLs | ✓ |
✓ |
✓ |
-
|
| Voicemail access | ✓ |
✓ |
✓ |
✓
|
| Copy-to-call | ✓ |
✓ |
✓ |
-
|
| Synchronization with Outlook contact | - |
✓ |
✓ |
-
|
| BLF | - |
✓ |
✓ |
✓
|
| Number dialing | - |
✓ |
✓ |
✓
|
| Blind transfer | - |
✓2 |
✓ |
✓
|
| Attended transfer | - |
✓2 |
✓ |
✓
|
| Do not Disturb | - |
✓2 |
✓ |
-
|
| Call recording | - |
✓2 |
✓ |
-
|
| Unconditional forward | - |
✓2 |
✓ |
-
|
| Call parking | - |
✓2 |
✓ |
-
|
| Call pickup | - |
✓2 |
✓ |
-
|
| Forking to Mobile | - |
✓2 |
✓ |
✓
|
| Queue statistics | ✓2 |
✓2 |
✓2 |
-
|
| Supervisor mode | ✓2 |
✓2 |
✓2 |
-
|
| Selective pause | ✓2 |
✓2 |
✓2 |
-
|
| Touchscreen support | - |
- |
- |
✓
|
| Mobile phonebook integration | - |
- |
- |
✓
|
1Available only when paired with a Snom or Yealink phone
2Available only when paired with Kalliope Call Center
Download and installation
KCTI 4 can be downloaded for free from the download page of the official KalliopePBX website.
The user can then go to the configuration page to select which version to open each time (as long as the corresponding license has been activated on KalliopePBX V4). KCTI Free, Pro, or Phone are different modes of the same software.
N.B.: Installation does not prompt for any activation keys. Instead, the application will automatically check for the correct license on KalliopePBX every time it is opened.
Unlike KCTI 4 Free, KCTI 4 Pro and Phone require a specific license to be activated on KalliopePBX V4 for each workstation. The KCTI 4 Phone license also includes KCTI 4 Pro. The user can choose their desired mode from the configuration page.
For instructions on how to activate the KCTI 4 Pro or KCTI 4 Phone licenses, see the licenses page.
System requirements:
Windows:
- Windows 8 or later
- Sound card (for KCTI Phone)
- 2 GB RAM
- 100 MB of free disk space
MAC:
- macOS: BigSur (11.0), Catalina (10.15), Mojave (10.14)
- recommended: Apple hardware from 2013 or later
Linux:
- Ubuntu 18.04 or 20.04
To install the application on Windows, simply open the executable file and follow the instructions.
NOTE: In case the SIP service of the central unit is exposed on a different IP from the CTI connection one, or on a different port from the standard one (5060) it is necessary to set on the KalliopePBX one or both of the following custom placeholders inside the Provisioning panel: %%_KPHONE_SIP_REGISTRAR_IP%% and %%_KPHONE_SIP_REGISTRAR_PORT%%% . This configuration is normally necessary when the SIP service is exposed to the public through a Session Border Controller that uses a different IP from the one on which the PBX is reachable, while it is not necessary if the PBX and the SBC are NATed on the same public IP, each one for the ports of its competence (TCP/5039 and TCP/5222 for the CTI and Chat components, towards Kalliope, and SIP + RTP for voice, towards the SBC).
User Manual
The KalliopeCTI 4 manual for version 4.5.23 and the installation and configuration of the cient is available here.
Special parameters of the KalliopeCTI INI file
Starting from 4.5.18 of KalliopeCTI the following parameters can be added or modified in kcti.ini. The following table shows the editable parameters with the version of KalliopeCTI from which the parameter is present and editable.
| Parameter | Example Value | Description | Starting from (version KCTI Desktop) |
|---|---|---|---|
echoCanceller
|
on
|
to enable (on) or disable (off) the echo cancel. Default: on
|
4.5.23 |
echoCancellerLmsFilter
|
off
|
To enable (on) or disable(off) the echo caneller LMS filter. Default: off
|
4.5.23 |
echoSuppressor
|
on
|
To enable (on) or disable (off) the echo suppression. Default: on
|
4.5.23 |
suppressorLowerThreshold
|
10 | To set the lower threshold (percentage) of echo suppression. Allowed value range: [0, 100]. Default: 10 | 4.5.23 |
suppressorUpperThreshold
|
40 | To set the highest threshold (percentage) of echo suppression. Allowed value range: [0, 100]. Default: 40 | 4.5.23 |
suppressorDivider
|
15 | To set the echo suppressor divider. Allowed value range: [2, 50]. Default: 15 | 4.5.23 |
suppressorConvergenceMillis
|
4000 | To set the echo suppressor convergence (millis). dell'echo suppression. Allowed value range: [1000, 120000]. Default: 4000 | 4.5.23 |
chatKeepAliveSendIntervalSecs
|
120 | To XMPP ping messages, default 2 minutes | 4.5.19 |
contactsRefreshTimeoutSecs
|
600 | To the contacts refresh, default 10 minutes | 4.5.18 |
cdrRefreshTimeoutSecs
|
90 | To cdr/voicemail refresh, default 1 minutes and 30 seconds | 4.5.18 |
identitiesRefreshTimeoutSecs
|
300 | To identities refresh, default 5 minutes | 4.5.18 |
queueStatsRefreshTimeoutSecs
|
300 | To queue stats refresh, default 5 minutes | 4.5.18 |
codecOrderRefreshTimeoutSecs
|
30 | To codec order refresh, default 30 seconds | 4.5.18 |
excludedOutlookFolders
|
Public folders;Cache;Lync;Skype
|
list of strings contained in the Outlook folders to be excluded. Including the relative subfolders from contacts imports. As a separetor you can use ;
|
4.5.18 |
queueNames
|
Queue1;Queue2
|
list of the queue names to be displayed in the Supervisor panel. As a sepaetor you can use ;
|
4.5.15 |
kcti.ini is located in the same directory of the traces (AppData\Roaming\KCTI4 under the user path).
n.b. kcti.ini must be edited manually when Kcti is not running.
API
The client provides the user with APIs to perform actions without the use of the graphic interface.
The available actions are:
- To call a number
- To close the current call
- To transfer with/without an offert the call in progress
- To pause/unpause on all queues
- To enable/disable DND
- Retrieve the data of the active call
For versions 4.5.0 and up a Postman collection is available to test the API of the KalliopeCTI client. You can download it from this link: KalliopeCTI Client (vers.4.5.x) postman collection È possibile inoltre scaricare in formato pdf un manuale operativo delle API del Kalliope CTI client dal questo link.