Options
All
  • Public
  • Public/Protected
  • All
Menu

Utility for agent session management

Hierarchy

  • ACDSessionManager

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

_aaVoiceTranscriptEventSubject: ReplaySubject<AgentAssistWSRequest> = ...
_agentAssistOmiliaGetNextSubject: Subject<CXoneAgentAssist> = ...
_agentAssistSubject: Subject<CXoneAgentAssist> = ...
_agentAssistSummarySubject: Subject<GetNextAgentAssistEvent> = ...
_agentAssistWSSubject: ReplaySubject<AgentAssistWSRequest> = ...
_agentIndicatorsSubject: Subject<unknown> = ...
_agentLegSubject: Subject<AgentLegEvent> = ...
_agentStateSubject: Subject<AgentStateEvent> = ...
_agentUnavailableCodeSubject: Subject<UpdateUnavailableCodeEvent> = ...
_agentWorkflowCreatePayloadEvent: Subject<string> = ...
_agentWorkflowEvent: Subject<AgentWorkflowResponseEvent> = ...
_agentWorkflowRequestEvent: Subject<AgentWorkflowRequestEvent> = ...
_answerEvent: Subject<MessageEvent<any>> = ...
_callContactEventSubject: Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>> = ...
_callControlEvent: Subject<string> = ...
_closeOmiliaIFrameSubject: Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>> = ...
_coBrowseEvent: Subject<CoBrowseEvent> = ...
_contactEventSubject: Subject<{}> = ...
_contactIndicatorsSubject: Subject<CXoneIndicator> = ...
_customScreenpopSubject: Subject<CXoneCustomScreenpop> = ...
_digitalContactSubject: Subject<DigitalContactEvent> = ...
_localPostEvent: Subject<LocalPostEvent> = ...
_mchAgentSettingChangeEvent: Subject<MCHSetting> = ...
_muteEventSubject: Subject<MuteEvent> = ...
_onAgentAssistGetNextEvent: Subject<CXoneAgentAssist> = ...
_onAgentAssistWebSocketUnsubscribe: Subject<string> = ...
_onAgentCustomEvent: Subject<AgentSessionResponse> = ...
_onAgentSessionChange: Subject<AgentSessionResponse> = ...
_onCommitmentEvent: Subject<CommitmentEvent> = ...
_onCommitmentStatusEvent: Subject<CommitmentStatusEvent> = ...
_onConferenceEvent: Subject<string> = ...
_onConsultContextEvent: Subject<ConsultContextEvent> = ...
_onGetNextEventSubject: Subject<{}[]> = ...
_onHoursOfOperationEvent: Subject<unknown> = ...
_onNaturalCallingSkillListEvent: Subject<boolean> = ...
_onNetworkTimeOutEventSubject: Subject<UpdateNetworkTimeoutEvent> = ...
_onSmartReachValidationEvent: Subject<ComplianceValidationEvent> = ...
_onUpdateCommitments: Subject<unknown> = ...
_pageOpenSubject: Subject<CXonePageOpen> = ...
_popUrlSubject: Subject<CXonePopUrl> = ...
_rejectEvent: Subject<MessageEvent<any>> = ...
_runAppSubject: Subject<CXoneRunApp> = ...
_screenPopSubject: Subject<CXoneContactScreenpop> = ...
_updateMessageEvent: Subject<unknown> = ...
_updatePermissionsEventSubject: Subject<UpdatePermissionsEvent> = ...
_updateSkillsEvent: Subject<unknown> = ...
_voiceMailContactEventSubject: Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>> = ...
_voiceMailPlayBackSubject: Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>> = ...
_workItemContactEventSubject: Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>> = ...
accessToken: string = ''
adminService: AdminService = ...
cxOneConfig: CXoneConfiguration = ...
isEventQueueResized: boolean = false
isJoinSessionInProgress: boolean = false

Tracks whether a joinSession HTTP call is currently in flight.

