Archived Upgrade Notes



The following security vulnerability has been fixed:

  • XIVO-2014-01: Queues and groups permit callers to make unwanted calls


  • Consult the 14.23 Roadmap
  • The “waiting calls / logged agents ratio” queue diversion scenario has been renamed to “number of waiting calls per logged agents”.
  • A new community section was added to the official documentation for all user-contributed documentation.


  • Consult the 14.22 Roadmap
  • The sheet event Dial on queues is now only sent to the ringing agent. The sheet is also sent a little later during the call, when the ringing agent is known.


  • Consult the 14.21 Roadmap
  • The confd REST API is now accessible via HTTPS on port 9486 and via HTTP on port 9487 (localhost only). These ports are replacing the 50051 and 50050 ports respectively. It will still be possible to access the confd REST API via the 50051 and 50050 ports for the next year, but you are advised to update your confd REST API clients as soon as possible.
  • The old (unsupported) ami-proxy is now replaced by an ami-proxy built in xivo-ctid. You must uninstall the old ami-proxy before activating the built-in version. See troubleshooting xivo-ctid to learn how to activate.


  • Consult the 14.20 Roadmap
  • Default parameters for all Cisco SPA ATA plugins have changed to be better suited for european faxes.
  • Following the POODLE attack (CVE-2014-3566), SSL 3.0 has been disabled for the web interface and the xivo-confd REST API.

If you have Aastra phones and are using the remote directory on them, consult the following detailed upgrade notes:



  • Consult the 14.18 Roadmap
  • xivo-fai packages were replaced with xivo-dist : a new tool to handle repositories sources. Upon upgrade, xivo-dist is installed and run and all xivo-fai packages are purged. Consult xivo-dist use cases


  • Consult the 14.17 Roadmap
  • DAHDI configuration file /etc/dahdi/modules is no more created by default and must now be maintained manually. No action is needed upon upgrade but be aware that the upstream sample file is now available in /usr/share/dahdi/modules.sample. See dahdi modules documentation for detailed info.
  • The new CCSS feature will not be enabled upon upgrade, you must explicitly enable it in the IPBX ‣ IPBX Services ‣ Extensions menu.


  • Consult the 14.16 Roadmap
  • See the changelog for xivo-confd’s REST API
  • DAHDI is upgraded to 2.10.0. If the upgrade process asks about /etc/dahdi/modules, we recommend that you keep the old version of the file.
  • Asterisk now inserts CEL and queue log entries via the ODBC asterisk modules instead of the pgsql modules.


  • Consult the 14.15 Roadmap

  • Duplicate function keys will be deleted upon upgrade. If multiple function keys pointing to the same destination are detected for a given user, only the one with the lowest position will be kept. To see the list of deleted function keys, check the xivo-upgrade log file such as:

    grep MIGRATE_FK /var/log/xivo-upgrade.log



  • Consult the 14.13 Roadmap
  • See the changelog for REST API
  • Skills-based routing: for an agent which doesn’t have the skill X, the rule X < 10 was previously evaluated to true, since not having the skill X was equivalent to having it with a value of 0. This behaviour has changed, and the same expression is now evaluated to false. If you are using skills-based routing, you’ll need to check that your rules are still doing what you expect. See skill evaluation for more information.


  • Consult the 14.12 Roadmap
  • All provisioning plugins were modified. Although not mandatory, it is strongly advised to update all used plugins.
  • The function key ‘Activate voicemail’ was removed as it was a duplicate of existing function key ‘Enable voicemail’. All users having the ‘Activate voicemail’ function key will have to be reconfigured with a ‘Enable voicemail’ function key in order to keep the equivalent feature.
  • Log files have changed for the following daemons (previously in /var/log/daemon.log):
    • xivo-provd: /var/log/xivo-provd.log
    • xivo-agid: /var/log/xivo-agid.log
    • xivo-sysconfd: /var/log/xivo-sysconfd.log


  • Consult the 14.11 Roadmap
  • The API URL /lines/<id>/extension is now deprecated. Use /lines/<id>/extensions instead.



  • Consult the 14.09 Roadmap
  • REST API 1.0 is no more. All code, tests and documentation was removed from XiVO. All code developped for REST API 1.0 must now be adapted to use REST API 1.1.


  • Consult the 14.08 Roadmap
  • The xivo database has been merged into the asterisk database. The database schema has also been altered in a way that it might make the upgrade longer than usual.

