From Bright Pattern Documentation
(Created page with "<translate> = setDisposition = Sets the disposition of the interaction. == Request == === Syntax === window.bpspat.api.setDisposition(item_id, disposition) === Parameters =...") |
(Updated via BpDeleteTranslateTags script) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= setDisposition = | = setDisposition = | ||
| − | Sets the disposition of the interaction. | + | Sets the disposition of the interaction using a disposition code. (To set disposition by name, see method [[Embedded-agent-desktop-api-specification/Methods/setDispositionByName | setDispositionByName]]). |
| + | |||
| + | 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.setDisposition(item_id, | + | window.bpspat.api.setDisposition(item_id, disposition_code) |
=== 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" | ||
| + | |- | ||
|} | |} | ||
== Response == | == Response == | ||
| − | Empty. | + | Empty. In response to the request, the disposition is changed to the specified disposition code. |
| − | |||
| − | In response to the request, the disposition | ||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
setDisposition
Sets the disposition of the interaction using a disposition code. (To set disposition by name, see method setDispositionByName).
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)
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" |
Response
Empty. In response to the request, the disposition is changed to the specified disposition code.