Genesys Documentation - User contributions [en]

PEC-COB/Current/Developer/GCBCobrowseSessions

2020-08-31T21:02:18Z

Llannoye: Published

{{Article
|Standalone=No
|DisplayName=Genesys Co-browse sessions
|TocName=Genesys Co-browse sessions
|Context=Co-browse sessions are the interactions between customers and agents, where privacy and security are priorities.
|ComingSoon=No
|Platform=GenesysEngage-cloud
|Role=Administrator, Developer
|Section={{Section
|alignment=Vertical
|structuredtext=A session is initiated when a customer requests to co-browse. The session stays idle until the agent joins, then the session is considered to be active. The session ends when one of the parties (the customer or the agent) exits. It is not possible to re-join a co-browse session. If one party exits accidentally, a new session must be initiated. An agent is limited to handling one co-browse session at a time.
|Status=No
}}{{Section
|sectionHeading=Session identifiers
|anchor=Sessionidentifiers
|alignment=Vertical
|structuredtext=Each live session has an identifier that can be used to track the session. This session ID is a sequence of nine digits that is applicable only to live sessions.
|Status=No
}}{{Section
|sectionHeading=Starting a session
|anchor=Startingasession
|alignment=Vertical
|structuredtext=A co-browse session can only be initiated by a customer. An agent does not have the option or ability to send a co-browse request to a customer. This provides greater security to the customer. In order to initiate a co-browse session, the customer must already be engaged in an interaction with an agent, be it a voice call or a chat.

When the session is established, the agent's browser displays a view of the customer's browser. This view that the agent sees is loaded from Genesys Co-browse. The agent is not a client of the website. All actions taken by the agent are passed onto and "replayed" on the customer's side.

{{Section
|sectionHeading=Starting a co-browse session from Genesys Widgets
|Type=Structured|gif=No|Media=Image|anchor=GWidge|alignment=Horizontal|structuredtext=A customer initiates a co-browse session through a {{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCDeployment|display text=Genesys Widget}} integrated into the website. You can enable Genesys Co-browse in several Genesys Widgets.

Here is an example of starting a co-browse session from the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=WebChat-combined|display text=WebChat Widget.}}
|image=GCB StartCobrowse5.png
}}

{{Section
|sectionHeading=
|Type=Structured|gif=No|Media=Image|anchor=|alignment=Horizontal|structuredtext=This example shows a customer and agent view of a co-browse session started from the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=WebChat-combined|display text=WebChat Widget.}}
|image=GCB Cust Agent View WebChatWidget.png
}}

{{Section
|sectionHeading=
|Type=Structured|gif=No|Media=Image|anchor=|alignment=Horizontal|structuredtext=And here is an example of starting a co-browse session from the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=ChannelSelector-combined|display text=ChannelSelector Widget.}}
|image=GCB New Start ChannelSelectorWidget.png
}}

{{Section
|sectionHeading=
|Type=Structured|gif=No|Media=Image|anchor=|alignment=Horizontal|structuredtext=This example shows starting a co-browse session from the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=CallUs-combined|display text=CallUs Widget}} with the '''browse with you''' link as the co-browse option.
|image=GCB CallUsWidget CB Option.png
}}

{{Section
|sectionHeading=
|Type=Structured|gif=No|Media=Image|anchor=|alignment=Horizontal|structuredtext=After clicking '''browse with you''' in the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=CallUs-combined|display text=CallUs Widget}} the customer will see this dialog.
|image=GCB CallUsWidget Dialog.png
}}

