From Bright Pattern Documentation
• 5.2 • 5.3
Contents
- Desktop JavaScript API Specification Introduction
- Purpose
- AudienceAPI Methods
- General Information
- Dial Number
- Select Service
- Single-Step Transfer
- Single-Step Conference
- Terminate Interaction
- Set Notes
- Set Disposition
- Set Disposition By Name
- Post Variable
- Set Reporting Custom Field
- Complete Interaction
- Complete Interaction with Disposition and Notes
- Get Call Recording Status
- Start Call Recording
- Stop Call Recording
- Mute Call Recording
- Unmute Call Recording
- Get Screen Recording Status
- Stop Screen Recording
- Pause Screen Recording
- Resume Screen Recording
- Pause Call and Screen Recording
- Resume Call and Screen Recording
- Callback
General Information
The API supports a number of desktop telephony functions, including call initiation, voice and screen recording, interaction completion, and the setting of interaction dispositions and notes.
These functions are available via a global object called window.bpspat.api.
Example
window.bpspat.api.dialNumber("1234567");
Object Creation
The object is created when the script file is included in the web page loaded into the Agent Desktop application as follows:
<script type="text/javascript" src="[agent-desktop-web-server]/libs/servicepatternapi-dev.js"></script>
or
<script type="text/javascript" src="[agent-desktop-web-server]/agentdesktop/libs/servicepatternapi-dev.js"></script>
Example
<script type="text/javascript" src="https://barco.brightpattern.com/libs/servicepatternapi-dev.js"></script>
or
<script type="text/javascript" src="https://barco.brightpattern.com/agentdesktop/libs/servicepatternapi-dev.js"></script>