From Bright Pattern Documentation
(Created page with "<translate> = setDispositionByName = Sets the disposition of the interaction using the disposition name. (To set disposition by code, see method Embedded-agent-desktop-api-s...") |
(Updated via BpDeleteTranslateTags script) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= setDispositionByName = | = setDispositionByName = | ||
Sets the disposition of the interaction using the disposition name. (To set disposition by code, see method [[Embedded-agent-desktop-api-specification/Methods/setDisposition | setDisposition]]). | Sets the disposition of the interaction using the disposition name. (To set disposition by code, see method [[Embedded-agent-desktop-api-specification/Methods/setDisposition | setDisposition]]). | ||
| Line 25: | Line 25: | ||
| disposition_name | | disposition_name | ||
| string | | string | ||
| − | | required | + | | required |
| The disposition name to be set for the interaction | | The disposition name to be set for the interaction | ||
| "Offer rejected" | | "Offer rejected" | ||
| Line 32: | Line 32: | ||
== Response == | == Response == | ||
Empty. In response to the request, the disposition is changed to the specified disposition name. | Empty. In response to the request, the disposition is changed to the specified disposition name. | ||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
setDispositionByName
Sets the disposition of the interaction using the disposition name. (To set disposition by code, see method setDisposition).
See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.
Request
Syntax
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_name | string | required | The disposition name to be set for the interaction | "Offer rejected" |
Response
Empty. In response to the request, the disposition is changed to the specified disposition name.