CC Agent configuration
Recording
Recording can be paused or started by an agent.
Recording On |
Recording Paused |
---|---|
![]() |
![]() |
This feature can be disabled by changing showRecordingControls
option in file application.conf
.
You can also set the environnment variable SHOW_RECORDING_CONTROLS
to false for your xucmgt container in /etc/docker/compose/custom.env
file. When disabled the recording status is not displayed any more
Activity (Queue) control
By using the showQueueControls
option in application.conf, you may allow an agent to enter or leave an activity.
You can also use SHOW_QUEUE_CONTROLS
environment variable in /etc/docker/compose/custom.env
file.

Activity’s Failed Destination Configuration
An agent can see and change the sound file played to the caller when the Activity is temporarily closed [1].
For this to work the XiVO Administrator needs to:
1. Import sound files in the XiVO PBX
To see the sound files, a XiVO Administrator must import them with the queue name prefix as described below:
Given the queue Sales with its Name being
sales
,Given I want to have two messages available for this queue:
closed_during_afternoon
(‘We are closed this afternoon …’)in_a_meeting
(‘Currently in a meeting …’)
Then, as a XiVO Administrator I MUST import these sound files with the prefix
sales_
. For each file, do:Go to
Click to Add a file
File name: select the file on your disk
Directory: select playback directory (this is mandatory)
When file is added, edit it and prefix the file name with the queue name followed by an underscore, in our exampe
sales_
Said differently the agent will be able to see and set all sound files prefixed with the queue name.
2. Configure the default queue for dissuasion in the XiVO PBX
You can configure a default queue for dissuasion by setting the queue name in defaultQueueDissuasion
in application.conf.
This option once set, will show the queue in the dissuasion dropdown.
You can also use QUEUEDISSUASION_DEFAULT_QUEUE
environment variable in /etc/docker/xivo/custom.env
file on the XiVO PBX and restart the services with xivo-dcomp up -d
.
3. Give the rights to the XiVO User
To see/change the dissuasion destination via the CC Agent or CC Manager, a XiVO User must have a supervisor right with Update dissuasion access. To do this a XiVO Administrator must connect to the configmgt (https://XIVO_IP/configmgt) and configure the user with:
Profile: Supervisor
Access: check the box Update dissuasions
Queues: select the queues the user can see
See Profile Management.
On hold notification
You can configure notifyOnHold
(in seconds)) in application.conf, this option once set, will trigger a popup and a system notification to user if he has a call on hold for a long time.
You can also use NOTIFY_ON_HOLD
environment variable in /etc/docker/compose/custom.env
file.
Pause Cause and Status
You can configure XiVO to have the following scenario:
The agent person leaves temporarily his office (lunch, break, …)
He sets his presence in the CCAgent to the according state
The agent will be automatically set in pause and his phone will not ring from queues
He comes back to his office and set his presence to ‘Available’
The pause will be automatically cancelled

By default the pause action from the agent cannot be specified with a specific cause such as Lunch Time, or Tea Time. To be able to use a specific cause, you will have to define new Presences in the cti server configuration.

You must define pause status with action Activate pause to all queue to true, to be able to pause agent on all the queues he is working on.
Note
Optional You can edit ready presence defined with an action Disable pause to all queue to fallback to be available whenever the agent reconnects back to CCAgent. (for example, you closed the webpage, or did a F5 refresh). Once you reconnect you will be put in ready state.
By default, if you don’t add option to ready state, you will reconnect with last presence state known.
When this presences are defined, you must restart the xuc server to be able to use them in ccagent, these presences will also be automatically available in CCmanager and new real time counters will be calculated.
Presence from ready to pause |
Presence from pause to ready |
---|---|
![]() |
![]() |
Note
Presence color are not taken into account in the CC Agent (or CC Manager) application. They all will be displayed in Red.
Screen Popup
This section has been moved to configuration
Run executable
This section has been moved to configuration
Login or Pause management using function keys
You can configure Login or Pause keys on an agent phone. Their state will be synchronized with the state in XiVO CC applications.
Behavior
Login Key:
change status of agent: login if it was logged out, and logout if it was logged in
LED of phone key will be updated accordingly as well as the status in XiVO CC applications (CCAgent…)
if you login/logout via XiVO CC applications (CCAgent…), status will be updated and phone key LED will be updated.
Pause key:
change status of agent: pause if it was ready, ready if it was paused or in wrapup
LED of phone key will be updated accordingly as well as the status in XiVO CC applications (CCAgent…)
if you pause/unpause via XiVO CC applications (CCAgent…), status will be updated and phone key LED will be updated
Wrapup: if agent is on wrapup, the phone key will blink. If you press key while on wrapup, agent status will be changed to ready
Note
The key blinks on Snom and Yealink phone sets. It doesn’t blink on Polycom phone sets.
To be able to terminate Wrapup via the key on Snom phones you must use correct version of plugin (see devices releasenotes).
Configuration
There are two types of customizable function keys that can be used
Login: it will toggle login/logout of agent. There are two configuration patterns (see also below):
either
***30<PHONE NUMBER>
: in this case it will ask for agent number and will then login the given agent on phone<PHONE NUMBER>
or
***30<PHONE NUMBER>*<AGENT NUMBER>
: in this case it will log agent<AGENT NUMBER>
on phone<PHONE NUMBER>
Pause: it will toggle pause/unpause of agent (and will blink if agent is on Wrapup). Configuration pattern (see also below):
***34<PHONE NUMBER>
: it will toggle pause/unpause of agent logged on phone<PHONE NUMBER>
To use it you must:
On on XiVO PBX edit
/etc/xivo-xuc.conf
and change variables:XUC_SERVER_IP
to IP address of XivoCCXUC_SERVER_PORT
to port of XUC Server (default is 8090)
On XiVO CC (XuC) check that the XiVO PBX IP is in the list of host allowed to use the Deprecated APIs (see
DEPRECATED_API_HOST
)Configure function key on user (example with user 1000, 1001 and agent 8000 associated to user 1000):
Open
Edit the user, open Func Keys tab and add keys like:
For Pause/Unpause agent logged on phone 1000 set:
Type:
Customized
,Destination:
***341000
,Label:
Pause
,Supervision:
Enabled
For Login/Logout agent on phone 1000 set:
Type:
Customized
,Destination:
***301000
,Label:
Login
,Supervision:
Enabled
For Login/Logout agent 8000 on phone 1001 set:
Type:
Customized
,Destination:
***301001*8000
,Label:
LoginOn1001
,Supervision:
Enabled

Listened advertisement using function keys
You can configure a Listened key on agent phone to warn him when his conversation is listened by a supervisor.
Behavior
Listen key:
LED of phone key will be lit if supervisor starts to listen to agent’s conversation (see Agents actions)
Configuration
To configure add a customizable function key:
Listened: the phone key will be lit when the agent’s conversation is listened to by the supervisor. Configuration pattern (see also below):
***35<PHONE NUMBER>
: it will toggle listened status for agent loged on phone<PHONE NUMBER>
Configure function key on user (example with user 1000):
Open
Edit the user, open Func Keys tab and add keys like:
For Pause/Unpause agent logged on phone 1000 set:
Type:
Customized
,Destination:
***351000
,Label:
Listened
,Supervision:
Enabled
Activate option for xucserver: see Warn agent when spied section.