From Bright Pattern Documentation
| Line 1: | Line 1: | ||
<translate> | <translate> | ||
= setDisposition = | = setDisposition = | ||
| − | Sets the disposition of the interaction. | + | Sets the disposition of the interaction using either disposition name or 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. | See the Embedded Agent Desktop Specification's [[Embedded-agent-desktop-sdk-specification/UseCases/EndDispositionComplete | Use Cases]] section for ways to use this method. | ||
| Line 7: | Line 7: | ||
== Request == | == Request == | ||
=== Syntax === | === Syntax === | ||
| − | window.bpspat.api.setDisposition(item_id, | + | window.bpspat.api.setDisposition(item_id, disposition_code) |
| + | |||
| + | or | ||
| + | |||
| + | window.bpspat.api.setDispositionByName(item_id, disposition_name) | ||
=== Parameters === | === Parameters === | ||
| Line 15: | Line 19: | ||
| '''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 | ||
| + | | required (if using code) | ||
| + | | The disposition code to be set for the interaction | ||
| + | | "12345" | ||
|- | |- | ||
| − | | | + | | disposition_name |
| string | | string | ||
| − | | required | + | | required (if using name) |
| − | | | + | | The disposition name to be set for the interaction |
| + | | "Offer rejected" | ||
|} | |} | ||
== 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. | ||
</translate> | </translate> | ||
Revision as of 20:26, 27 March 2019
<translate>
setDisposition
Sets the disposition of the interaction using either disposition name or disposition code.
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
window.bpspat.api.setDisposition(item_id, disposition_code)
or
window.bpspat.api.setDispositionByName(item_id, disposition_name)
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 (if using code) | The disposition code to be set for the interaction | "12345" |
| disposition_name | string | required (if using name) | The disposition name to be set for the interaction | "Offer rejected" |
Response
Empty. In response to the request, the disposition to changed to the specified disposition.
</translate>