Screen Pop-ups

Screen pop-ups enable the opening of a web page or running a third-party application on a user’s desktop when receiving or answering an incoming call. Users also have the option to manually open screen pop-ups from the call activity panel.

To activate screen pop-ups, go to your Ringotel admin portal, then navigate to organization → connection → Features → Screen Pop-ups.

Enabling Screen Pop-ups

You have the option to enable screen pop-ups in the following modes:

Open screen pop-up on incoming call: In this mode, screen pop-ups will open on a user’s desktop as soon as an incoming call comes in.
Open screen pop-up after answering an incoming call: In this mode, screen pop-ups will open once a user answers an incoming call on their desktop app.
Manual opening of screen pop-up: Screen pop-ups will not automatically open, but users can open them manually via the call activity panel.
Screen pop-ups are disabled: Select this option to disable the screen pop-up feature.

In the Screen Pop-up/URL path field, enter a web URL or an absolute path to the application executable file which will be launched on an incoming call. E.g. "https://example.com" or "C:\Program Files\MyApp\myapp.exe".

Personalise Links with Variables

In addition, you can use the following placeholders to personalise the screen pop-up links:

$caller$ - caller ID
$caller_name$ - caller name
$number$ - called number (extension)
$called$ - original called number
[sip.Header-Name] - pass any non-RFC3261 SIP header value

Example: https://example.com?to=$number$&called=$called$&calling=$caller$&name=$caller_name$&subj=[sip.X-Subject]

Specifying custom parameters in the webpages or screen pop-up URLs

There are many scenarios in which you might need to open a webpage or screen pop-up URL with specific parameters for a user. To accomplish this, you can incorporate custom parameters into the users' settings and then use them as variables in the Custom webpages or Screen pop-up URLs.

To add a custom parameter to a user’s settings, you can utilize the updateUser API method by including the custom parameters within the custom object. For example:

{
    "method": "updateUser",
    "params": {
        "id": "17097397378921051839",
        "orgid": "17068724888871308748",
        "custom": {
            "id": "1234-5678-9012",
            "key": "qwerwterer234346467"
        }
    }
}

Subsequently, you can utilize these custom user parameters in the Custom webpages or Screen pop-up URLs as follows:

https://example.com?id=$id$&key=$key$

This will open the URL with substituted values:

https://example.com?id=1234-5678-9012&key=qwerwterer234346467