From Bright Pattern Documentation
(Created page with "<translate> = Completing and Terminating an Interaction = This method is used for completing and terminating interactions. There are four types of requests. == Requests == ==...") |
|||
| Line 4: | Line 4: | ||
== Requests == | == Requests == | ||
| − | === Set Disposition === | + | === Set Disposition === |
| + | Sets the disposition of the interaction | ||
| + | |||
| + | ==== Syntax ==== | ||
window.bpspat.api.setDisposition(item_id, disposition) | window.bpspat.api.setDisposition(item_id, disposition) | ||
| + | |||
| + | ==== Parameters ==== | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | | item_id | ||
| + | | string | ||
| + | | Specifies the interaction ID of the interaction | ||
| + | |- | ||
| + | | disposition | ||
| + | | string | ||
| + | | Specifies the disposition to be set for the interaction | ||
| + | |} | ||
| + | |||
=== Terminate Interaction === | === Terminate Interaction === | ||
| + | Terminates the interaction. | ||
| + | |||
| + | ==== Syntax ==== | ||
window.bpspat.api.terminateInteraction(item_id) | window.bpspat.api.terminateInteraction(item_id) | ||
| + | |||
| + | ==== Parameters ==== | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | | item_id | ||
| + | | string | ||
| + | | Specifies the interaction ID of the interaction | ||
| + | |} | ||
| + | |||
=== Complete Interaction === | === Complete Interaction === | ||
| + | Completes the interaction in after-call work. | ||
| + | |||
| + | ==== Syntax ==== | ||
window.bpspat.api.completeInteraction(item_id) | window.bpspat.api.completeInteraction(item_id) | ||
| + | |||
| + | ==== Parameters ==== | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | | item_id | ||
| + | | string | ||
| + | | Specifies the interaction ID of the interaction | ||
| + | |} | ||
| + | |||
=== Complete Interaction with Disposition === | === Complete Interaction with Disposition === | ||
| + | Completes and dispositions the interaction. | ||
| + | |||
| + | ==== Syntax ==== | ||
window.bpspat.api.completeInteractionWithDisp(item_id, disposition, notes) | window.bpspat.api.completeInteractionWithDisp(item_id, disposition, notes) | ||
| + | |||
| + | === Parameters === | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | | item_id | ||
| + | | string | ||
| + | | Specifies the interaction ID of the interaction | ||
| + | |- | ||
| + | | disposition | ||
| + | | string | ||
| + | | Specifies the disposition to be set for the interaction | ||
| + | |- | ||
| + | | notes | ||
| + | | string | ||
| + | |Specifies notes to be added to the completed interaction | ||
| + | |} | ||
</translate> | </translate> | ||
Revision as of 18:59, 4 October 2018
<translate>
Completing and Terminating an Interaction
This method is used for completing and terminating interactions. There are four types of requests.
Requests
Set Disposition
Sets the disposition of the interaction
Syntax
window.bpspat.api.setDisposition(item_id, disposition)
Parameters
| Parameter | Type | Description |
| item_id | string | Specifies the interaction ID of the interaction |
| disposition | string | Specifies the disposition to be set for the interaction |
Terminate Interaction
Terminates the interaction.
Syntax
window.bpspat.api.terminateInteraction(item_id)
Parameters
| Parameter | Type | Description |
| item_id | string | Specifies the interaction ID of the interaction |
Complete Interaction
Completes the interaction in after-call work.
Syntax
window.bpspat.api.completeInteraction(item_id)
Parameters
| Parameter | Type | Description |
| item_id | string | 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
| Parameter | Type | Description |
| item_id | string | Specifies the interaction ID of the interaction |
| disposition | string | Specifies the disposition to be set for the interaction |
| notes | string | Specifies notes to be added to the completed interaction |
</translate>