From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "<translate> = Overview = There are many ways to call the JS Outpage API methods and events from Bright Pattern's embedded Agent Desktop widget. See the Embedded-agent-deskto...")
 
(Updated via BpDeleteTranslateTags script)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<translate>
+
 
 
= Overview =
 
= Overview =
There are many ways to call the JS Outpage API methods and events from Bright Pattern's embedded Agent Desktop widget. See the [[Embedded-agent-desktop-sdk-specification/ExampleSDK/Sample_Code |  SDK Sample Code]] section of this guide for an example of how you can attach methods and events to HTML elements.
+
There are many ways to call the Embedded Agent Desktop API methods and events. This section provides [[Embedded-agent-desktop-sdk-specification/ExampleSDK/Sample_Code |  SDK sample code]], which embeds the Agent Desktop widget on a basic webpage and attaches all the methods and events of the Embedded Agent Desktop API to web elements.
 
 
For more information, please see the API Reference and Use Cases sections of this guide:
 
* [[Embedded-agent-desktop-sdk-specification/Methods/Overview |  Methods]]
 
 
 
* [[Embedded-agent-desktop-sdk-specification/Events/Overview |  Events]]
 
  
* [[Embedded-agent-desktop-sdk-specification/UseCases/Overview |  Use Cases]]
+
See the [[Embedded-agent-desktop-sdk-specification/UseCases/Overview |  Use Cases]] section of this guide for more ways to use the SDK.
  
 +
== Embedding Agent Desktop ==
 +
The Embedded Agent Desktop widget incorporates the Embedded Agent Desktop API, a browser-based JavaScript API that allows a webpage to communicate with the Bright Pattern Agent Desktop application embedded on that page in iframe. Iframe (Inline Frame) is an HTML element that is used to insert interactive content from a different source onto a website.
  
 +
Some domains do not allow content from other sources to be embedded using iframe, and you will experience errors when trying to embed Agent Desktop.
  
 +
If this occurs, please contact your service provider to enable a domain for your contact center.
  
</translate>
+
'''Note''': It is possible for service providers to [[Rebranding-guide/SoftwareRebrandingInstructions|rebrand the Embedded Agent Desktop widget]]. For more information, see the ''Rebranding Guide''.

Latest revision as of 04:02, 29 May 2024

• 5.19 • 5.3 • 5.8


Overview

There are many ways to call the Embedded Agent Desktop API methods and events. This section provides SDK sample code, which embeds the Agent Desktop widget on a basic webpage and attaches all the methods and events of the Embedded Agent Desktop API to web elements.

See the Use Cases section of this guide for more ways to use the SDK.

Embedding Agent Desktop

The Embedded Agent Desktop widget incorporates the Embedded Agent Desktop API, a browser-based JavaScript API that allows a webpage to communicate with the Bright Pattern Agent Desktop application embedded on that page in iframe. Iframe (Inline Frame) is an HTML element that is used to insert interactive content from a different source onto a website.

Some domains do not allow content from other sources to be embedded using iframe, and you will experience errors when trying to embed Agent Desktop.

If this occurs, please contact your service provider to enable a domain for your contact center.

Note: It is possible for service providers to rebrand the Embedded Agent Desktop widget. For more information, see the Rebranding Guide.

< Previous | Next >