Browser SDK V2

Plivo Browser SDK allows you to make and receive calls using Plivo applications directly from any web browser that supports webRTC. Using our SDK you can create applications like Click to Call, Conferencing Apps and even Webphones. Currently we support Google Chrome 55 and above and Firefox 51 and above.

Try out the demo here:

Get started with examples

Including the javascript

Include the plivo javascript file as shown below

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

Initializing 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);

Registering using your Plivo Endpoint

Register using your Plivo Endpoint credentials

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

Making a call

Making a call to any number/sip endpoint. Do remember that the application attached to the registered endpoint should have an answer url that will ensure 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);

Accepting a call

This is how an incoming call should be answered once the onIncomingCall event is received

plivoBrowserSdk.client.answer();

Sending DTMF

The snippet below shows how you can send a DTMF tone when in a phone call

plivoBrowserSdk.client.sendDtmf("1");

Configuration

The following are the configuration parameters:

Methods

These are the methods supported on plivoBrowserSdk.client

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

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