From Bright Pattern Documentation
Jump to: navigation, search
(Updated via BpDeleteTranslateTags script)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<translate>
+
 
 
= Purpose =
 
= Purpose =
−
The ''Embedded Agent Desktop SDK Specification'' describes the Bright Pattern Agent Desktop SDK, which incorporates the Bright Pattern Out-page JS API. The SDK supports requests for information about agent states and interactions, as well as control over agent and supervisor login, status, call flow, call recordings, transfers, and outbound dialing. The SDK is available in the latest release of Bright Pattern Contact Center.
+
The ''Embedded Agent Desktop SDK Specification'' describes the Bright Pattern Agent Desktop SDK, which incorporates the Bright Pattern [[Embedded-agent-desktop-api-specification/Purpose |  Embedded Agent Desktop API]].
−
 
 
−
The Out-page JS API is a browser-based JavaScript API that allows a webpage to communicate with the Bright Pattern Agent Desktop application embedded on that page in iframe.
 
  
−
With this API, you can:
+
The SDK supports requests for information about agent states and interactions, as well as control over agent and supervisor login, status, call flow, call recordings, transfers, and outbound dialing. The SDK is available in the latest release of Bright Pattern Contact Center.
−
* Request information about agent states and interactions
 
−
* Request agent routing state change
 
−
* Dial numbers
 
−
* Transfer calls
 
−
* Complete interactions
 
−
* Terminate interactions
 
−
* Control call recordings
 
−
* Request information about agent login, status, and call flow
 
  
−
== Supported Methods and Events ==
+
== Try It Now ==
−
=== [[Embedded-agent-desktop-sdk-specification/Methods/Overview |  Methods]] ===
+
You can give the SDK a spin by copying the following URL into your web browser's address field and replacing the placeholder "corp" with the name of your Bright Pattern Contact Center instance:
−
Agent State
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/getState | getState]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/setStatus | setStatus]]
 
−
Dialing and Transfers
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/dialNumber | dialNumber]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/selectService | selectService]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/singleStepTransfer | singleStepTransfer]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/singleStepConference | singleStepConference]]
 
−
Completing and Terminating an Interaction
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/setDisposition |  setDisposition]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/terminateInteraction |  terminateInteraction]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/completeInteraction |  completeInteraction]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/completeInteractionWithDisp |  completeInteractionWithDisp]]
 
−
Call Recordings Control
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/muteCallRecordings |  muteCallRecordings()]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/unmuteCallRecordings |  unmuteCallRecordings()]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/getCallRecordingStatusCallback |  getCallRecordingStatus(callback)]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/startCallRecordingCallback |  startCallRecording(callback)]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/stopCallRecordingCallback |  stopCallRecording(callback)]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/muteCallRecordingCallback |  muteCallRecording(callback)]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Methods/unmuteCallRecordingCallback |  unmuteCallRecording(callback)]]
 
  
−
=== [[Embedded-agent-desktop-sdk-specification/Events/Overview | Events]] ===
+
  https://corp.brightpattern.com/agentdesktop/AgentDesktopSdkTest.jsp
−
Agent Login
 
−
* [[Embedded-agent-desktop-sdk-specification/Events/onAgentLoginCallback| onAgentLogin(callback)]]
 
−
Agent Status
 
−
* [[Embedded-agent-desktop-sdk-specification/Events/onStatusChangeCallback| onStatusChange(callback)]]
 
−
Call Flow
 
−
* [[Embedded-agent-desktop-sdk-specification/Events/AddInteractionRenderedHandlerCallback |  addInteractionRenderedHandler(callback)]]
 
−
* [[Embedded-agent-desktop-sdk-specification/Events/AddInteractionCompletedHandlerCallback |  addInteractionCompletedHandler(callback)]]
 
  
 +
Then log in to Agent Desktop and click '''Get State''' to get started.
  
 +
See also the [[AgentDesktop-client-side-javascript-api-specification/APIMethods | next generation version of the API]].
  
  
−
</translate>
+
[[File:ControlRecord1b-53.png|800px|center]]

Latest revision as of 04:02, 29 May 2024

• 5.19 • 5.3 • 5.8


Purpose

The Embedded Agent Desktop SDK Specification describes the Bright Pattern Agent Desktop SDK, which incorporates the Bright Pattern Embedded Agent Desktop API.

The SDK supports requests for information about agent states and interactions, as well as control over agent and supervisor login, status, call flow, call recordings, transfers, and outbound dialing. The SDK is available in the latest release of Bright Pattern Contact Center.

Try It Now

You can give the SDK a spin by copying the following URL into your web browser's address field and replacing the placeholder "corp" with the name of your Bright Pattern Contact Center instance: 

https://corp.brightpattern.com/agentdesktop/AgentDesktopSdkTest.jsp

Then log in to Agent Desktop and click Get State to get started.

See also the next generation version of the API.


ControlRecord1b-53.png
Next >
Retrieved from "https://help.brightpattern.com/index.php?title=5.19:Embedded-agent-desktop-sdk-specification/Purpose&oldid=145169"