CallerHub
EN
Download

Yealink and Snom: LDAP phone book from Active Directory, SQL and CRM

Desk phones show a name for a call when they find the number in a phone book: locally, in an XML phone book or through an LDAP search. This page explains both ways for network phone books.

What the phone needs

  • LDAP phone book: for a call, the phone searches an LDAP directory for the number. You enter server and port, base DN, user and password (or anonymous), a name filter and a number filter, the display attribute and the lookup for incoming calls. On Yealink the settings are under Directory → LDAP (Yealink documentation), on Snom in the LDAP directory of the phone (Snom documentation).
  • XML phone book (remote phone book): the phone calls an address and receives a list in the vendor’s format. To show names for calls, the remote phone book lookup for incoming calls must be switched on.

If the phone queries Active Directory directly, it searches with the number as it arrives, e.g. 03023125017. If the directory holds “+49 30 23125017” and does not normalise notations, a simple filter finds nothing. Customers from the CRM are usually not in AD anyway.

With CallerHub: one LDAP phone book for all sources

The Phone book module provides a read-only LDAPv3 directory (port 389, with LDAPS 636). When the phone searches for a number, CallerHub queries all active data sources – CRM, SQL, Active Directory, CSV – including the rules, block list and VIP list. The number may be national, with +49 or 0049.

  • Setup: switch on the Phone book module under Administration → Modules, then create the interface Phone book under Interfaces → Add interface.
  • Values per device: the card shows what to enter for each device.
  • Name search on the phone: uses the phone number lists in memory.
Interfaces · Phone book
Phone book card with LDAP phone book, guide per device and export.
Server:             name or IP address of the CallerHub computer, port 389 (636 with LDAPS)
Base DN:            ou=callerhub
Name filter:        (|(cn=%)(sn=%))
Number filter:      (|(telephoneNumber=%)(mobile=%))
Display attribute:  cn          Number attribute: telephoneNumber
Lookup for incoming calls: on

Field names and the placeholder (%, %s or *) differ by vendor and firmware. Under Allowed IP addresses, enter the network of the phones, e.g. 192.168.20.0/24. User and password are optional; without them access is anonymous. LDAPS needs a certificate with a private key; StartTLS is not supported.

Alternative: XML phone book per call

Instead of LDAP, Yealink, Fanvil and Snom phones can also query CallerHub as an XML phone book. Create an interface “XML phone book (Yealink format)” or “(Snom format)” under Interfaces; “Copy instructions” provides the address with the real API key.

  • Yealink / Fanvil: web interface of the phone, Directory → Remote phone book, address http://192.168.10.5:8080/lookup?format=yealink&apikey=API-KEY&number=#SEARCH, name CallerHub; then switch on the name lookup for incoming calls in the remote phone book (name depends on the firmware).
  • Snom: address of the XML phone book http://192.168.10.5:8080/lookup?format=snom&apikey=API-KEY&number=#SEARCH, then switch on the lookup for incoming calls.

Many Yealink phones can be set up via provisioning:

remote_phonebook.data.1.url = http://192.168.10.5:8080/lookup?format=yealink&apikey=API-KEY&number=#SEARCH
remote_phonebook.data.1.name = CallerHub
features.remote_phonebook.enable = 1

The guides for Yealink, Fanvil and Snom are based on published interfaces and have not yet been checked with these phones. Check setting names and placeholders against the documentation of your firmware.

Frequently asked questions

LDAP or XML phone book – which is better?

Both deliver the name for incoming calls. The LDAP phone book is one interface for all devices that support LDAP, including phone systems that include an external directory. The XML phone book is a separate interface per phone model and needs no additional module.

Which edition do I need?

The Phone book module (LDAP and export) is part of the full edition; the 30-day trial (requested in the app) includes it. An XML phone book is a normal interface; the basic edition allows one interface.

Does CallerHub need write access to Active Directory?

No. CallerHub only reads Active Directory as a data source, and its own LDAP phone book rejects write attempts from the phones.

Can the phones also search by name?

Yes. The name search in the phone’s directory uses the phone number lists in memory. Sources in direct-query mode cannot be searched by name.

Try it

Test it with your own data.

Try the full edition for 30 days: choose “Request trial …” in CallerHub and the trial key arrives by e-mail. The setup wizard guides you through data source, phone system and test lookup. After that, CallerHub continues as the free basic edition without losing settings or data.