Please consult the following detailed updated notes for more information:


  • Consult the 14.07 Roadmap
  • Configuration for phones used for the switchboard has changed.

Please consult the following detailed updated notes for more information:



  • Consult the 14.05 Roadmap
  • The CTI Protocol has been updated.
  • The specification of the ‘answered-rate’ queue statistic has changed to exclude calls on a closed queue
  • The switchboard can now choose which incoming call to answer
  • The package versions do not necessarily contain the current XiVO version, it may contain older versions. Only the package xivo is guaranteed to have the current XiVO version.

Please consult the following detailed updated notes for more information:


  • Consult the 14.04 Roadmap
  • Live reload of the configuration can be enabled and disabled using the REST API
  • The generation of call logs for unanswered calls from the XiVO client have been improved.


  • Consult the 14.03 Roadmap
  • A migration script adds an index on the linkedid field in the cel table. Tests have shown that this operation can last up to 11.5 minutes on a XiVO Corporate with 18 millions CELs. xivo-upgrade will thus be slightly longer.
  • Two new daemons are now operationnal, xivo-amid and xivo-call-logd:
    • xivo-amid constantly reads the AMI and sends AMI events to the RabbitMQ bus
    • xivo-call-logd generates call-logs in real time based on AMI LINKEDID_END events read on the bus
  • An increase in load average is expected with the addition of these two new daemons.
  • The cron job calling xivo-call-logs now runs once a day at 4:25 instead of every 5 minutes.


  • Consult the 14.02 Roadmap
  • PHP Web services has been removed from documentation
  • REST API 1.0 Web services has been removed from documentation
  • REST API 1.1 User-Line-Extension service is replaced by User-Line and Line-Extension services


  • Consult the 14.01 Roadmap
  • The following paths have been renamed:
    • /etc/pf-xivo to /etc/xivo
    • /var/lib/pf-xivo to /var/lib/xivo
    • /usr/share/pf-xivo to /usr/share/xivo

You must update any dialplan or configuration file using these paths



  • Consult the 13.25 Roadmap
  • Debian has been upgraded from version 6 (squeeze) to 7 (wheezy).

Please consult the following detailed upgrade notes for more information:


  • Consult the 13.24 Roadmap
  • Default Quality of Service (QoS) settings have been changed for SCCP. The IP packets containing audio media are now marked with the EF DSCP.


  • Consult the 13.23 Roadmap
  • The New call softkey has been removed from SCCP phones in connected state. To start a new call, the user will have to press Hold then New call. This is the same behavior as a Call Manager.
  • Some softkeys have been moved on SCCP phones. We tried to keep the keys in the same position at any given time. As an example, the transfer key will not become End call while transfering a call. Note that this is a work in progress and some models still need some tweaking.


  • Consult the 13.22 Roadmap
  • PostgreSQL will be upgraded from 9.0 to 9.1. The upgrade of XiVO will take longer than usual, depending on the size of the database. Usually, the database grows with the number of calls processed by XiVO. The upgrade will be stopped if not enough space is available on the XiVO server.


  • Consult the 13.21 Roadmap
  • It is no more possible to delete a device associated to a line using REST API.


  • Consult the 13.20 Roadmap
  • xivo-libsccp now supports direct media on wifi phone 7920 and 7921
  • xivo-confd now implements a voicemail list


  • Since XiVO 13.18 was not released, the 13.19 release contains all developments of both 13.18 and 13.19, therefore please consult both Roadmaps :
  • Call logs are now generated automatically, incrementally and regularly. Call logs generated before 13.19 will be erased one last time.
  • The database was highly modified for everything related to devices : table devicefeatures does not exist anymore and now relies on information from xivo-provd.


  • Consult the 13.17 Roadmap
  • There is a major change to call logs. They are no longer available as a web report but only as a csv export. See the call logs documentation. Furthermore, call logs are now fetched from xivo-confd REST API.
  • Paging group numbers are now exclusively numeric. All non-numeric paging group numbers are converted to their numeric-only equivalent while upgrading to XiVO 13.17 ( *58 becomes 58, for example).


  • Consult the 13.16 Roadmap
  • A migration script modifies the user and line related-tables and the way users, lines and extensions are associated. As a consequence of this script, it is not possible any more to associate a user and a line without extensions. Existing associations between users and one or more lines having no extensions will be removed. Users and lines will still exist unassociated.
  • The call logs page is able to display partial results of big queries, instead of displaying a blank page.
  • Two new CEL messages are now enabled : LINKEDID_END and BRIDGE_UPDATE. Those events will only exist in CEL for calls passed after upgrading to XiVO 13.16.
  • The new REST API now makes possible to associate multiple user to a given line and/or extension. There are currently some limitations on how those users and lines can be manipulated using the web interface.


  • There was no production release of XiVO 13.15. All 13.15 developments are included in the official 13.16 release.


  • Consult the 13.14 Roadmap
  • The latest Polycom plugin enables the phone lock feature with a default user password of ‘123’. All Polycom phones used with XiVO also have a default admin password. In order for the phone lock feature to be secure, one should change every phone’s admin AND user passwords.
  • WebServices for SIP trunks/lines: field nat: value yes changed to force_rport,comedia
  • The database has beed updated in order to remove deprecated tables (generalfeatures, extenumbers, extenhash, cost_center).



  • Consult the 13.12 Roadmap
  • CTI protocol: Modified values of agent availability. Read CTI Protocol changelog
  • Clean-up was made related to the minimization of the XiVO Client. Some visual differences have been observed on Mac OS X that do not affect the XiVO Client in a functional way.


  • Consult the 13.11 Roadmap
  • Asterisk has been upgraded from version 11.3.0 to 11.4.0

