.. _xivo-directory:

****************
XiVO directories
****************

This type of directory is used to query the users of a XiVO. On a fresh install, the local XiVO is
already configured. The URI field for this type of directory should be the base URL of a
`xivo-confd` server.

This directory type matches the :ref:`dird-backend-xivo` backend in `xivo-dird`.


Available fields
================

* id
* agent_id
* line_id
* firstname
* lastname
* email
* exten
* context
* mobile_phone_number
* userfield
* description
* voicemail_number


Example
=======

Adding a source
---------------

.. figure:: images/xivo_add_directory_xivo.png

   :menuselection:`Configuration --> Management --> Directories`


Configuring source access
-------------------------

Default configuration is set in :menuselection:`Services --> CTI Server --> Directories --> Definitions --> internal`.

.. important:: New in Maia (2024.05), internal update to match the Display Filters evolution.
               The values are unchanged (see available fields above).
               The fieldnames have been updated to match the Display evolution for UC applications (Desktop assistant, Web assistant).

.. figure:: images/xivo_configure_directory_xivo_maia.png

   :menuselection:`Services --> CTI Server --> Directories --> Definitions`