{{Section
|sectionHeading=Stopping a co-browse session from Genesys Widgets
|Type=Structured|gif=No|Media=Image|anchor=|alignment=Horizontal|structuredtext=Once a co-browse session has been established, both parties have the ability to terminate the session. At any time, either party may click the '''Exit Co-browse session''' icon next to the session ID. The agent can also exit by clicking {{Link-AnywhereElse|product=PEC-AD|version=Current|manual=Agent|topic=ADcobrow|anchor=Scbs|display text='''Exit Session'''}} in Agent Desktop.

The other party will be notified that the session has ended, and the agent's browser will no longer display a view of the customer's browser. Also, if the primary interaction (chat or voice call) is terminated, the co-browse session terminates automatically. Sessions can also terminate due to inactivity, after a pre-configured timeout expires. Likewise, if the agent closes their browser, or navigates to a third-party website, the session will terminate if the agent does not return to the session page within the pre-configured timeout.

Once a session has been terminated, it cannot be reactivated. If the session was deactivated accidentally, a new session has to be initiated, with a new session identifier.
|image=GCB Stop Cobrowse1.png
}}
|Status=No
}}{{Section
|sectionHeading=Participating in a co-browse session
|anchor=Participatinginaco-browsesession
|alignment=Vertical
|structuredtext=Once a co-browse session begins, the agent can use his or her mouse pointer to guide the customer through the web site. Agents start co-browse sessions in {{Link-AnywhereElse|product=PEC-AD|version=Current|manual=Agent|topic=ADcobrow|anchor=PointerMode|display text=Pointer Mode}}. In Pointer Mode, the customer and the agent can see each other's mouse pointer but the agent can not enter any information into the web page, click buttons, or navigate the customer's browser. If the agent needs to enter information into the web page or to navigate the browser, he or she can send the customer a request to switch the co-browse session to {{Link-AnywhereElse|product=PEC-AD|version=Current|manual=Agent|topic=ADcobrow|anchor=WriteMode|display text=Write Mode}}.

All actions (mouse clicks, key presses, and so on) are actually performed on the customer side. Any actions taken by the agent are sent to the customer's browser. This ensures a secure approach, as all browsing is done on one side—the customer's side. This approach also provides for greater performance and a more seamless customer experience. Each participant can see the other participant's mouse movements as well. This enables an agent to point to specific sections on the web page to help direct the customer through their task.
|Status=No
}}{{Section
|sectionHeading=Restricting visibility of sensitive data
|alignment=Horizontal
|Media=Image
|image=GCB90Data_masking_agent_customer.png
|structuredtext=You can limit which fields are visible to and editable by the agent and which elements are controlled by agents. This configuration task is made much easier for you by using the {{Link-SomewhereInThisManual|topic=GCBCobrowseRestrictionsMgr|anchor=top|display text=Co-browse DOM Restrictions Editor}}.

Some fields can have the data masked. For example, you might choose to hide the customer's user name, email address, password, Social Security information, and so on, from the agent. The end user can easily identify which information is hidden (data masked) from the agent. By default, all passwords are masked.

At the same time, control for some elements can be disabled. By default, all '''Submit''' buttons are deactivated for the agent. If he or she clicks on a '''Submit''' button, nothing happens. The customer always has permission to submit any web forms, just as they would while browsing normally.
|Status=No
}}
}}

PEC-COB/Current/Developer/GCBCobrowseJavaScriptAPI

2020-08-31T21:01:18Z

Llannoye: Published

