XiVO dird phoned

xivo-dird-phoned is an interface to use directory service with phone. It offers a simple REST interface to authenticate a phone and search result from XiVO dird.

Usage

xivo-dird-phoned is used through HTTP requests, using HTTP and HTTPS. Its default port is 9498 and 9499. As a user, the common operation is to search through directory from a phone. The phone need to send 2 informations:

  • xivo_user_uuid: The XiVO user uuid that the phone is associated. It’s used to search through personal contacts (see personal) and to resolve the user’s labels, which determine the allowed searched directories.

  • profile: The profile that the user is associated. It’s used to format results as configured. It is only required by the profile-based routes (see below).

Search routes

xivo-dird-phoned exposes two search entry points:

  • /directories/lookup_by_label/<vendor>: searches the directories mapped to the labels of the user given by xivo_user_uuid. This route has no profile segment and is the one used by phones provisioned by a recent XiVO (see Searched directories).

  • /directories/lookup/<profile>/<vendor>: the profile-based route, kept so that phones provisioned before the upgrade keep working.

Note

Since most phones dont’t support HTTPS, a small protection is to configure authorized_subnets in Configuration Files or in Services ‣ General settings ‣ Phonebook ‣ Hosts

Launching xivo-dird-phoned

On command line, type xivo-dird-phoned -h to see how to use it.