5.19:Embedded-agent-desktop-sdk-specification/UseCases/CompleteInteractionDisposition

• 5.19 • 5.3 • 5.8

<translate>

Complete and Disposition an Interaction

With the completeInteractionWithDisp method, you can accomplish two actions in one step: 1) disposition an interaction, and 2) complete the interaction.

completeInteractionWithDisp is best used with getState and terminateInteraction. getState retrieves agent state information, including the interaction ID that you will need in order to end the interaction. terminateInteraction allows you to end the interaction and place the agent in the after-call work (ACW) state.

The completeInteractionWithDisp method can be attached to a web element, such as a button, on your webpage. When clicked, the button will process the API method.

In this article, you will learn how to:

• Attach getState to a button
• Attach terminateInteraction to a button and item ID to a field
• Attach completeInteractionWithDisp to a button and item ID to a field
• Place sample JavaScript into HTML

Sample Code

In this sample code, the methods are attached to button elements.

Copy this sample code for pasting into your HTML file. This is the bare minimum that you need for the SDK to work. Make sure you replace "<tenant>" with the name of your Agent Desktop web server (e.g., "example.brightpattern.com").

 <script type="text/javascript" src="https://<tenant>.brightpattern.com/agentdesktop/libs/servicepattern-sdk-v1.js"> 
 </script>
 
 <iframe id="repeater" style="position:absolute; right: 8px; width: 300px; height: 700px;" src="https://<tenant>.brightpattern.com/agentdesktop/UniversalRepeater.jsp"></iframe>
 
 <button onclick="bpspat.api.getState(log)">Get State</button>
 <br>
 <br>
 <input id="item" type="text" placeholder="Interaction Id, see Logs"/>
 <input id="disposition" type="text" placeholder="Disposition name"/>
 <input id="notes" type="text" placeholder="Notes"/>
 <br>
 <br>
 <button onclick="bpspat.api.terminateInteraction(document.getElementById('item').value)">Terminate</button>
 <button onclick="bpspat.api.completeInteractionWithDisp(document.getElementById('item').value,(document.getElementById('disposition').value,(document.getElementById('notes').value)">Complete with Disposition</button>
 <br>
 <br>
 <div id="log">Logs...</div>
 <br>
 <br>
 
 <script type="text/javascript">
 window.bpspat.api.init("https://<tenant>.brightpattern.com");
 function log(data) {
 let div = document.createElement("div");
 div.innerHTML = JSON.stringify(data);
 document.getElementById("log").appendChild(div);
 }
 
 </script>

Example Exercise

Of course, there are many ways to style your page elements and Agent Desktop widget display. The following is provided for example purposes only.

1. Paste the sample code into the body of your HTML file.
   
   
2. Save and open the page in your web browser. Make sure the agent is logged in and "Ready."
   
   
3. A call comes in and the agent accepts it.
   
   
   
   
   
   
4. During the call, click Get State, which brings up the agent status log data.
   
   
   
   
   
   
5. Copy the item_ID from the logs, paste it into the Interaction ID field, and click Terminate to end the call. This places the agent in the after-call work state.
   
   
6. Type in a disposition name and notes, if desired. Click Complete with Disposition to complete the call. This places the agent in the Ready state.
   
   
   
   
   
   

</translate>

< Previous