From Bright Pattern Documentation
| Line 14: | Line 14: | ||
| '''Parameter''' | | '''Parameter''' | ||
| '''Type''' | | '''Type''' | ||
| + | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| + | | required | ||
| Specifies the interaction ID of the interaction | | Specifies the interaction ID of the interaction | ||
|- | |- | ||
| disposition | | disposition | ||
| string | | string | ||
| + | | required | ||
| Specifies the disposition to be set for the interaction | | Specifies the disposition to be set for the interaction | ||
|} | |} | ||
| Line 36: | Line 39: | ||
| '''Parameter''' | | '''Parameter''' | ||
| '''Type''' | | '''Type''' | ||
| + | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| + | | required | ||
| Specifies the interaction ID of the interaction | | Specifies the interaction ID of the interaction | ||
|} | |} | ||
| Line 54: | Line 59: | ||
| '''Parameter''' | | '''Parameter''' | ||
| '''Type''' | | '''Type''' | ||
| + | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| + | | required | ||
| Specifies the interaction ID of the interaction | | Specifies the interaction ID of the interaction | ||
|} | |} | ||
| Line 72: | Line 79: | ||
| '''Parameter''' | | '''Parameter''' | ||
| '''Type''' | | '''Type''' | ||
| + | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| + | | required | ||
| Specifies the interaction ID of the interaction | | Specifies the interaction ID of the interaction | ||
|- | |- | ||
| disposition | | disposition | ||
| string | | string | ||
| + | | required | ||
| Specifies the disposition to be set for the interaction | | Specifies the disposition to be set for the interaction | ||
|- | |- | ||
| notes | | notes | ||
| string | | string | ||
| + | | optional | ||
|Specifies notes to be added to the completed interaction | |Specifies notes to be added to the completed interaction | ||
|} | |} | ||
Revision as of 17:44, 8 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 | 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 |
Terminate Interaction
Terminates the interaction.
Syntax
window.bpspat.api.terminateInteraction(item_id)
Parameters
| 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
| 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
| 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>