{{Article
|Standalone=No
|DisplayName=Genesys Co-browse JavaScript API
|TocName=Genesys Co-browse JavaScript API
|Context=For advanced users, deploying Co-browse to your website without using Genesys Widgets can give you the control you want for your environment.
|ComingSoon=No
|Platform=GenesysEngage-cloud
|Role=Developer
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|This article contains advanced functionality and assumes that you are '''not''' using {{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCDeployment|display text=Genesys Widgets}} to add Co-browse to your website. {{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCDeployment|display text=Genesys Widgets}} is recommended in most cases.|1}}
|Status=No
}}{{Section
|sectionHeading=Deploying Co-browse to your website
|anchor=DeployingCo-browsetoyourwebsite
|alignment=Vertical
|structuredtext=Prerequisite: you must have Co-browse provisioned and an API Key provided to you.

A good starting point is this script:

<source lang="javascript">
<script>
if(!window._genesys)window._genesys = {};
window._genesys.cobrowse = {
apikey: <APIKEY>
};
</script>
<script>(function(d, s, id, o) {
var fs = d.getElementsByTagName(s)[0], e;
if (d.getElementById(id)) return;
e = d.createElement(s); e.id = id; e.src = o.src;
e.setAttribute('data-gcb-url', o.cbUrl);
fs.parentNode.insertBefore(e, fs);
})(document, 'script', 'genesys-js', {
src: "https://api.genesyscloud.com/gcb/cobrowse/js/gcb.min.js?apikey=<APIKEY>",
cbUrl: "https://api.genesyscloud.com/gcb/cobrowse"
});</script>
</source>
|Status=No
}}{{Section
|sectionHeading=Configuring Co-browse
|anchor=ConfiguringCo-browse
|alignment=Vertical
|structuredtext=Co-browse is configured via a <tt>global _genesys.cobrowse</tt> variable.

The following options are configurable as properties of an object passed to <tt>_genesys.cobrowse</tt>:

===debug===
Default: false

Set to <tt>true</tt> to enable debugging console logs.
<source lang="javascript">
window._genesys.cobrowse = {
debug: true;
};
</source>

===disableBuiltInUI===
Default: false

Set to <tt>true</tt> to use a custom Co-browse UI. Use the Co-browse JavaScript API to implement a custom UI.

<source lang="javascript">
window._genesys.cobrowse = {
disableBuiltInUI: true
};
</source>

You can still start the Co-browse session with just the configuration above, but the main components of the UI, such as the toolbar and notifications, will be missing.

===primaryMedia===
Default: null

Used to pass an object implementing an external media adapter interface.

Example:

<source lang="javascript">
var myPrimaryMedia = {
initializeAsync: function(done) { /* initialize your media here and then call done() */ },
isAgentConnected: function() { /* return true or false depending on whether an agent is connected */ },
sendCbSessionToken: function(token) { /* send the Co-browse session token to agent */ }
};

window._genesys.cobrowse = {
primaryMedia: myPrimaryMedia
};
</source>

See {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=icbwc|display text=Integrating Co-browse with Chat}} for more details.

If Co-browse does not detect any primary media or detects that the agent is not connected with the primary media, Co-browse will still ask the user, "Are you on the phone with representative?" before starting the Co-browse session.

===setDocumentDomain===
Default: false

Determines if Co-browse sets the <tt>document.domain</tt> property. If set to <tt>true</tt>, Co-browse modifies the <tt>document.domain</tt> property. If set to <tt>false</tt>, Co-browse does not modify <tt>document.domain</tt>.

Co-browse modifies <tt>document.domain</tt> to support cross-subdomain communication between iframes and the topmost context. Setting <tt>setDocumentDomain</tt> to <tt>false</tt> stops synchronization of subdomain iframes from working.

<source lang="javascript">
window._genesys.cobrowse = {
setDocumentDomain: true
};
</source>

===disableBackForwardCache===
Default: true

By default, Co-browse disables Safari's Back/Forward cache, which can stop Co-browse sessions from functioning.

Setting <tt>disableBackForwardCache</tt> to <tt>false</tt> can make Co-browse unusable in Safari when users click the back or forward browser buttons.

<source lang="javascript">
window._genesys.cobrowse = {
disableBackForwardCache: false
};
</source>

{{AnchorDiv|ata}}
|Status=No
}}{{Section
|sectionHeading=Accessing the API
|anchor=AccessingtheAPI
|alignment=Vertical
|structuredtext=Since the main Co-browse JavaScript file is added to the page asynchronously, you cannot instantly access the Co-browse APIs. Instead, you must use a function that will accept the APIs as an argument.

For that, add a special <tt>.onReady</tt> property in <tt>_genesys.cobrowse</tt> configuration and set it to empty array.
<source lang="javascript">
if(!window._genesys)window._genesys = {};
window._genesys.cobrowse = {
apikey: <APIKEY>,
onReady: []
};
</source>

Now, you can use <tt>_genesys.cobrowse.onReady.push(callbackFn)</tt> anywhere in your code. When the Co-browse JavaScript is loaded and the API is available, Co-browse will call back the <tt>callbackFn</tt> with the reference to the API object.

<source lang="javascript">
_genesys.cobrowse.onReady.push(function(cobrowseApi) {
// use the API here
});
</source>
|Status=No
}}{{Section
|sectionHeading=Using the API
|anchor=UsingtheAPI
|alignment=Vertical
|structuredtext=This API provides methods and callbacks to work with Co-browse and can be used to implement a custom UI for co-browsing.

===Co-browse in iframes===
Co-browse synchronizes the content of any iframes that exist on the page, given:

*the iframe is on the same domain as the page
*the page in the iframe has Co-browse JavaScript

Some Co-browse UI elements, such as the toolbar, should not appear in an iframe. Common Co-browse UI elements (such as notification that an element is masked) should appear whether or not Co-browse is in an iframe. As such, there are two contexts for the Co-browse JavaScript API:

*Top context, available when Co-browse is not in an iframe but in "top" context.
*Child context, used when a page is rendered in an iframe. For the child context, a subset of the top context API is available.

====isTopContext====
You can use the <tt>isTopContext</tt> variable to determine which context Co-browse is rendered in. <tt>isTopContext</tt> is passed to the <tt>onReady</tt> callback and equals <tt>true</tt> if Co-browse is rendered in the top context and <tt>false</tt> in iframe.

Example:

<source lang="javascript">
_genesys.cobrowse.onReady.push(function(cobrowseApi, isTopContext) {
// common functionality
cobrowseApi.onMaskedElement.add(function() {/* deal with masked elements here*/});
if (!isTopContext) {
return;
}
// top context functionality goes below
});
</source>

See {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=ata|display text=Accessing the API}} if you are unfamiliar with the <tt>onReady</tt> syntax above.

===Signals and Callbacks===
The Co-browse API exposes a number of '''signals''' in both the top and child contexts. Each signal is an object with the following three methods:

*<tt>add(function)</tt>—adds a callback
*<tt>addOnce(function)</tt>—adds a callback that will be executed only once
*<tt>remove(function)</tt>—removes a callback

The naming convention for signal names begins with "on" and follows the format '''onSomethingHappened'''.

{{NoteFormat|'''Signals''' act similar to '''deferred''' objects. If you add a callback to an event that has already happened, the callback will be called immediately. For example, if you add a callback to the <tt>onAgentJoined</tt><nowiki> signal when the event has already happened, the callback will be called immediately.}}

{{AnchorDiv|sessobj}}
====Session Object====
Many callbacks receive a <tt>session</tt> object as an argument. This object has the following properties:

*<tt>token</tt>—String containing the session token shared with the agent and possibly shown in the UI. The token is a 9 digit string such as "535176834".
*<tt>agents</tt>—Array of connected agents. Each element in the array is an object with no properties.

===Common API===
The following elements and properties are available from both the top and child Co-browse contexts:

====VERSION====
String containing current JS version. For example, <tt>9.0.002.02</tt>.

<source lang="javascript">
console.log(_genesys.cobrowse.VERSION);
</source>

====onSessionStarted====
This signal is dispatched when a Co-browse session is successfully started such as when the <tt>Co-browse</tt> button is pressed or when <tt>startSession()</tt> is called.

Arguments:

*<tt>session</tt>—{{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=sessobj|display text=Session <tt>object</tt>}} representing the ongoing session.

Example:
<source lang="javascript">
function notifyCobrowseStarted(session) {
alert('Co-browse has started. Spell this session token to our representative: ' + session.token);
}
cobrowseApi.onSessionStarted.add(notifyCobrowseStarted);
</source>

====onSessionEnded====
This signal is dispatched when a Co-browse session ends.

Arguments:

*<tt>details</tt>—Object with the follwing field:
**<tt>reason</tt>—Field with value of a string or undefined. Possible string values:
***<tt>self</tt>—The user has exited the session by clicking the <tt>Exit</tt> button or calling the <tt>exitSession()</tt> API method.
***<tt>external</tt>—The agent has closed the session. Some server errors may also result in this value.
***<tt>timeout</tt>—The session has timed out such as when a user reopens a page with an expired Co-browse cookie.
***<tt>intactivityTimeout</tt>—The agent did not join a session in the configured amount of time.
***<tt>serverUnavailable</tt>—The Co-browse server was unreachable.
***<tt>sessionsOverLimit</tt>—Agent is busy with another co-browse session and is prohibited from starting another session at the same time.
***<tt>error</tt>—There is an error such as a critical misconfiguration.

Example:

<source lang="javascript">
var cbEndedMessages = {
self: 'You exited Co-browse session. Co-browse terminated',
external: 'Co-browse session ended',
timeout: 'Co-browse session timed out',
inactivityTimeout: 'Agent did not join. Closing Co-browse session.',
serverUnavailable: 'Could not reach Co-browse server',
sessionsOverLimit: 'Agent is busy in another Co-browse session'
}
cobrowseApi.onSessionEnded.add(function(details) {
alert(cbEndedMessages[details.reason] {{!}} {{!}} 'Something went wrong. Co-browse terminated.');
showCobrowseButton();
});
</source>

====markServiceElement(element)====
'''Service''' elements do not show up in the agent's view. This function is used to mark service elements in a custom Co-browse UI.

Arguments:

*<tt>element</tt>—HTML element that will be masked.

{{NoteFormat|Elements must be marked as '''service''' elements '''before''' the Co-browse session begins. If the Co-browse session has already started, '''service''' elements should be marked before they are added to the DOM.

It is also possible to mark elements as '''service''' without using this function. Doing so is useful for static HTML content. To do so, add an attribute <tt>data-gcb-service-node</tt> with value <tt>true</tt>. }}

{{NoteFormat|The <tt>markServiceElement()</tt> method should not be used to hide sensitive information. Business functions like DOM Control and Data Masking should be used for sensitive content such as private user data.}}

Example:

<source lang="javascript">
function createCustomCobrowseUI(cobrowseApi) {
var toolbar = document.createElement('div');
toolbar.className = 'cobrowseToolbar';
toolbar.textContent = 'Co-browse is going on';
cobrowseApi.markServiceElement(toolbar); // don't show the toolbar to agents
cobrowseApi.onConnected.add(function() {
document.body.appendChild(toolbar);
})
}
</source>

Static content example, without JS API usage:

<source lang="javascript">
<div id="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-origID="myChatWidget" data-gcb-service-node="true">...</div>
</source>

====onMaskedElement====
This signal is dispatched when Co-browse encounters an element that is subject to data masking.

Arguments:

*<tt>element</tt>—HTML Element

This signal is dispatched multiple times when Co-browse initiates and can be dispatched again if a masked element is added to the page dynamically.

Example:

<source lang="javascript">
cobrowseApi.onMaskedElement.add(function(element) {
element.title = 'Content of this elements is masked for representatives.';
});
</source>

===Top Context API===
The following methods and properties are available only when Co-browse is rendered in the '''top''' context.

====isBrowserSupported()====

This method checks for the presence of MutationObserver and a few other required APIs, not for browser type and version. It returns <tt>true</tt> when the browser supports required APIs and <tt>false</tt> otherwise.

====startSession()====
This method instantiates a new Co-browse session. It will throw an error if the browser is not supported.

====exitSession()====
This method exits and ends an ongoing Co-browse session.

====downgradeMode()====
This method immediately switches the current session from {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseSessions|anchor=Participatinginaco-browsesession|display text=Write Mode to Pointer Mode}}. The built-in Co-browse UI executes this method when an end user clicks "Revoke Control" while in Write Mode.

