Command URIs

Overview

Cloud Softphone allows showing contents loaded from the web (one typical example is a custom tab which shows an embedded browser open with URL which you can specify). It is sometimes useful to pass some information from this embedded browser back to the app. This can be achieved by command URIs described below.

These URIs can be invoked from javascript as a reaction to some events, or simple links or buttons with these URLs can be created and the action will be performed when the user clicks on them.

URIs

The call URIs have the following format:

scheme:command?parameters
scheme
The default scheme for Cloud Softphone is cscommand.

Note

For Cloud Softphone White-Label apps, you can configure any scheme you want in Cloud Softphone portal.

command
The action to be performed.
parameters
These are command-specific and will be described below for each command.

Commands:

balance-update

Will generate an immediate balance check. This is useful when the user tops up inside the web browser and the balance should be updated as soon as possible.

The balance checking web service is documented in Balance Checker article.

Parameters
none
Example:
cscommand:balance-update

provisioning-update

Will trigger immediate re-provisioning. This is useful when user does some changes in his account settings and the new settings should be synced with the app as soon as possible.
Parameters
none
Example:
cscommand:provisioning-update