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.

window.bpspat.api.setDisposition(item_id, disposition_code)

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"

Empty. In response to the request, the disposition is changed to the specified disposition code.

@@ Line 1: / Line 1: @@
-<translate>
 = setDisposition =
-Sets the disposition of the interaction using either disposition name or disposition code.
+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.
@@ Line 8: / Line 8: @@
 === Syntax ===
   window.bpspat.api.setDisposition(item_id, disposition_code)
-or
- window.bpspat.api.setDispositionByName(item_id, disposition_name)
 === Parameters ===
@@ Line 29: / Line 25: @@
 | disposition_code
 | string
-| required (if using code)
+| required
 | 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.
+Empty. In response to the request, the disposition is changed to the specified disposition code.
-</translate>