Browser SDK

The Plivo Browser SDK lets you make and receive calls via Plivo applications directly from any web browser that supports WebRTC. Using our SDK you can create applications like click to call, conferencing, and web phones. We support the most recent and previous 10 versions of Chrome and Firefox, and the most recent and previous five versions of Safari.

Getting started with example applications

To see how to use Browser SDK, let’s walk through some simple code. Our example applications are a good introduction, and we call out some key points below.

Include the JavaScript

Include the Plivo JavaScript file:

<script type="text/javascript" src="https://cdn.plivo.com/sdk/browser/v2.0.24/plivo.min.js"/>

Initialize the plivoBrowserSdk object

The plivoBrowserSdk object needs to be initialized.

var options = {
    "debug":"DEBUG",
    "permOnClick":true,
    "audioConstraints":{"optional":[{"googAutoGainControl":false},{"googEchoCancellation":false}]},
    "enableTracking":true
};
var plivoBrowserSdk = new window.Plivo(options);

Event registration

Pass function references to the events produced from the SDK. This is where your UI manipulation should handle all the different call flows.

plivoBrowserSdk.client.on('onWebrtcNotSupported', onWebrtcNotSupported);
plivoBrowserSdk.client.on('onLogin', onLogin);
plivoBrowserSdk.client.on('onLogout', onLogout);
plivoBrowserSdk.client.on('onLoginFailed', onLoginFailed);
plivoBrowserSdk.client.on('onCallRemoteRinging', onCallRemoteRinging);
plivoBrowserSdk.client.on('onIncomingCallCanceled', onIncomingCallCanceled);
plivoBrowserSdk.client.on('onCallFailed', onCallFailed);
plivoBrowserSdk.client.on('onCallAnswered', onCallAnswered);
plivoBrowserSdk.client.on('onCallTerminated', onCallTerminated);
plivoBrowserSdk.client.on('onCalling', onCalling);
plivoBrowserSdk.client.on('onIncomingCall', onIncomingCall);
plivoBrowserSdk.client.on('onMediaPermission', onMediaPermission);
plivoBrowserSdk.client.on('mediaMetrics',mediaMetrics);
plivoWebSdk.client.on('onConnectionChange',onConnectionChange);

Register using your Plivo endpoint

Register using your Plivo endpoint credentials.

var username = 'johndoe12345';
var pass = 'XXXXXXXX';
plivoBrowserSdk.client.login(username, password);

Make a call

Make a call to any phone number or SIP endpoint. The application attached to a  registered endpoint should have an answer URL that ensures that the correct <Dial> element is returned.

var dest = “jane1234@phone.plivo.com”;
var extraHeaders = {'X-PH-Test1': 'test1', 'X-PH-Test2': 'test2'};
plivoBrowserSdk.client.call(dest, extraHeaders);

Accept a call

Answer an incoming call when an onIncomingCall event is received.

plivoBrowserSdk.client.answer();

Send a DTMF tone

Send a DTMF tone when in a phone call.

plivoBrowserSdk.client.sendDtmf("1");

Configuration

Here are the configuration parameters:

Methods

These are the methods supported on plivoBrowserSdk.client

These methods are supported on plivoBrowserSdk.client.audio (supported only on Chrome).

Objects in Audio Device API plivoBrowserSdk.client.audio are: