Differenze tra le versioni di "KalliopeCTI/en"

Da Kalliope Wiki.
Jump to navigation Jump to search
 
(21 versioni intermedie di 3 utenti non mostrate)
Riga 3: Riga 3:


<br>
<br>
<big>The KalliopeCTI 4 manual for version 4.5.x is available [http://www.kalliopepbx.com/it/download/manualistica?download=90:kalliopecti-4-manuale-utente here].</big>
<big>'''N.B.''': The KalliopeCTI 4 version 4.5.23 manual for the client installation and configuration is available [http://www.kalliopepbx.com/it/download/manualistica?download=90:kalliopecti-4-manuale-utente here].
 
To download the client for your operating system, visit www.kalliope.com, menu Support --> Downloads and then Applications </big>


==Introduction==
==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.
KalliopeCTI 4 (or KCTI 4) is an accessory application of the KalliopePBX V4 VoIP 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.
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.
Riga 16: Riga 18:
{| class="wikitable"
{| class="wikitable"
|-
|-
! <div style = 'text-align: left; color: transparent> - !! '''KCTI 4 Free''' !! <div style = 'text-align: left> '''KCTI 4 Pro''' !! <div style = 'text-align: left> '''KCTI 4 Phone'''
! <div style = 'text-align: left; color: transparent> - !! '''KCTI 4 Free''' !! <div style = 'text-align: left> '''KCTI 4 Pro''' !! <div style = 'text-align: left> '''KCTI 4 Phone'''!! <div style = 'text-align: left> '''KCTI 4 Mobile'''
|-
|-
|colspan="4"| <div style = 'text-align: center; color: transparent> -
|colspan="4"| <div style = 'text-align: center; color: transparent> -
|-
|-
| Extension phonebook||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Extension phonebook||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Shared phonebook||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Shared phonebook||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| CDR||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| CDR||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Click-to-call ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Click-to-call ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Inbound call notification||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Inbound call notification||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Instant messaging|| <div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Instant Messaging|| <div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| CTI presence|| <div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Presence || <div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Automatic actions||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Opening custom URLs||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> -
|-
|-
| Voicemail access||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Voicemail access ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Copy-to-call||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| Copy-to-call||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> -
|-
|-
| Drop-to-call||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>
| Synchronization with Outlook contact||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> -
|-
|-
| BLF||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
| BLF||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Queue statistics||<div style = 'text-align: center'> <sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup>
| Number dialing||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓
|-
|-
| Supervisor panel||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup>
| Blind transfer||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>
|-
|-
| Blind transfer||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Attended transfer||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓  
|-
|-
| Attended transfer||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Do not Disturb||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>  -
|-
|-
| Do Not Disturb||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Call recording||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>  -
|-
|-
| Call recording||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Unconditional forward||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>  -
|-
|-
| Unconditional forward||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Call parking||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>  -
|-
|-
| Call parking||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Call pickup||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'>  -
|-
|-
| Call pickup||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Forking to Mobile||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓ ||<div style = 'text-align: center'> ✓  
|-
|-
| Pickup with invite||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'>
| Queue statistics||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> -
|-
|-
| Fork to Mobile||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓<sup><small>1</small></sup> ||<div style = 'text-align: center'> ✓
| Supervisor mode||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> -
|-
| Selective pause||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> ✓<sup><small>2</small></sup> ||<div style = 'text-align: center'> -
|-
| Touchscreen support||<div style = 'text-align: center'>  - ||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓
|-
| Mobile phonebook integration||<div style = 'text-align: center'>  - ||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> - ||<div style = 'text-align: center'> ✓  
|}
|}


Riga 81: Riga 89:
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.
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 [[AdminGuide:GUI:OperatingMenu:Licenses/en|licenses]] page.  
For instructions on how to activate the KCTI 4 Pro or KCTI 4 Phone licenses, see the [[AdminGuide:BasicConcepts:Licenses/en|licenses]] page.  


'''System requirements''':  
'''System requirements''':  
*Windows 7 or later
 
Windows:
*Windows 8 or later
*Sound card (for KCTI Phone)
*Sound card (for KCTI Phone)
*2 GB of RAM
*2 GB RAM
*100 MB of free disk space
*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.
To install the application on Windows, simply open the executable file and follow the instructions.


==Configuration==
'''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).
When you first open the application, you will see a message prompting you to insert the configuration parameters.


[[File:Notifica.png|450x113px|centro]]
== User Manual==
The KalliopeCTI 4 manual for version 4.5.23 and the installation and configuration of the cient is available [https://www.kalliopepbx.com/it/download/manualistica?download=122:kalliopecti-4-5-15-manuale-utente 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.


You will then be taken to the configuration page. The settings are grouped by category.
{|class="wikitable"
 
! Parameter
[[File:Impostazionicti.png|368x439px|destra|miniatura||Configuraton page]]
! Example Value
 
! Description
 
! Starting from (version KCTI Desktop)
===Application mode===
|-
In this tab you can select which mode to use: KCTI 4 Free, KCTI 4 Pro, or KCTI 4 Phone. You can also choose the language (English, Italian, Spanish).
| <code>echoCanceller</code>
 
| <code>on</code>
===KCTI settings===
| to enable (<code>on</code>) or disable (<code>off</code>) the echo cancel. Default: <code>on</code>
 
| 4.5.23
In this tab you can configure the following settings:
|-
 
| <code>echoCancellerLmsFilter</code>
*KalliopePBX IP address: the IP address of the KalliopePBX the application should connect to
| <code>off</code>
* KCTI username: the name assigned to the user
| To enable (<code>on</code>) or disable(<code>off</code>) the echo caneller LMS filter. Default: <code>off</code>
* KCTI password: the password assigned to the user
| 4.5.23
 
|-
'''N.B.''': The username and password are the same as the credentials on the ''System'' -> ''[[AdminGuide:GUI:OperatingMenu:UsersManagement/en|Users managements]]'' page on KalliopePBX V4.
| <code>echoSuppressor</code>
| <code>on</code>
| To enable (<code>on</code>) or disable (<code>off</code>) the echo suppression. Default: <code>on</code>
| 4.5.23
|-
| <code>suppressorLowerThreshold</code>
| 10
| To set the lower threshold (percentage) of echo suppression. Allowed value range: [0, 100]. Default: 10
| 4.5.23
|-
| <code>suppressorUpperThreshold</code>
| 40
| To set the highest threshold (percentage) of echo suppression. Allowed value range: [0, 100]. Default: 40
| 4.5.23
|-
| <code>suppressorDivider</code>
| 15
| To set the echo suppressor divider. Allowed value range: [2, 50]. Default: 15
| 4.5.23
|-
| <code>suppressorConvergenceMillis</code>
| 4000
| To set the echo suppressor convergence (millis).  dell'echo suppression. Allowed value range: [1000, 120000]. Default: 4000
| 4.5.23
|-
| <code>chatKeepAliveSendIntervalSecs</code>
| 120
| To XMPP ping messages, default 2 minutes
| 4.5.19
|-
| <code>contactsRefreshTimeoutSecs</code>
| 600
| To the contacts refresh, default 10 minutes
| 4.5.18
|-
| <code>cdrRefreshTimeoutSecs</code>
| 90
| To cdr/voicemail refresh, default 1 minutes and 30 seconds
| 4.5.18
|-
| <code>identitiesRefreshTimeoutSecs</code>
| 300
| To identities refresh, default 5 minutes
| 4.5.18
|-
| <code>queueStatsRefreshTimeoutSecs</code>
| 300
| To queue stats refresh, default 5 minutes
| 4.5.18
|-
| <code>codecOrderRefreshTimeoutSecs</code>
| 30
| To codec order refresh, default 30 seconds
| 4.5.18
|-
| <code>excludedOutlookFolders</code>
| <code>Public folders;Cache;Lync;Skype</code>
| list of strings contained in the Outlook folders to be excluded. Including the relative subfolders from contacts imports. As a separetor you can use <code>;</code>
| 4.5.18
|-
| <code>queueNames</code>
| <code>Queue1;Queue2</code>
| list of the queue names to be displayed in the Supervisor panel. As a sepaetor you can use <code>;</code>
| 4.5.15
|}


===KCTI services===
kcti.ini is located in the same directory of the traces (AppData\Roaming\KCTI4 under the user path).
In this tab you can configure the following settings:


*Copy-to-call: enables/disables copy-to-call. When enabled, the user can make a call simply by selecting the string containing the number and copying it to the clipboard (in Windows you can do this with CTRL+C). Once the number has been copied, the application will automatically strip spaces and other special characters (# + , : () . /\) and ask the user for confirmation before making the call.
<span class="underline"> n.b. kcti.ini must be edited manually when Kcti is not running.</span>
*Import Microsoft Outlook contacts: if selected, KCTI will automatically sync with Microsoft Outlook contacts when opened. The imported contacts will appear in the phonebook marked by an icon.
*Open minimized as system icon: if selected, the application will open in minimized mode.
*Enable call reception popup: enables or disabled the call reception popup.
*Pause on all queues upon logout
*Pause on all queues upon answering a call from the queue
*Enable automatic updates: automatically download available KalliopeCTI 4 updates


===Phone integration===
In KCTI 4 Pro mode, you can remotely control a linked phone through native APIs. This feature is currently only available on Snom or Yealink phones.


===Account list===
This tab shows all accounts linked to the user, listing the brands, models, firmware, and MAC addresses of each one. It is up to the user to select which accounts to link to KalliopeCTI.


===Automatic actions===
==API==
[[File:Azioniautom.png|368x550px|destra|miniatura||Automatic actions]]
The client provides the user with APIs to perform actions without the use of the graphic interface.<br>
 
The available actions are:
In this tab you can manage the behavior of the application during inbound calls by configuring actions triggered by the following events:
* To call a number
*Arrival of call: the action will be executed when the phone begins to ring
* To close the current call
*Answering call: the action will be executed when the user answers a call
* To transfer with/without an offert the call in progress
*End of call: the action will be executed when the call is terminated, either by the local user or by the remote one
* To pause/unpause on all queues
 
* To enable/disable DND
For each of these events, you can choose one or more actions of two types:
* Retrieve the data of the active call
*Open a custom URL
For versions 4.5.0 and up a [https://www.postman.com/ Postman] collection is available to test the API of the KalliopeCTI client. You can download it from this link: [http://www.kalliopepbx.com/wiki/it/images/f/fb/KalliopeCTI_Client.postman_collection.zip KalliopeCTI Client (vers.4.5.x) postman collection]
*Execute an external process
È possibile inoltre scaricare in formato pdf un manuale operativo delle API del Kalliope CTI client dal questo [http://www.kalliopepbx.com/wiki/kcti4_client_api_4.5.pdf link].
 
In both cases you can use the following dynamic parameters:
*<callername>: this parameter will be replaced by the name assigned to the caller if present in the  phonebook
*<callernum>: this parameter will be replaced by the number of the caller
*<extenNum>: this parameter will be replaced by the extension number of the local user
*<uid>: this parameter will be replaced by a unique call ID.  
 
The figure to the side shows the automatic event configuration tab. The table on the top part of the tab contains the list of configured actions, showing the type of event ("IN" = arrival of call, "RIS" = answering call, "FIN" = end of call), the action type ("EXE" = execute an external process, "URL" = open a dynamic URL), and the action details.  
 
Once the action has been saved, you can always edit or delete it by selecting it and clicking on Edit action/Delete action. For each action you can indicate whether it must be executed only on calls from external users or on calls between extensions as well, and whether or not it must also be executed on outbound calls.
 
===Softphone settings===
This tab is only available in KCTI 4 Phone mode and lets you select the audio device to use for audio input (microphone), audio output (to listen to the call), and for notifications (audio output for the ringtone and other notifications).
 
== User Manual==
The KalliopeCTI 4 user manual is available in pdf format at this [http://www.kalliopepbx.com/it/download/manualistica?download=90:kalliopecti-4-manuale-utente link].

Versione attuale delle 10:32, 5 set 2022

Altre lingue:


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.kalliope.com, menu Support --> Downloads and then Applications

Introduction

KalliopeCTI 4 (or KCTI 4) is an accessory application of the KalliopePBX V4 VoIP 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.