# LDAP Configuration on Yealink Phones

When Cloud Voice acts as an LDAP server (Lightweight Directory Access Protocol, the standard way phones and apps look up a shared contact list), your Yealink IP phones can query the contacts stored on the PBX and dial them straight from the handset. This page walks through the phone-side setup using a Yealink SIP-T53W (firmware 93.85.0.5) as the example; other Yealink models follow the same flow, though menu labels may differ slightly.

:::note
Complete [Set up the PBX as an LDAP server](/pbx/administrator-guide/set-up-pbx-as-an-ldap-server/) first. The address, port, credentials, and Base DN you configure below all come from that setup.
:::

## Connect the phone to the LDAP server

The values shown below match the default configuration of the Cloud Voice LDAP server. Treat them as a starting point, then tune the filters and display attributes to fit your directory.

1. Sign in to the Yealink phone's web interface and open **Directory > LDAP**.
2. Enable the **LDAP Enable** switch, then fill in the fields as described in the table.

   
   ![Cloud Voice, LDAP settings on the Yealink phone web interface with the LDAP Enable switch turned on](/images/pbx/cloud-yealink-ldap-settings.png)

   | Setting | What it does | Example |
   | --- | --- | --- |
   | LDAP Label | Name shown for the LDAP phonebook. | `PBX_Contacts` |
   | LDAP Name Filter | Attributes used to match a contact by name. | `(\|(displayName=%)(givenName=%)(sn=%)(mail=%)(company=%))` |
   | LDAP Number Filter | Attributes used to match a contact by number. | `(\|(telephoneNumber=%)(mobile=%)(homePhone=%)(facsimileTelephoneNumber=%))` |
   | LDAP TLS Mode | How the phone secures its connection to the LDAP server. `LDAPS` is LDAP carried over TLS, an encrypted connection. | `LDAPS` |
   | LDAP Server Address | The Cloud Voice LDAP server address from your PBX. | `example.proxy1.voice.example.com` |
   | Port | The LDAP server port. | `15019` |
   | LDAP Username | The account used to sign in to the LDAP server. Find it on the PBX under **Contacts > LDAP Server > LDAP Credentials > LDAP Account Username**. | `cn=5566,ou=users,dc=example,dc=proxy1,dc=voice,dc=example,dc=com` |
   | LDAP Password | The sign-in password, which is the user extension's registration password. | `Regpwd123` |
   | LDAP Base | The **Base DN** (Distinguished Name) from your PBX. It marks the point in the directory tree where each search begins. | `dc=example,dc=proxy1,dc=voice,dc=example,dc=com` |
   | Max Hits (1~1000) | Maximum number of results the server returns per search. | `50` |
   | LDAP Name Attributes | Name attributes returned for each record. Separate multiple values with a space. | `displayName` |
   | LDAP Number Attributes | Number attributes returned for each record. Multiple values are allowed. | `telephoneNumber mobile homePhone` |
   | LDAP Display Name | How the contact's name appears on the phone screen. Must begin with `%`. | `%displayName` |
   | Protocol | LDAP protocol version. Cloud Voice uses Version 3. | `Version 3` |
   | LDAP Lookup for Incoming Call | Search the directory when a call comes in. | `Enabled` |
   | LDAP Lookup for Callout | Search the directory when you place a call. | `Enabled` |
   | LDAP Sorting Results | Sort search results alphabetically and numerically. | `Enabled` |

   :::note
   In the filter fields, `*` matches any character and `%` represents the text you type, used as the prefix of the search condition.
   :::

   :::caution
   The **LDAP Server Address**, **Port**, and **LDAP TLS Mode** must match how the LDAP server is set up on the PBX. If any of them differ, the phone cannot reach the directory and no contacts appear.
   :::

3. Click **Confirm** to save.

Contacts stored on the PBX are now reachable from the phone.

## Look up contacts from the Directory

### Add LDAP to the phone directory

1. In the phone's web interface, open **Directory > Settings**.
2. Under **Directory**, move **LDAP** from the **Disabled** box to the **Enabled** box.

   ![LDAP moved into the Enabled column of the phone's directory settings](/images/pbx/add-ldap-to-directory.png)

3. Optional: under **Search Source List In Dialing**, move **LDAP** from **Disabled** to **Enabled** so the directory is searched while you dial.

   ![LDAP added to the Search Source List In Dialing](/images/pbx/enable-ldap-search-in-dialing.png)

4. Click **Confirm**.

### Search and call

1. On the phone, press **Directory** and open the LDAP phonebook.

   ![LDAP phonebook opened from the phone's Directory menu](/images/pbx/enter-ldap-phonebook.png)

2. Type a name or number on the keypad. Contacts matching your input appear on screen.

   ![Matching PBX contacts listed on the phone screen](/images/pbx/pbx-contacts-on-ip-phone.png)

3. Use the navigation keys to highlight the contact you want.
4. Press **Send** to place the call.

## Look up contacts with an LDAP key

### Assign an LDAP line key

1. In the phone's web interface, open **DssKey > Line Key** (DssKey is Yealink's menu for the phone's programmable keys) and choose a key to configure.
2. Set **Type** to **LDAP**.

   ![Line key Type set to LDAP in the DssKey configuration](/images/pbx/function-ldap-key.png)

3. Click **Confirm**.

### Search and call

1. Press the LDAP key to open the LDAP phonebook.

   ![LDAP phonebook opened by pressing the assigned LDAP line key](/images/pbx/press-ldap-key-on-phone.png)

2. Type a name or number on the keypad. Contacts matching your input appear on screen.

   ![Contact results shown on the phone screen](/images/pbx/pbx-contacts-on-ip-phone.png)

3. Use the navigation keys to highlight the contact you want.
4. Press **Send** to place the call.
