Screen Pop #
To help with integration to third-party applications, ~.UcClient.~ provides a method to screen pop a URL or Executable using details of your current call. The screen pop can be configured to occur automatically based on a call ringing or answered event, or manually using a Keyboard Shortcut.
Screen Pop URL/EXE
This setting should be populated with either a URL which is to be popped, or the path to an executable on the local machine which needs to be run.
When invoked by a call event or keyboard shortcut, ~.UcClient.~ will:
- URL -> Open the URL using the default web browser configured on the computer.
- EXE -> Run the executable
To customise the screen pop, placeholders can be incorporated into the URL or EXE command line parameters which will then be substituted with the corresponding details from the call.
In the example below, a Google search would be loaded with the phone number replacing the {cli} placeholder.
URL Example
https://www.google.com/search?q=phone+number+{cli}
tip
When constructing query string arguments for a URL, remember to URL encode any special characters you are manually adding.
EXE Example
c:\Windows\notepad.exe {cli}
tip
When constructing the command line arguments for an Executable, remember to use " around any parameters that may contain a space.
note
Running an EXE can be blocked by Windows Security or other security applications you have installed. Please refer to Troubleshooting for more information.
The table below outlines all the placeholder values which are supported:
| Placeholders | Description |
|---|---|
| {cli} | The caller id of the current call in national number format |
| {clie164} | The caller id of the current call in E.164 format |
| {ddi} | The DDI of the current call. Incoming external calls only |
| {ddie164} | The DDI of the current call in E.164 format. Incoming external calls only |
| {prefixname} | The prefix name of the current call |
| {groupname} | The group or queue name of the current call if available |
| {crmId} | The crmID field of a directory match1 |
| {title} | The title field of a directory match1 |
| {email} | The email field of a directory match1 |
| {fullName} | The fullName field of a directory match1 |
| {companyName} | The companyName field of a directory match1 |
| {jobTitle} | The jobTitle field of a directory match1 |
| {phone1} | The phone1 field of a directory match1 |
| {phone2} | The phone2 field of a directory match1 |
| {phone3} | The phone3 field of a directory match1 |
| {phone4} | The phone4 field of a directory match1 |
| {field1} | The field1 field of a directory match1 |
| {field2} | The field2 field of a directory match1 |
| {field3} | The field3 field of a directory match1 |
| {field4} | The field4 field of a directory match1 |
| {field5} | The field5 field of a directory match1 |
| {field6} | The field6 field of a directory match1 |
| {field7} | The field7 field of a directory match1 |
| {field8} | The field8 field of a directory match1 |
| {field9} | The field9 field of a directory match1 |
| {field10} | The field10 field of a directory match1 |
Enable Automatic Screen Pop
Enabling this setting turns on automatic popping of the URL. Use the Call State & Call Direction parameters below to control when the automatic pop will occur.
If disabled, the screen pop can still be requested using the dedicated Keyboard Shortcut.
Call State Trigger
If automatic popping is enabled, this setting controls whether the pop occurs when a call starts ringing or a call is answered.
Call Direction
If automatic popping is enabled, this setting controls whether the pop occurs on incoming calls, outgoing calls or both directions.
-
If there are multiple directory contact matches, the details of the first match will be used. If there is no directory match and a directory placeholder has been referenced, the screen pop will not be invoked. ↩︎