From Bright Pattern Documentation
(Created page with "<translate> = completeInteractionWithDisp = Completes and dispositions the interaction. == Request == === Syntax === window.bpspat.api.completeInteractionWithDisp(item_id, d...") |
(Updated via BpDeleteTranslateTags script) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= completeInteractionWithDisp = | = completeInteractionWithDisp = | ||
| − | Completes and dispositions the interaction. | + | Completes and dispositions the interaction using the interaction ID and disposition code. |
| + | |||
| + | See the Embedded Agent Desktop Specification's [[Embedded-agent-desktop-sdk-specification/UseCases/EndDispositionComplete | Use Cases]] section for ways to use this method. | ||
== Request == | == Request == | ||
=== Syntax === | === Syntax === | ||
| − | window.bpspat.api.completeInteractionWithDisp(item_id, | + | window.bpspat.api.completeInteractionWithDisp(item_id, disposition_code, notes) |
=== Parameters === | === Parameters === | ||
| Line 13: | Line 15: | ||
| '''Optional/Required''' | | '''Optional/Required''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
|- | |- | ||
| item_id | | item_id | ||
| string | | string | ||
| required | | required | ||
| − | | | + | | The interaction ID of the interaction |
| + | | "EE55D97E-2705-49D1-A36D-34B3381DD416" | ||
|- | |- | ||
| − | | | + | | disposition_code |
| string | | string | ||
| required | | required | ||
| − | | | + | | The disposition code to be set for the interaction |
| + | | "12345" | ||
|- | |- | ||
| notes | | notes | ||
| string | | string | ||
| optional | | optional | ||
| − | | | + | | Free-form text notes to be added to the completed interaction |
| + | | "Repeat customer, third call today" | ||
|} | |} | ||
== Response == | == Response == | ||
| − | Empty. | + | Empty. In response to the request, the disposition to changed to the specified disposition. |
| − | |||
| − | In response to the request, the disposition to changed to the specified disposition. | ||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
completeInteractionWithDisp
Completes and dispositions the interaction using the interaction ID and disposition code.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.completeInteractionWithDisp(item_id, disposition_code, notes)
Parameters
| Parameter | Type | Optional/Required | Description | Example |
| item_id | string | required | The interaction ID of the interaction | "EE55D97E-2705-49D1-A36D-34B3381DD416" |
| disposition_code | string | required | The disposition code to be set for the interaction | "12345" |
| notes | string | optional | Free-form text notes to be added to the completed interaction | "Repeat customer, third call today" |
Response
Empty. In response to the request, the disposition to changed to the specified disposition.