This Plivo example shows how to use all the features in Plivo WebSDK 2.0 using a simple webphone demo. This demo helps in making phone calls from web browser to both sip addresses and PSTN phone numbers without installing any plugins.
To use the live web phone demo
a. Sign up for a Plivo account here: https://manage.plivo.com/accounts/register/
b. Create a Plivo Endpoint here: https://manage.plivo.com/endpoint/create/.
c. Use this Plivo endpoint to login after deploying the application
git clone https://github.com/plivo/plivo-websdk-2.0-example.git
npm install
npm start
Include
<script type="text/javascript" src="https://cdn.plivo.com/sdk/browser/v2/plivo.min.js"></script>in the <body> tag before you include other javascript files dependent on the SDK.
Lets create a customclient.js file and declare a variable var plivoWebSdk;
This is where we initialise a new Plivo object by passing options as plivoWebSdk = new window.Plivo(options);. The application can set up listeners for events as shown in the initPhone function below.
var plivoWebSdk;
function initPhone(username, password){
var options = refreshSettings();
plivoWebSdk = new window.Plivo(options);
plivoWebSdk.client.on('onWebrtcNotSupported', onWebrtcNotSupported);
plivoWebSdk.client.on('onLogin', onLogin);
plivoWebSdk.client.on('onLogout', onLogout);
plivoWebSdk.client.on('onLoginFailed', onLoginFailed);
plivoWebSdk.client.on('onCallRemoteRinging', onCallRemoteRinging);
plivoWebSdk.client.on('onIncomingCallCanceled', onIncomingCallCanceled);
plivoWebSdk.client.on('onCallFailed', onCallFailed);
plivoWebSdk.client.on('onCallAnswered', onCallAnswered);
plivoWebSdk.client.on('onCallTerminated', onCallTerminated);
plivoWebSdk.client.on('onCalling', onCalling);
plivoWebSdk.client.on('onIncomingCall', onIncomingCall);
plivoWebSdk.client.on('onMediaPermission', onMediaPermission);
plivoWebSdk.client.on('mediaMetrics',mediaMetrics);
plivoWebSdk.client.on('audioDeviceChange',audioDeviceChange);
plivoWebSdk.client.setRingTone(true);
plivoWebSdk.client.setRingToneBack(true);
console.log('initPhone ready!')
}In the demo, options can be set from UI in the SETTINGS menu. Once the SETTINGS is updated clicking on LOGIN will boot the phone again.
If you're directly calling login on page load, please make sure you do that only after HTML document ready.
<script type="text/javascript">
$( document ).ready(function() {
console.log( "HTML ready!" );
resetSettings(); // Optional, reset your Plivo settings on page load
initPhone(); // Optional, Initialise Plivo sdk instance on load
});
</script>Login accepts Plivo Endpoint Credentials.
function login(username, password) {
if(username && password){
//start UI load spinner
kickStartNow();
plivoWebSdk.client.login(username, password);
$('#sipUserName').html('sip:'+username+'@'+plivoWebSdk.client.phone.configuration.hostport_params);
document.querySelector('title').innerHTML=username;
}else{
console.error('username/password missing!')
}
}
$('#clickLogin').click(function(e){
var userName = $('#loginUser').val();
var password = $('#loginPwd').val();
login(userName, password);
});Options allow to disable tracking, setting codec type, enabling and disabling AEC/AGC etc. The list of all the settings can be found in the documentation page.
function resetSettings(source){
var defaultSettings = { "debug": "DEBUG", "permOnClick": true, "codecs": ["OPUS","PCMU"], "enableIPV6": false, "audioConstraints": { "optional": [ { "googAutoGainControl": false }, {"googEchoCancellation":false} ] }, "enableTracking": true}
var uiSettings = document.querySelector('#appSettings');
uiSettings.value = JSON.stringify(defaultSettings);
if(source == 'clickTrigger')
localStorage.removeItem('plivosettings');
}
function refreshSettings(){
var getSettings = localStorage.getItem('plivosettings');
var uiSettings = document.querySelector('#appSettings');
if(getSettings){
uiSettings.value = getSettings;
return JSON.parse(getSettings);
}else{
return JSON.parse(uiSettings.value);
}
}
function updateSettings(val){
localStorage.setItem('plivosettings',val);
console.log('plivosettings updated!')
}
// From UI triggers
$('#updateSettings').click(function(e){
var appSettings = document.querySelector('#appSettings');
appSettings = appSettings.value;
updateSettings(appSettings);
});
$('#resetSettings').click(function(e){
resetSettings('clickTrigger');
}); The following snippet shows how to handle registration related events in the application
function onReady(){
$('#phonestatus').html('trying to login...');
console.info('Ready');
}
function onLogin(){
$('#phonestatus').html('online');
console.info('Logged in');
$('#makecall').attr('class', 'btn btn-success btn-block flatbtn');
$('#uiLogin').hide();
$('#uiLogout').show();
$('.feedback').show();
}
function onLoginFailed(reason){
$('#phonestatus').html('login failed');
console.info('onLoginFailed ',reason);
customAlert('Login failure :',reason);
}
function onLogout(){
$('#phonestatus').html('Offline');
console.info('onLogout');
}Given a number or SIP URI, this snippet shows how to make an outgoing call. The following snippet takes input from the dial pad UI.
$('#makecall').click(function(e){
var to = $('#toNumber').val().replace(" ","");
var callEnabled = $('#makecall').attr('class').match('disabled');
if(!to || !plivoWebSdk || !!callEnabled){return};
console.info('Click make call : ',to);
$('.callScreen').show();
$('.AfterAnswer').show();
plivoWebSdk.client.call(to);
$('#boundType').html('Outgoing :');
$('#callNum').html(to);
$('#callDuration').html('00:00:00');
$('.callinfo').show();
});There are cases where you need to set different caller ID for each campaign or some different reasons, then you can start using extraHeaders in .call() method
$('#makecall').click(function(e){
var to = $('#toNumber').val();
// pass caller Id
var extraHeaders={},
customCallerId=$('#callerId').val(); // get the dynamic caller id
if(customCallerId){
extraHeaders = {'X-PH-callerId': customCallerId};
}
console.info('Click make call : ',to);
plivoWebSdk.client.call(to, extraHeaders);
});Capture this extraHeader in application side and use callerId attribute to set the callerId in Dial Element
By creating the onIncomingCall listener, the plivoWebSdk object can handle incoming calls to the Plivo Endpoint.
function onIncomingCall(callerName, extraHeaders){
console.info(callerName, extraHeaders);
$('#boundType').html('Incomming :');
$('#callNum').html(callerName);
$('#callDuration').html('00:00:00');
$('.callinfo').show();
$('.callScreen').show();
$('.inboundBeforeAnswer').show();
}
function onIncomingCallCanceled(){
console.info('onIncomingCallCanceled');
callOff();
}The following snippet shows how to answer an incoming call
$('#inboundAccept').click(function(){
console.info('Call accept clicked');
plivoWebSdk.client.answer();
$('.inboundBeforeAnswer').hide();
$('.AfterAnswer').show();
});
The following snippet shows how to reject an incoming call
$('#inboundReject').click(function(){
console.info('callReject');
plivoWebSdk.client.reject();
});This code may be used to terminate a call.
$('#Hangup').click(function(){
console.info('Hangup');
if(plivoWebSdk.client.callSession){
plivoWebSdk.client.hangup();
}else{
callOff();
}
});This snippet will hangup existing calls when page is refreshed or closed.
window.onbeforeunload = function () {
plivoWebSdk.client && plivoWebSdk.client.logout();
}; This snippet shows how to handle network or media related events from the SDK. A simple dynamic UI to show notifications when some warning events get emitted from Plivo SDK
Please check Chrome or Firefox console to see the complete info of the event.
function mediaMetrics(obj){
sessionStorage.setItem('triggerFB',true);
console.table([obj]);
var message = obj.type;
var classExist = document.querySelector('.-'+obj.type);
if(obj.type.match('audio') && obj.value > 30){
message = "same level";
}
if(obj.active){
classExist? classExist.remove() : null;
$(".alertmsg").prepend(
'<div class="metrics -'+obj.type+'">' +
'<span style="margin-left:20px;">'+obj.level+' | </span>' +
'<span style="margin-left:20px;">'+obj.group+' | </span>' +
'<span style="margin-left:20px;">'+message+' - '+obj.desc+' : </span><span >'+obj.value+'</span>'+
'<span aria-hidden="true" onclick="closeMetrics(this)" style="margin-left:25px;cursor:pointer;">X</span>' +
'</div>'
);
}
if(!obj.active && classExist){
document.querySelector('.-'+obj.type).remove();
}
}The Audio Device API in this SDK allows developers to select input, output and ring devices for the calls.
The following snippet uses this API to demonstrate how to handle device selection from the UI
// Audio device selection
$('#micDev').change(function(){
var selectDev = $('#micDev').val();
plivoWebSdk.client.audio.microphoneDevices.set(selectDev);
console.debug('Microphone device set to : ',selectDev);
});
$('#speakerDev').change(function(){
var selectDev = $('#speakerDev').val();
plivoWebSdk.client.audio.speakerDevices.set(selectDev);
console.debug('Speaker device set to : ',selectDev);
});
$('#ringtoneDev').change(function(){
var selectDev = $('#ringtoneDev').val();
plivoWebSdk.client.audio.ringtoneDevices.set(selectDev);
console.debug('Ringtone dev set to : ',selectDev);
});The following snippet uses this API and demonstrates the use case of testing audio devices
// Ringtone device test
$('#ringtoneDevTest').click(function(){
var ringAudio = plivoWebSdk.client.audio.ringtoneDevices.media();
// Toggle play
if(ringAudio.paused){
ringAudio.play();
$('#ringtoneDevTest').html('Pause');
}else{
ringAudio.pause();
$('#ringtoneDevTest').html('Play');
}
});
// Speaker device test
$('#speakerDevTest').click(function(){
var speakerAudio = plivoWebSdk.client.audio.speakerDevices.media();
// Toggle play
if(speakerAudio.paused){
speakerAudio.play();
$('#speakerDevTest').html('Pause');
}else{
speakerAudio.pause();
$('#speakerDevTest').html('Play');
}
});The following snippet uses this API to retrieve available devices and populate them in UI
function updateAudioDevices(){
// Remove existing options if any
document.querySelectorAll('#micDev option').forEach(e=>e.remove())
document.querySelectorAll('#ringtoneDev option').forEach(e=>e.remove())
plivoWebSdk.client.audio.availableDevices()
.then(function(e){
e.forEach(function(dev){
if(dev.label && dev.kind == "audioinput")
$('#micDev').append('<option value='+dev.deviceId+'>'+dev.label+'</option>')
if(dev.label && dev.kind == "audiooutput"){
$('#ringtoneDev').append('<option value='+dev.deviceId+'>'+dev.label+'</option>');
$('#speakerDev').append('<option value='+dev.deviceId+'>'+dev.label+'</option>')
}
});
})
.catch(function(error){
console.error(error);
})
}
//revealAudioDevices - to force ask for permission
$('#allowAudioDevices').click(function(){
document.querySelectorAll('#popAudioDevices option').forEach(e=>e.remove());
plivoWebSdk.client.audio.revealAudioDevices()
.then(function(e){
updateAudioDevices();
console.log('Media permission ',e)
})
.catch(function(error){
console.error('media permission error :',error);
$('#mediaAccessBlock').modal('show');
})
});Show users about change in audio device, either added or removed. When a new device gets added they can select the device for either input or output audio.
function audioDeviceChange(e){
console.log('audioDeviceChange',e);
if(e.change){
if(e.change == "added"){
customAlert(e.change,e.device.kind +" - "+e.device.label,'info');
}else{
customAlert(e.change,e.device.kind +" - "+e.device.label,'warn');
}
}else{
customAlert('info','There is an audioDeviceChange but mediaPermission is not allowed yet');
}
}The following snippet shows how to collect feedback using the SDK. There is a predefined list of feedback comments that users can select for the score range from 1-3. In this application we are taking “good” and “perfect” as feedback for scores 4 and 5.
$('#sendFeedback').click(function(){
var score = $('#stars li.selected').last().data('value');
score = Number(score);
var lastCallid = plivoWebSdk.client.getLastCallUUID();
// var comment = $("input[type=radio][name=callqualitycheck]:checked").val() || "good";
var comment = "";
if(score == 5){
comment = "good";
}
document.querySelectorAll('[name="callqualitycheck"]').forEach(e=>{
if(e.checked){
comment = comment + "," + e.value;
}
});
if(sendFeedbackComment.value){
comment = comment + "," + sendFeedbackComment.value;
}
comment = comment.slice(1);
if(!comment){
customAlert('feedback','Please select any comment');
return;
}
if(!score){
customAlert('feedback','Please select star');
return;
}
plivoWebSdk.client.sendQualityFeedback(lastCallid,score,comment);
customAlert('Quality feedback ',lastCallid);
});