Clarity Connection How To

When a franchisee is connected to Clarity, their inbound calls trigger popups inside Compass notifying them of calls to their extension.

Note that this system relies on knowing the Clarity Extension of the logged in user. This is so that we know whose phone is ringing at the office.

Things needed to set up any zee:

1) Clarity API key and client secret... corporate gets this from Clarity. Clarity claim to have given us one for every zee. William has these scattered across various emails. Ask William if you don't have this.. clarity eventually started giving us one 'master' API key for all zees,but only did this 1/3 of the way into assigning them for franchisees. I've asked them to move everyone to a single master login to make our lives easier.

2) Franchisee owner/admin login for the zee's Clarity Portal (what they access at portala.clarityvoice.com). This is a username, which has the format [extension]@[domain], and a password. Generally this request to the zee should sound something like "To connect your Clarity system to Compass, we need the owner's login to Clarity. This is what you'd use to access portala.clarityvoice.com. Your username will look something like 202@miraclemethod, and your password will be whatever you chose during setup".

If the franchisee doesn't know/doesn't have/can't find this login, we need them to get it from Clarity.

3) The clarity extension for each user.. this information must be entered into the User profile in Compass, in the "Clarity Extension" field. The system needs this so that when extension XXX rings, we can identify which user that extension is for, and know to show a popup saying "your phone is ringing, here is the customer based on searching their phone number"

The API info and Clarity login are entered into the company General Settings page.

Once entered, Compass will periodically attempt to register with Clarity, approx every hour. You can go to Settings>Company Admin>Clarity Voice Connection Status menu item, and see current status. In the 'Clarity Connection?" section, you are looking to see "Yes". 

"Yes" means we have registered with Clarity and things "should" now work. 

Next/final step is to now make an inbound call to someone at that location, and check their Compass pops up with your alert. If it does, setup is complete.

If it does not, refer to William for diagnostic.