From Bright Pattern Documentation
Jump to: navigation, search
(Updated via BpDeleteTranslateTags script)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
<translate>
 
= Completing and Terminating an Interaction =
 
This method is used for completing and terminating interactions. There are four types of requests.
 
  
== Requests ==
+
= setDisposition =
=== Set Disposition ===
+
Sets the disposition of the interaction.
Sets the disposition of the interaction
 
  
==== Syntax ====
+
== Request ==
 +
=== Syntax ===
 
  window.bpspat.api.setDisposition(item_id, disposition)
 
  window.bpspat.api.setDisposition(item_id, disposition)
  
==== Parameters ====
+
=== Parameters ===
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Parameter'''
 
| '''Parameter'''
Line 28: Line 25:
 
|}
 
|}
  
 +
== Response ==
 +
Empty.
  
=== Terminate Interaction ===
+
In response to the request, the disposition to changed to the specified disposition.
Terminates the interaction.
 
 
 
==== Syntax ====
 
window.bpspat.api.terminateInteraction(item_id)
 
 
 
==== Parameters ====
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Parameter'''
 
| '''Type'''
 
| '''Optional/Required'''
 
| '''Description'''
 
|-
 
| item_id
 
| string
 
| required
 
| Specifies the interaction ID of the interaction
 
|}
 
 
 
 
 
=== Complete Interaction ===
 
Completes the interaction in after-call work.
 
 
 
==== Syntax ====
 
window.bpspat.api.completeInteraction(item_id)
 
 
 
==== Parameters ====
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Parameter'''
 
| '''Type'''
 
| '''Optional/Required'''
 
| '''Description'''
 
|-
 
| item_id
 
| string
 
| required
 
| Specifies the interaction ID of the interaction
 
|}
 
 
 
 
 
=== Complete Interaction with Disposition ===
 
Completes and dispositions the interaction.
 
 
 
==== Syntax ====
 
window.bpspat.api.completeInteractionWithDisp(item_id, disposition, notes)
 
 
 
==== Parameters ====
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Parameter'''
 
| '''Type'''
 
| '''Optional/Required'''
 
| '''Description'''
 
|-
 
| item_id
 
| string
 
| required
 
| Specifies the interaction ID of the interaction
 
|-
 
| disposition
 
| string
 
| required
 
| Specifies the disposition to be set for the interaction
 
|-
 
| notes
 
| string
 
| optional
 
|Specifies notes to be added to the completed interaction
 
|}
 
 
 
 
 
 
 
</translate>
 

Latest revision as of 04:02, 29 May 2024

• 5.19 • 5.3 • 5.8


setDisposition

Sets the disposition of the interaction.

Request

Syntax

window.bpspat.api.setDisposition(item_id, disposition)

Parameters

Parameter Type Optional/Required Description
item_id string required Specifies the interaction ID of the interaction
disposition string required Specifies the disposition to be set for the interaction

Response

Empty.

In response to the request, the disposition to changed to the specified disposition.

< Previous | Next >