Properties Optional auto Wrapup auto Wrapup ?: default
Optional state state ?: MachineSnapshot < TaskContext , TaskEventPayload , Record < string , AnyActorRef > , IDLE | OFFERED | CONNECTED | HOLD_INITIATING | HELD | RESUME_INITIATING | CONSULT_INITIATING | CONSULTING | CONF_INITIATING | CONFERENCING | WRAPPING_UP | COMPLETED | TERMINATED , string , {} , MetaObject , { context : TaskContext ; id : string ; initial : TaskState ; on : { CONTACT_OWNER_CHANGED : { actions : string [] ; } ; CONTACT_UPDATED : { actions : string [] ; } ; HYDRATE : { actions : string [] ; } ; RECORDING_STARTED : { actions : string [] ; } ; } ; states : { COMPLETED : { entry : string [] ; type : "final" ; } ; CONFERENCING : { on : { CONFERENCE_END : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONFERENCE_START : { actions : string [] ; } ; CONSULT : { actions : string [] ; target : TaskState ; } ; CONSULT_END : { actions : string [] ; } ; CONTACT_ENDED : { actions : string [] ; } [] ; EXIT_CONFERENCE_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_SUCCESS : { actions : string [] ; } ; PARTICIPANT_LEAVE : ( { actions : string [] ; guard : ( ( params ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; TRANSFER_CONFERENCE : { actions : string [] ; } ; TRANSFER_CONFERENCE_FAILED : { actions : string [] ; } ; TRANSFER_CONFERENCE_SUCCESS : { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; } [] ; UNHOLD_SUCCESS : { actions : string [] ; } ; } ; } ; CONF_INITIATING : { on : { CONFERENCE_FAILED : { actions : string [] ; target : TaskState ; } ; CONFERENCE_START : { actions : string [] ; target : TaskState ; } ; } ; } ; CONNECTED : { on : { ASSIGN : { actions : string [] ; target : TaskState ; } ; CONSULT : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_INITIATED : { target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; PAUSE_RECORDING : { actions : string [] ; } ; RESUME_RECORDING : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; } ; } ; CONSULTING : { on : { ASSIGN : { actions : string [] ; target : TaskState ; } ; CONFERENCE_START : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; } ; CONSULT_END : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONTACT_ENDED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; } ; MERGE_TO_CONFERENCE : { target : TaskState ; } ; SWITCH_TO_CONSULT : { actions : string [] ; } ; SWITCH_TO_MAIN_CALL : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_CONFERENCE : { actions : string [] ; } ; TRANSFER_CONFERENCE_FAILED : { actions : string [] ; } ; TRANSFER_CONFERENCE_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target ?: undefined ; } | { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; UNHOLD_SUCCESS : { actions : string [] ; } ; } ; } ; CONSULT_INITIATING : { on : { CONSULT_FAILED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONSULT_SUCCESS : { actions : string [] ; target : TaskState ; } ; CTQ_CANCEL : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_FAILED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; } ; } ; } ; HELD : { on : { CONSULT : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; UNHOLD_INITIATED : { target : TaskState ; } ; UNHOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; HOLD_INITIATING : { on : { HOLD_FAILED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; IDLE : { on : { CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } ; HYDRATE : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; TASK_INCOMING : { actions : string [] ; target : TaskState ; } ; } ; } ; OFFERED : { on : { ASSIGN : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; ASSIGN_FAILED : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } [] ; CONSULT_END : { actions : string [] ; target : TaskState ; } ; CONSULT_FAILED : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : { actions : string [] ; target : TaskState ; } ; INVITE_FAILED : { actions : string [] ; target : TaskState ; } ; OFFER_CONSULT : { actions : string [] ; } ; OUTBOUND_FAILED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; RONA : { actions : string [] ; target : TaskState ; } ; TASK_OFFERED : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; } ; } ; RESUME_INITIATING : { on : { UNHOLD_FAILED : { target : TaskState ; } ; UNHOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; TERMINATED : { entry : string [] ; type : "final" ; } ; WRAPPING_UP : { entry : string [] ; on : { WRAPUP_COMPLETE : { actions : string [] ; target : TaskState ; } ; } ; } ; } ; } >
Optional state Machine Service state Machine Service ?: ActorRef < MachineSnapshot < TaskContext , TaskEventPayload , Record < string , AnyActorRef > , IDLE | OFFERED | CONNECTED | HOLD_INITIATING | HELD | RESUME_INITIATING | CONSULT_INITIATING | CONSULTING | CONF_INITIATING | CONFERENCING | WRAPPING_UP | COMPLETED | TERMINATED , string , {} , MetaObject , { context : TaskContext ; id : string ; initial : TaskState ; on : { CONTACT_OWNER_CHANGED : { actions : string [] ; } ; CONTACT_UPDATED : { actions : string [] ; } ; HYDRATE : { actions : string [] ; } ; RECORDING_STARTED : { actions : string [] ; } ; } ; states : { COMPLETED : { entry : string [] ; type : "final" ; } ; CONFERENCING : { on : { CONFERENCE_END : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONFERENCE_START : { actions : string [] ; } ; CONSULT : { actions : string [] ; target : TaskState ; } ; CONSULT_END : { actions : string [] ; } ; CONTACT_ENDED : { actions : string [] ; } [] ; EXIT_CONFERENCE_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_SUCCESS : { actions : string [] ; } ; PARTICIPANT_LEAVE : ( { actions : string [] ; guard : ( ( params ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; TRANSFER_CONFERENCE : { actions : string [] ; } ; TRANSFER_CONFERENCE_FAILED : { actions : string [] ; } ; TRANSFER_CONFERENCE_SUCCESS : { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; } [] ; UNHOLD_SUCCESS : { actions : string [] ; } ; } ; } ; CONF_INITIATING : { on : { CONFERENCE_FAILED : { actions : string [] ; target : TaskState ; } ; CONFERENCE_START : { actions : string [] ; target : TaskState ; } ; } ; } ; CONNECTED : { on : { ASSIGN : { actions : string [] ; target : TaskState ; } ; CONSULT : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_INITIATED : { target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; PAUSE_RECORDING : { actions : string [] ; } ; RESUME_RECORDING : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; } ; } ; CONSULTING : { on : { ASSIGN : { actions : string [] ; target : TaskState ; } ; CONFERENCE_START : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; } ; CONSULT_END : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONTACT_ENDED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; } ; MERGE_TO_CONFERENCE : { target : TaskState ; } ; SWITCH_TO_CONSULT : { actions : string [] ; } ; SWITCH_TO_MAIN_CALL : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_CONFERENCE : { actions : string [] ; } ; TRANSFER_CONFERENCE_FAILED : { actions : string [] ; } ; TRANSFER_CONFERENCE_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target ?: undefined ; } | { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; UNHOLD_SUCCESS : { actions : string [] ; } ; } ; } ; CONSULT_INITIATING : { on : { CONSULT_FAILED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; CONSULT_SUCCESS : { actions : string [] ; target : TaskState ; } ; CTQ_CANCEL : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; HOLD_FAILED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; } ; } ; } ; HELD : { on : { CONSULT : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; TRANSFER_FAILED : { actions : string [] ; } ; TRANSFER_SUCCESS : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; UNHOLD_INITIATED : { target : TaskState ; } ; UNHOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; HOLD_INITIATING : { on : { HOLD_FAILED : { actions : string [] ; target : TaskState ; } ; HOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; IDLE : { on : { CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } ; HYDRATE : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target ?: undefined ; } ) [] ; TASK_INCOMING : { actions : string [] ; target : TaskState ; } ; } ; } ; OFFERED : { on : { ASSIGN : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; ASSIGN_FAILED : { actions : string [] ; target : TaskState ; } ; CONSULTING_ACTIVE : { actions : string [] ; target : TaskState ; } [] ; CONSULT_END : { actions : string [] ; target : TaskState ; } ; CONSULT_FAILED : { actions : string [] ; target : TaskState ; } ; CONTACT_ENDED : { actions : string [] ; target : TaskState ; } ; INVITE_FAILED : { actions : string [] ; target : TaskState ; } ; OFFER_CONSULT : { actions : string [] ; } ; OUTBOUND_FAILED : ( { actions : string [] ; guard : ( ( __namedParameters ) => boolean ) ; target : TaskState ; } | { actions : string [] ; guard ?: undefined ; target : TaskState ; } ) [] ; RONA : { actions : string [] ; target : TaskState ; } ; TASK_OFFERED : { actions : string [] ; } ; TASK_WRAPUP : { actions : string [] ; target : TaskState ; } ; } ; } ; RESUME_INITIATING : { on : { UNHOLD_FAILED : { target : TaskState ; } ; UNHOLD_SUCCESS : { actions : string [] ; target : TaskState ; } ; } ; } ; TERMINATED : { entry : string [] ; type : "final" ; } ; WRAPPING_UP : { entry : string [] ; on : { WRAPUP_COMPLETE : { actions : string [] ; target : TaskState ; } ; } ; } ; } ; } > , TaskEventPayload , EventObject >
web Call Map web Call Map : Record < string , string >
Protected Optional agent Id agent Id ?: string
Protected contact contact : { accept : Res < AgentContact , { interactionId : string ; } > ; blindTransfer : Res < AgentContact , { data : TransferPayLoad ; interactionId : string ; } > ; cancelCtq : Res < AgentContact , { data : cancelCtq ; interactionId : string ; } > ; cancelTask : Res < AgentContact , { interactionId : string ; } > ; conferenceTransfer : Res < AgentContact , { interactionId : string ; } > ; consult : Res < AgentContact , { data : ConsultPayload ; interactionId : string ; } > ; consultAccept : Res < AgentContact , { interactionId : string ; } > ; consultConference : Res < AgentContact , { data : ConsultConferenceData ; interactionId : string ; } > ; consultEnd : Res < AgentContact , { data : ConsultEndPayload ; interactionId : string ; } > ; consultTransfer : Res < AgentContact , { data : ConsultTransferPayLoad ; interactionId : string ; } > ; end : Res < AgentContact , { interactionId : string ; } > ; exitConference : Res < AgentContact , { interactionId : string ; } > ; hold : Res < AgentContact , { data : HoldResumePayload ; interactionId : string ; } > ; pauseRecording : Res < AgentContact , { interactionId : string ; } > ; resumeRecording : Res < AgentContact , { data : ResumeRecordingPayload ; interactionId : string ; } > ; unHold : Res < AgentContact , { data : HoldResumePayload ; interactionId : string ; } > ; vteamTransfer : Res < AgentContact , { data : TransferPayLoad ; interactionId : string ; } > ; wrapup : Res < AgentContact , { data : WrapupPayLoad ; interactionId : string ; } > ; } Type declaration accept : Res < AgentContact , { interactionId : string ; } > blind Transfer : Res < AgentContact , { data : TransferPayLoad ; interactionId : string ; } > cancel Ctq : Res < AgentContact , { data : cancelCtq ; interactionId : string ; } > cancel Task : Res < AgentContact , { interactionId : string ; } > conference Transfer : Res < AgentContact , { interactionId : string ; } > consult Accept : Res < AgentContact , { interactionId : string ; } > consult Conference : Res < AgentContact , { data : ConsultConferenceData ; interactionId : string ; } > end : Res < AgentContact , { interactionId : string ; } > exit Conference : Res < AgentContact , { interactionId : string ; } > hold : Res < AgentContact , { data : HoldResumePayload ; interactionId : string ; } > pause Recording : Res < AgentContact , { interactionId : string ; } > un Hold : Res < AgentContact , { data : HoldResumePayload ; interactionId : string ; } > vteam Transfer : Res < AgentContact , { data : TransferPayLoad ; interactionId : string ; } > Protected current Ui Controls Protected metrics Manager metrics Manager : default
Protected ui Control Config ui Control Config : UIControlConfig
Protected Optional wrapup Data Private Optional last State last State ?: TaskState
Interface for managing task-related operations in the contact center Extends IEventEmitter to support event-driven task updates