Visual Support App SDK
Overview
The Visual Support App is a generic application for iOS and Android that runs on the iOS and Android operating systems and is launched from a mobile browser. Once the application has been started you can call a device connected to the SightCall platform.
The user connecting through the Visual Support App can be an external user linked to a premium plus
(or premium plus recording
user) or an authenticated user.
The Visual Support App can be launched using a url in the mobile web page, with parameters that specify all the necessary data.
Launching the app from a mobile web page
(...) The Visual Support App can be launched in different ways depending on the device being used.
One way is universal and works either with the Visual Support App on Android or iOS, but requires the Visual Support App to be already installed on the device. The second way - for android only - and the third way - iOS only - are also handling the installation of the app if not installed yet.
Universal launch
To launch the Visual Support App from any web site reached from a mobile, include the following link:
sightcall://[?param=value[¶m2=value2]*]
For example:
<a href="sightcall://?mode=sixdigits&videosmall=no&videofull=out&videoout=rear&videoprofile=md&videoptrout=on&appid=xxxxxxxxxx&buttons=0176459a">Start the call</a>
Android launch
The URL scheme on Android is better handled using Android Intents on Chrome.
Following this specification will ensure that:
- if the application is installed: the application will be started using the provided parameters
- otherwise: Play Store application is started and prompts the user to install the application
Here is an example using the href
attribute:
<a href="intent://?mode=sixdigits&appid=xxxxxxx&buttons=01239&buttons=0176459a&videofull=out#Intent;scheme=sightcall;package=com.sightcall.sightcall;end">Start</a>
This experience helps lead a user through the installation and use of the Universal App.
iOS launch
In iOS, in addition to the universal launch, the use of the meta tag indicates to Safari for iPhone the id of the App in the App Store. Safari then detects if the app is installed or not. If not, it generates a button to the app store. If it is installed, the same buttons is used to launch the app
In iOS, in addition to the universal launch, the use of the meta tag indicates to the Safari browser, on the iPhone, the id of the App in the App Store. Safari then detects if the app is installed or not. If it has not been installed, it generates a button and clicking on it will lead to the app store. If it is installed, the same buttons will launch the app.
The same example would then be:
<meta name="apple-itunes-app" content="app-id=935317995, affiliate-data=myAffiliateData, app-argument=sightcall://?mode=sixdigits&videosmall=no&videofull=out&videoout=rear&videoprofile=md&videoptrout=on&appid=xxxxxxxxxx&buttons=0176459a">
When using this meta tag, a button can also be added directly in the page to start the Universal App.
<div class="button">
<a href="sightcall://?mode=sixdigits&videosmall=no&videofull=out&videoout=rear&videoprofile=md&videoptrout=on&appid=xxxxxxxxxx&buttons=0176459a">Start the call</a>
</div>
Modes
Several modes are allowed in the Universal App.
- phone: in this mode the Universal App automatically triggers a call to an already connected user whose uid is given as parameter.
- sixdigits: in this mode, the user is requested to enter a six-digit code generated by a
premium_plus
user. Once entered, the application automatically triggers a call to that user. - join: in this mode the Universal App connects to a multiparty call.
- host: in this mode the Universal App hosts and connects to a multiparty call already created by this user.
Except for host (premium only), all other modes are avaliable for internal or external users.
Implementation
For more details on using the Visual Support App into your application, please contact your sales representative.