This flag prevents race conditions when leader election occurs during an active joinSession HTTP call, ensuring toggleACDEventEmitter is not called twice.

logger: Logger = ...
sessionId: string = ''
userInfo: UserInfo = ...
utilService: HttpUtilService = ...

Accessors

  • get agentAssistWebSocketUnsubsribeSubject(): Subject<string>
  • get agentIndicatorsSubject(): Subject<unknown>
  • get agentWorkflowCreatePayloadEvent(): Subject<string>
  • get answerEvent(): Subject<MessageEvent<any>>
  • get callContactEventSubject(): Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>
  • example
    const callContactEventSubject  = acdSession.callContactEventSubject
    

    Returns Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>

  • get callControlEvent(): Subject<string>
  • get closeOmiliaIFrameSubject(): Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>
  • Signal to close the Omilia iframe in CXA custom workspace

    example
    const closeOmiliaIFrameSubject  = acdSession.closeOmiliaIFrameSubject
    

    Returns Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>

  • get conferenceCallEvent(): Subject<string>
  • get hasSessionId(): boolean
  • get hoursOfOperationEvent(): Subject<unknown>
  • get joinSessionInProgress(): boolean
  • Returns true when a joinSession HTTP call is currently in progress.

    This exposes the internal join-session state as read-only to external consumers and reflects whether the race-condition guard described above is currently active.

    example
    const isJoinSessionInProgress = this.joinSessionInProgress;
    

    Returns boolean

  • get mchAgentSettingsChangeEvent(): Subject<MCHSetting>
  • get naturalCallingSkillListEvent(): Subject<boolean>
  • get onContactEvent(): Subject<{}>
  • get onGetNextEvent(): Subject<{}[]>
  • get onUpdateCommitments(): Subject<unknown>
  • get rejectEvent(): Subject<MessageEvent<any>>
  • get updateMessageEvent(): Subject<unknown>
  • get updateSkillsEvent(): Subject<unknown>
  • get voiceMailContactEventSubject(): Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>>
  • example
    const voiceMailContactEventSubject  = acdSession.voiceMailContactEventSubject
    

    Returns Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>>

  • get voiceMailPlayBackEventSubject(): Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>>
  • example
    const voiceMailPlayBackEventSubject  = acdSession.voiceMailPlayBackEventSubject
    

    Returns Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>>

  • get workItemContactEventSubject(): Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>>
  • example
    const workitemContactEventSubject = acdSession.workitemContactEventSubject
    

    Returns Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>>

Methods

  • establishUIQSocketConnection(invokeSnapshot?: boolean, sessionId?: string): void
  • Method to establish UIQueue socket connection

    example
    const establishUIQSocketConnection = agentSession.establishUIQSocketConnection(true)
    

    Parameters

    • Optional invokeSnapshot: boolean

      flag to invoke snapshot request

    • Optional sessionId: string

    Returns void

  • getSessionId(): string
  • Method to join session for an agent

    example
    const agentObj = {agentId: 23}
    const joinACDSession = this.joinSession(agentObj)

    Parameters

    • Optional options: { agentId?: number; isUIQueueEnabled?: boolean }

      input parameters for the method includes agent id

      • Optional agentId?: number
      • Optional isUIQueueEnabled?: boolean

    Returns Promise<HttpResponse | CXoneSdkError>

    • response from the join agent session api
  • removeAgentAssistOmiliaGetNextEvent(callContactEvent: AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>): Promise<void>
  • example
    await acdSession.removeAgentAssistOmiliaGetNextEvent(callContactEvent)
    

    Parameters

    • callContactEvent: AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>

      CallContactEvent value

    Returns Promise<void>

  • setAccessToken(accessToken: string): void
  • setSessionId(value: string): void
  • startGetNextEvents(sessionId?: string): void
  • terminateGetNextPolling(): void
  • toggleACDEventEmitter(__namedParameters: Object): void
  • updateAgentAssistOmiliaGetNextSubjectFromIndexDB(): Promise<void>

Generated using TypeDoc