MobbScan Web: Video Conference · Mobbeel for developers

Introduction

Some workflows need the intervention of a human to verify the identity of a user. MobbScan covers this with the Video Conference feature, which can open a video call between the user that is being identified and an agent.

The feature has two parts:

the client, which corresponds to the website where a user is being identified
the agent, which corresponds to the website where an agent will interact with the user The agent part is optional, since it is already supported in the Validation portal, but it can also be integrated in any web.

The conference will be recorded in the Validation portal, even if the agent part is integrated in an external web. More specifically, it will record the audio and video of the client, and the audio of the agent. The recording will only start when an agent starts the conference.

To enable this feature, some extra steps are needed that will be described below.

Configuration

This configuration is common for the agent and for the client.

To enable the video conference, you should add in your head HTML element an additional script, replacing {version} with your current MobbScan Video version (which could differ with the MobbScan Web version, but they are bundled together in the same distribution file), and specifying the correct path to your mobbscan-api folder:

<script type="text/javascript" src="../mobbscan-api/mobbscan-videoapi-{version}.min.js"></script>

After that, the initialization requires some extra steps:

First of all, the agent URL should be set (notice that MobbScanApiVideo is being used instead of MobbScanAPI):
```
MobbScanApiVideo.setBaseUrl("https://your-mobbscan-instance.com/mobbscan-agent");
```

Two extra divs should be added to render the client and agent viewports:

<div id="local-video-placeholder"></div>
<div id="remote-video-placeholder"></div>

The previosly created div elements should be referenced with their id in MobbScanApiVideo:

MobbScanApiVideo.setLocalPlaceholder('local-video-placeholder');
MobbScanApiVideo.setRemotePlaceholder('remote-video-placeholder');

How to use

Once everything has been configured, set the part that will be used:

Client part

MobbScanApiVideo.setIdentifier("client");

Agent part

MobbScanApiVideo.setIdentifier("agent");

The video conference can be started using a valid scanId (provided by the listener of MobbScanAPI.start in the client part);

Client part
```
MobbScanApiVideo.start(scanId);
```
Agent part
```
MobbScanApiVideo.startAgent(scanId);
```

Additionally, you could check if any there are any errors or other extra information during the conference:

MobbScanApiVideo.setListener(videoListener);

The listener receives the following arguments:

message: Message from the video conference system.
data: Additional data.
error: In case of an error, this parameter will contain further details about it.

Stop video conference

The conference could be stopped at any time using the following method:

MobbScanApiVideo.stop();