From Bright Pattern Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<translate>
 
<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 Out-page JS 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:
 
* 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 ==
 
=== [[Embedded-agent-desktop-sdk-specification/Methods/Overview |  Methods]] ===
 
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]] ===
 
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)]]
 
  
 +
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.
  
  
  
 
</translate>
 
</translate>

Revision as of 23:37, 25 February 2019

• 5.19 • 5.3 • 5.8

<translate>

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.


</translate>

Next >