See related signals: {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=omur|display text=onModeUpgradeRequested}} and {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=omc|display text=onModeChanged}}.

====onInitialized====
This signal is dispatched after the page is loaded and the Co-browse business logic is initialized.

Arguments:

*<tt>session</tt>— {{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=sessobj|display text=Session object}} representing the ongoing session or <tt>null</tt> if there is no ongoing session.

Example:

<source lang="javascript">
cobrowseApi.onInitialized.add(function(session) {
if (!session) {
showCobrowseButton();
} else {
showCobrowseToolbar(session);
}
})
</source>

====onAgentJoined====
This signal is dispatched when an agent successfully joins a session.

Arguments:

*<tt>agent</tt>—Object representing the new agent. This object has no properties.
*<tt>session</tt>—{{Link-SomewhereInThisVersion|manual=Developer|topic=GCBCobrowseJavaScriptAPI|anchor=sessobj|display text=Session <tt>object</tt>}} representing the ongoing session.

Example:

<source lang="javascript">
cobrowseApi.onAgentJoined.add(function(agent, session) {
alert('Representative has joined the session');
});
</source>

====onAgentNavigated====
This signal is dispatched when the agent initiates navigation such as refresh, back, forward, or enters a URL into the agent Co-browse UI. Signal is dispatched a few seconds before the navigation happens. This can be used, for example, to send a warning to the user or disable the <tt>Exit session</tt> button before navigation.

