From Bright Pattern Documentation
< 5.3:Embedded-agent-desktop-api-specification‎ | Methods
Revision as of 04:09, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.3 • 5.8


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.

< Previous | Next >