Co Browse API

Last updated 26 days ago

Acquire Co-browse is a collaboration tool that can be used during voice or chat interactions to enable a company representative to see the screen of the customer that he’s interacting with in real-time.

This allows agents to better understand a customer’s question or problem, and provide faster and more accurate help, leading to better resolutions and more satisfied customers.

Co-browsing is an indispensable sales conversion and customer support tool that drives business objectives as well as revenue. This document will cover the end-to-end deployment process and the most effective best practices to consider when planning, deploying and using the Acquire Co-browse solution, along with ways to measure its success.

Acquire Co browse API in you can use multiple events and manage custom easily.

Co Browse Events

1. cobrowse-request

Acquire Co browse API event type 'cobrowse-request' uers request send after call and this api given user's response true or false.

verified : verified, means if request is confirmed by visitor

cb : (true,false) This event defines if acquire will get confirmation from user or not. It depends on app settings.

Sample Code

window.acquire.push(function(app){
app.on('cobrowse-request',function (verified,cb) {
// verified, means if request is confirmed by visitor.
// cb is callback, you must return either true or false to allow cobrowser
//cb(true);// means allow cobrowse to happen
console.log("cobrowse-request", verified,cb);
});
});

2. cobrowse_session

'cobrowse_session' in three types event available.

  • mirror

  • mirror-dispose

  • dispose

mirror: this event co-browsing request accept after just calling.

cobrowse-request and mirror event

Sample Code

window.acquire.push(function(app){
app.on("cobrowse_session", function (cobrowse_session) {
console.log("cobrowse_session ", cobrowse_session);
cobrowse_session.on('mirror', function (param1, param2, param3) {
console.log("mirror ", param1, param2, param3);
});
});
});

mirror-dispose: this event new page open and reload after calling.

mirror-dispose event

Sample Code

window.acquire.push(function(app){
app.on("cobrowse_session", function (cobrowse_session) {
console.log("cobrowse_session ", cobrowse_session);
cobrowse_session.on('mirror-dispose', function (param1) {
console.log("mirror-dispose ", param1);
});
});
});

dispose: this event co-browsing close after calling.

dispose event

Sample Code

window.acquire.push(function(app){
app.on("cobrowse_session", function (cobrowse_session) {
console.log("cobrowse_session ", cobrowse_session);
cobrowse_session.on('dispose', function () {
console.log("dispose ");
});
});
});

Hide customer sensitive information to agent.

Please add this tag in your html text box:

"data-skip-cobrowse"

Sample Code to embed

<input data-skip-cobrowse type="text" name="creditcard" placeholder="credit card number">

Hide all text field and text data

"data-skipui-cobrowse"

<div data-skipui-cobrowse class="test-cobrowse-field">
<p>This field all data Hide.</p>
</div>