Arguments:

*<tt>details</tt>—Object containing the following navigation detail fields:
**<tt>command</tt>—String with the value of <tt>back</tt>, <tt>refresh</tt>, <tt>forward</tt>, or <tt>url</tt>.
**<tt>url</tt>—Optional string that is present only if the <tt>command</tt> field has the value of <tt>url</tt>.

Example:

<source lang="javascript">
cobrowseApi.onAgentNavigated.add(function(details) {
if (details.url) {
alert('Representative has navigated to the page: ' + details.url);
} else {
alert('Representative has pressed the "' + details.command + '" button. Page will be refreshed');
}
});
</source>

====onNavigationFailed====
This signal is dispatched when the navigation request from the agent fails to execute such as when the agent navigates forward when there is no forward history. You can use this signal to to re-enable the <tt>Exit</tt> button and/or show a notification.

The callback receives no arguments.

Example:

<source lang="javascript">
cobrowseApi.onNavigationFailed.add(function() {
alert('Navigation request by representative has failed');
});
</source>
{{AnchorDiv|omur}}

====onModeUpgradeRequested====
This signal is dispatched when an agent requests upgrading the Co-browse session to Write Mode.

Arguments:

*<tt>done</tt>—The function passed by the Co-browse code. Call it with <tt>true</tt> to allow the transition to Write Mode, or with <tt>false</tt> to prohibit.