API changes:

  • Dialplan variable XIVO_INTERFACE_0 is now XIVO_INTERFACE
  • Dialplan variable XIVO_INTERFACE_NB and XIVO_INTERFACE_COUNT have been removed
  • The following fields have been removed from the lines and users web services
    • line_num
    • roles_group
    • rules_order
    • rules_time
    • rules_type


API changes:

  • CTI protocol: for messages of class getlist and function updateconfig, the config object/dictionary does not have a rules_order key anymore.


  • Consult the 13.09 Roadmap
  • The Restart CTI server link has been moved from Services ‣ CTI Server ‣ Control to Services ‣ IPBX ‣ Control.
  • The Agent Status Dashboard has been optimized.
  • The Directory xlet can now be used to place call.


  • Consult the 13.08 Roadmap
  • asterisk has been upgraded from version to 11.3.0, which is a major asterisk upgrade.
  • The switchboard’s queue now requires the xivo_subr_switchboard preprocess subroutine.
  • A fix to bug #4296 introduced functional changes due to the order in which sub-contexts are included. Please refer to ticket for details.

Please consult the following detailed upgrade notes for more information:


  • Consult the 13.07 Roadmap
  • Agent Status Dashboard has more features and less limitations. See related agent status dashboard documentation
  • XiVO call centers have no more notion of ‘disabled agents’. All previously disabled agents in web interface will become active agents after upgrading.
  • asterisk has been upgraded from version to Please note that in XiVO 13.08, asterisk will be upgraded to version 11.
  • DAHDI has been upgraded from version 2.6.1 to 2.6.2.
  • libpri has been upgraded from version 1.4.13 to 1.4.14.
  • PostgreSQL upgraded from version 9.0.4 to 9.0.13


  • Consult the 13.06 Roadmap
  • The new Agent Status Dashboard has a few known limitations. See related dashboard xlet known issues section
  • Status Since counter in xlet list of agents has changed behavior to better reflect states of agents in queues as seen by asterisk. See Ticket #4254 for more details.


  • Consult the 13.05 Roadmap
  • The bug #4228 concerning BS filter only applies to 13.04 servers installed from scratch. Please upgrade to 13.05.
  • The order of softkeys on SCCP phones has changed, e.g. the Bis button is now at the left.


  • Consult the 13.04 Roadmap
  • Upgrade procedure for HA Cluster has changed. Refer to Specific Procedure : Upgrading a Cluster.
  • Configuration of switchboards has changed. Since the directory xlet can now display any column from the lookup source, a display filter has to be configured and assigned to the __switchboard_directory context. Refer to Directory xlet documenttion.
  • There is no more context field directly associated with a call filter. Boss and secretary users associated with a call filter must necessarily be in the same context.



  • Consult the 12.24 Roadmap
  • XiVO 12.24 has some limitations mainly affecting the contact center features due to the rewriting of the code handling agents.

Please consult the following detailed upgrade notes for more information:

Another change is in effect beginning with XiVO 12.24: the field profileclient in the CSV user import sees its values change.

Old value New value
client Client
agent Agent
switchboard Switchboard
agentsup Supervisor
oper removed
clock removed