Contact Directories on ~.UcClient.~ Unified Communications

Contacts

Mon, 01 Jan 0001 00:00:00 +0000

Contact Management #

Each directory configured on the system has its own permissions and custom fields which can be tailored for specific uses. Each directory also has a set of fixed fields (like telephone numbers and name) which are used within the system for specific purposes.

Settings #

Property	Description
Name	A friendly name to the directory will be know by within clients.
Description	A more detailed name which is only visible on the directories configuration area.
Source Type	Settings to define whether the contacts will be manually added or imported from a file.
Global access to all users	Controls who has access to directory contacts.
Allow users to add, edit & remove contacts	Controls who has access to manage contacts.

Access Permissions #

If the 'Global access to all users' setting is disabled, access to the directory can be granted on a user-by-user basis from the 'Users' tab.

Imports

Mon, 01 Jan 0001 00:00:00 +0000

Importing Contact Data #

The easiest and quickest way to populate a directory is to import that data using a CSV file.

Format #

Any CSV file needs to have the contact fields in the correct order for the import to be successful. The field order required for the CSV is displayed on the 'Import' form:

'Title,Full Name,Company Name,Job Title,Telephone 1,Telephone 2,Telephone 3,Telephone 4,Email,CRM ID,Field 1,Field 2,Field 3,Field 4,Field 5,Field 6,Field 7,Field 8,Field 9,Field 10'

Routing

Mon, 01 Jan 0001 00:00:00 +0000

Routing Contacts #

~.Dimensions.~ provides a contact directory webhook lookup which can be used as part of the communication platform's routing strategy to bypass the normal routing and send a call to a contact specific destination.

URL Parameters #

Parameters	Description	~.pbx.kazoo.name.~	3CX
tenantID	The unique id for your customer instance. In the portal, click on your user icon and select 'Diagnostic Info' to view your tenantId.	✔	✔
directoryId	The unique id for the directory to search. In the settings area, edit the directory you wish to search, the directory's id can be copied from the browser's URL.	✔	✔
fieldName	The name of the field that is populated with the routing destination for the call. See the table below for possible values.	✔	✔
cli	The phone number of the incoming call. All the directory's phone number fields will be searched (phone1, phone2, phone3 & phone4)	n/a	✔

URLs Replace the webhook URL with the correct one for your region.