UC Client WebPop - Advanced Configuration

UC Client WebPop is an integration that can be used with UC Client Desktop. Please also note the UC Client Link article is located in a separate knowledge base.

When creating a WebPop, administrators have the option to covert to using Advanced Configuration, which converts the functions into lambda code. Please note once converted, the WebPop cannot be reverted to the default URL builder.

Clicking the Advanced Configuration option will present a user interface that allows administrators to write code for the WebPop configuration rather than just entering a URL.

This input box allows one to write code in order to create more advanced processing to determine the URL that Link should pop up. The code written should be Javascript. It will be executed by link when the web pop is processed. It should return a string representing the URL that should be opened.

Function Details

The Javascript function should maintain the default function signature, having a function name of getWebPopUrl and taking one parameter named callObj:

function getWebPopUrl(callObj)

This code should return a string that represents the URL to be opened by Link during the configured call event (incoming call or outgoing call). 

The callObj Parameter

The callObj parameter contains a number of properties that can be accessed using dot notation. 

For example, one can access the phone_number property of the callObj parameter using the following code:

callObj.phone_number

Here is a list of all the properties contained in the callObj parameter:

The customer_id Property

The customer_id property is a special property that is defined when you assign an integration to a domain. This property allows you to create integrations that may need to have a customized identifier specific to each domain.

Example Code

To use an example scenario, let's say a small support team receives calls from both internal users and external customers. 

Using the code below, calls from internal users will pop up a page with the user's profile from the internal company directory, and calls from external users search for the caller in their CRM tool. 

function getWebPopUrl(callObj) {
  if (String(callObj.caller_ID).length === 3) {
    // they use 3 digit extensions so if the length of the caller id is 3, we know
    // it is an internal user calling
    return `https://directory.local/search?extension=${callObj.caller_ID}`;
  } else {
    return `https://bestcrm.com/contacts/search?phone_number=${callObj.caller_ID}`;
  }
}