Example:
<source lang="javascript">
cobrowseApi.onModeUpgradeRequested.add(function(done) {
if (confirm('Representative requests control over the web page. Allow?') {
done(true); // allow upgrading to Write Mode
} else {
done(false); // disallow and stay in Pointer Mode
}
});
</source>

{{AnchorDiv|omc}}

====onModeChanged====
This signal is dispatched when the Co-browse session Mode changes, either to Pointer or Write.

Arguments:

*<tt>mode</tt>—An object with two boolean properties:
**<tt>pointer</tt>—This is <tt>true</tt> if the session has switched from Write to Pointer Mode. Otherwise, it's <tt>false</tt>.
**<tt>write</tt>—This is <tt>true</tt> when the session has switched from Pointer to Write Mode.

Example:
<source lang="javascript">
cobrowseApi.onModeChanged.add(function(mode) {
if (mode.write) {
alert("Representative has now control over the page");
} else if (mode.pointer) {
alert("Representative can no longer control the page").
}
});
</source>

{{AnchorDiv|icbwc}}
|Status=No
}}{{Section
|sectionHeading=Integrating Co-browse with Chat
|anchor=IntegratingCo-browsewithChat
|alignment=Vertical
|structuredtext=External chat can be connected to Co-browse via an adapter object assigned to the <tt>_genesys.cobrowse.primaryMedia</tt> option. Such object may implement the following methods:

===initializeAsync(done)===
Use this only if your chat initializes asynchronously and you cannot be sure it is ready before Co-browse.

If the <tt>initializeAsync</tt> method is implemented, the Co-browse JavaScript will call the method and pass it a done callback. You must call the done callback when your media finishes initialization.

<source lang="javascript">
var myChatAdapter = {
initializeAsync: function(done) {
waitForChatInitialization(function() {
// tell Co-browse chat is now ready
done();
});
}
};
</source>

===sendCbSessionToken(token)===
Co-browse will use it to pass the session token to the agent. The Co-browse session token is a string consisting of nine digits.

Example:

<source lang="javascript">
myChatAdapter = {
sendCbSessionToken: function(sessionToken) {
myChat.sendMessage('User has started Co-browse session: ' + sessionToken);
}
};
</source>

If you use Genesys Agent Desktop, wrap the Co-browse token in a <tt>{start:<TOKEN>}</tt>, then the agent will join a Co-browse session as soon as he or she receives the token.

<source lang="javascript">
// For example:
myChatAdapter.sendCbSessionToken = function(token) {
myChat.sendMessage('{start:' + token + '}');
};
</source>

===isAgentConnected()===

This method must return a <tt>true</tt> or <tt>false</tt>.

Co-browse calls this method before calling the <tt>sendCbSessionToken</tt>. If <tt>isAgentConnected</tt> returns <tt>true</tt>, Co-browse will call the <tt>sendCbSessionToken</tt> method. If <tt>isAgentConnected</tt> returns <tt>false</tt>, the user will be asked to connect with an agent via phone before starting Co-browse. If the method is absent, the user will be asked to connect with an agent via phone or chat before starting Co-browse.
|Status=No
}}
}}

File:GCB CallUsWidget Dialog.png

2020-06-01T22:17:03Z

Llannoye:

File:GCB CallUsWidget CB Option.png

2020-06-01T22:04:11Z

