• 5.19 • 5.3 • 5.8

<translate>

General Information About the 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

The Out-page JS API supports the following types of methods:

Agent State methods are used to request an agent's state and interaction information, as well as to change an agent's state.

• getState
• setStatus

Dialing and Transfer methods are used for dialing phone numbers and transferring calls.

• dialNumber
• selectService
• singleStepTransfer
• singleStepConference

Completing and Terminating an Interaction methods are used for completing and terminating interactions.

• setDisposition
• terminateInteraction
• completeInteraction
• completeInteractionWithDisp

Call Recordings Control methods are used for controlling call recordings and getting the status of call recordings.

• muteCallRecordings()
• unmuteCallRecordings()
• getCallRecordingStatus(callback)
• startCallRecording(callback)
• stopCallRecording(callback)
• muteCallRecording(callback)
• unmuteCallRecording(callback)

Supported Events

Agent Login events are used for showing whether an agent is logged in or out of Agent Desktop.

• onAgentLogin(callback)

Agent Status events are used for retrieving an agent's state and reason.

• onStatusChange(callback)

Call Flow events are used for getting information about active interactions and completed interactions.

• addInteractionRenderedHandler(callback)
• addInteractionCompletedHandler(callback)

Syntax

The syntax for all the methods and events in this specification includes the object window.bpspat.api. This object is created when the script file is included in an external webpage as shown:

<script type="text/javascript" src="https://YOUR_AGENT_DESKTOP_WEB_SERVER/agentdesktop/app/lib/servicepattern-sdk-v1.js"></script>

Note that in the script source, you replace YOUR_AGENT_DESKTOP_WEB_SERVER with your actual web server.

</translate>

< Previous | Next >