# LDAP Server Integration Guide

Cloud Voice can connect to a third-party LDAP directory server, such as MetaDirectory. LDAP (Lightweight Directory Access Protocol) is a standard way for phone systems and applications to read contact records from a central directory. Once Cloud Voice and the directory are linked, an inbound call to your PBX (Private Branch Exchange, the phone system that routes your calls) automatically triggers a lookup against the LDAP directory, and the caller's name is shown on the call whenever a matching contact is found.

You can go further and synchronize LDAP contacts into Cloud Voice phonebooks. That lets users dial those contacts directly from the Cloud Voice App, and it lets the system route incoming calls to specific destinations based on which phonebook a caller belongs to.

:::note
The main reason to set this up is caller recognition: instead of seeing only a phone number, staff see the contact's name pulled from your organization's central directory. MetaDirectory is one common LDAP server, but any standard LDAP server works because Cloud Voice reads the directory using the LDAP protocol rather than any single vendor's software.
:::

## Requirements

| Item | Requirement |
| --- | --- |
| Cloud Voice PBX | **Plan**: Enterprise Plan (EP) or Ultimate Plan (UP)<br />**Firmware**: Version 84.18.0.102 or later |
| Third-party LDAP server | No requirement. |

:::caution
LDAP integration is only available on the Enterprise Plan (EP) or Ultimate Plan (UP), and only on firmware 84.18.0.102 or later. If the account is on a lower plan or older firmware, the LDAP settings will not appear and the integration cannot be completed. Confirm the plan and firmware version before you start so you do not get stuck partway through.
:::

The third-party LDAP server has no special requirement: any standard LDAP server can be used.

## Choose your integration path

The LDAP integration supports three capabilities: caller ID name display, contact synchronization, and inbound call routing driven by phonebook matches. The tasks you complete depend on which of these you want to turn on. Pick the scenario below that matches your goal and follow its tasks in the order listed.

:::tip
The scenarios build on each other. Contact synchronization requires the base integration to be in place first, and phonebook-based routing requires synchronization. Start with the first task and add the later ones only if you need those features.
:::

### Caller ID name display

Show the caller's name on inbound calls when a match exists in your LDAP directory.

1. [Integrate Cloud Voice with an LDAP Server](/pbx/integrations/ldap/integrate-cloud-voice-cloud-voice-with-ldap-server/)

### Caller ID name display and contact synchronization

Display caller names and also pull LDAP contacts into Cloud Voice phonebooks so users can call them from the Cloud Voice App.

1. [Integrate Cloud Voice with an LDAP Server](/pbx/integrations/ldap/integrate-cloud-voice-cloud-voice-with-ldap-server/)
2. [Set up Contact Synchronization from an LDAP Server](/pbx/integrations/ldap/set-up-contact-synchronization-from-ldap-server/)

### Caller ID name display, contact synchronization, and inbound call routing by phonebook match

Add everything above, plus route inbound calls to chosen destinations based on which phonebook the caller belongs to.

1. [Integrate Cloud Voice with an LDAP Server](/pbx/integrations/ldap/integrate-cloud-voice-cloud-voice-with-ldap-server/)
2. [Set up Contact Synchronization from an LDAP Server](/pbx/integrations/ldap/set-up-contact-synchronization-from-ldap-server/)
3. Set up inbound routes based on phonebook matches.

:::note
Inbound routing by phonebook match is configured in the PBX inbound route settings, not on the LDAP integration screen. Once contacts are synchronized into a phonebook, you can point an inbound route at a destination based on the caller's phonebook.
:::