Llannoye:

File:GCB New Start ChannelSelectorWidget.png

2020-06-01T22:03:26Z

Llannoye:

File:GCB Cust Agent View WebChatWidget.png

2020-06-01T22:02:22Z

Llannoye:

File:GCB StartCobrowse5.png

2020-06-01T21:26:09Z

Llannoye:

File:GCB Stop Cobrowse1.png

2020-06-01T20:55:36Z

Llannoye:

File:GCB90Data masking agent customer.png

2020-06-01T20:46:19Z

Llannoye:

Draft:PEC-COB

2020-06-01T19:22:59Z

Llannoye:

{{MintyDocsProduct
|WithTabber=
|UserFunctions=
|displayname=Co-Browse
|contentarea=PureEngage
|landingpage=No
|definition=Co-browse lets your agents view and control your customers' browser windows.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Get Started
|Title=How it Works
|Description=
|Links=[[draft:PEC-COB/HIW|How Co-browse works]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Platform=PureEngage
|Type=Release Notes
|Title=
|Description=
|Links=[https://docs.genesys.com/Documentation/PSAAS/Public/RN/Cobrowse Co-browse Release Notes]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Get Started
|Title=
|Description=
|Links=*[[Draft:PEC-COB/Current/Developer/GCB|Get started with Co-browse]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Agent Features
|Title=
|Description=
|Links=[[Draft:PEC-AD/Current/Agent/ADcobrow|Co-browse sessions]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Developer Resources
|Title=
|Description=
|Links=[[Draft:PEC-COB/Current/Developer|Administrator's Guide]]<br />
|Columns=No
}}
}}

Draft:PEC-COB

2020-06-01T19:17:06Z

Llannoye:

{{MintyDocsProduct
|WithTabber=
|UserFunctions=
|displayname=Co-Browse
|contentarea=PureEngage
|landingpage=No
|definition=Co-browse lets your agents view and control your customers' browser windows.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Get Started
|Title=How it Works
|Description=
|Links=[[draft:PEC-COB/HIW|How Co-browse works]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Platform=PureEngage
|Type=Release Notes
|Title=
|Description=
|Links=[https://docs.genesys.com/Documentation/PSAAS/Public/RN/Cobrowse Co-browse Release Notes]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Get Started
|Title=
|Description=
|Links=*[[Draft:PEC-COB/Current/Developer/GCB|Get started with Co-browse]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Agent Features
|Title=
|Description=
|Links=[[Draft:PEC-AD/Current/Agent/ADcobrow|Co-browse sessions]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Developer Resources
|Title=
|Description=
|Links=*[[Draft:PEC-COB/Current/Developer|Administrator's Guide]]
*[https://docs.genesys.com/Documentation/PSAAS/Closed/Administrator/GCBCobrowseRealtimeAPI Realtime API (Restricted - login required)]
|Columns=No
}}
}}

Draft:PEC-COB

2020-06-01T19:14:31Z

Llannoye:

{{MintyDocsProduct
|WithTabber=
|UserFunctions=
|displayname=Co-Browse
|contentarea=PureEngage
|landingpage=No
|definition=Co-browse lets your agents view and control your customers' browser windows.
|ComingSoon=No
|MintyDocsProductLandingSections={{MintyDocsProductLandingSections
|Type=Get Started
|Title=How it Works
|Description=
|Links=[[draft:PEC-COB/HIW|How Co-browse works]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Platform=PureEngage
|Type=Release Notes
|Title=
|Description=
|Links=[https://docs.genesys.com/Documentation/PSAAS/Public/RN/Cobrowse Co-browse Release Notes]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Get Started
|Title=
|Description=
|Links=*[[Draft:PEC-COB/Current/Developer/GCB|Get started with Co-browse]]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Developer Resources
|Title=
|Description=
|Links=*[[Draft:PEC-COB/Current/Developer|Administrator's Guide]]
*[https://docs.genesys.com/Documentation/PSAAS/Closed/Administrator/GCBCobrowseRealtimeAPI Realtime API (Restricted - login required)]
|Columns=No
}}{{MintyDocsProductLandingSections
|Type=Agent Features
|Title=
|Description=
|Links=[[Draft:PEC-AD/Current/Agent/ADcobrow|Co-browse sessions]]
|Columns=No
}}
}}