CXoneVoiceContact | nice-cxone-acd-agent-apps

Class to perform the business logic for show / hide and enable / disable the voice contact buttons

Hierarchy

CXoneContact
- CXoneVoiceContact

Index

Constructors

constructor

Constructors

constructor

new CXoneVoiceContact(): CXoneVoiceContact

Overrides CXoneContact.constructor
- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:74
example
```
const cxoneVoiceContact = new CXoneVoiceContact();
```
Returns CXoneVoiceContact

Properties

Optional acwTypeId

acwTypeId?: number

remarks

represent model for ACW Type Id value

agentMuted

agentMuted: boolean = false

allowDispositions

allowDispositions: boolean

ani

ani: string

ansMachineOverride

ansMachineOverride: boolean

ansMachineOverrideEndTime

ansMachineOverrideEndTime: string

blendingToSkillName

blendingToSkillName: string

callControlButton

callControlButton: CallControlButton = ...

callType

callType: string

complianceRecord

complianceRecord: boolean

confirmationRequired

confirmationRequired: boolean

contactID

contactID: string

remarks

'contactID' is identifier for the ACD contacts only. For DFO Contact please refer 'caseID' property in CXoneDigitalContact

customData

customData: string

customerCardUrl

customerCardUrl: string

Optional customerId

customerId?: string

remarks

Customer id of the customer who has initiated the digital contact.

customerName

customerName: string

deliveryType

deliveryType: string

disconnectCode

disconnectCode: string

dnis

dnis: string

externalCustomerId

externalCustomerId: string

externalId

externalId: string

finalState

finalState: boolean

Optional fromProvider

fromProvider?: string

remarks

represent model for denoting type of parent interaction while elevating

Private hideInboundHangup

hideInboundHangup: boolean = false

interactionId

interactionId: string

remarks

represent model for interaction id

isInbound

isInbound: boolean

isLinked

isLinked: boolean

isLogging

isLogging: boolean

Private isMaskVisible

isMaskVisible: boolean = false

Private isMuteVisible

isMuteVisible: boolean = false

Private isRecordVisible

isRecordVisible: boolean = false

isRequireManualAccept

isRequireManualAccept: boolean

Private isStopRecordEnabled

isStopRecordEnabled: boolean = false

label

label: string

lastStateChangeTime

lastStateChangeTime: Date

masterID

masterID: string

Optional maxSecondsACW

maxSecondsACW?: number

remarks

represent model for max seconds ACW

omniGroupId

omniGroupId: string

originalState

originalState: boolean

otherInformation

otherInformation: string

otherInformationNewFormat

otherInformationNewFormat: string

Optional outboundStrategy

outboundStrategy?: string

remarks

represent outbound strategy for the contact

parentContactId

parentContactId: string

requireDisposition

requireDisposition: boolean = false

remarks

represent model for require disposition value

screenPopUrl

screenPopUrl: string

screenPopUrlVariables

screenPopUrlVariables: {}[]

skill

skill: string

remarks

represent model for contact skill

skillName

skillName: string

remarks

represent model for skill name

smartReachTransactionId

smartReachTransactionId: string

startTime

startTime: Date

remarks

represent model for start time

status

status: string

remarks

represent model for contact status

timeZones

timeZones: string

timeout

timeout: number

type

type: string

remarks

represent model for contact type

voiceBioHubPatronId

voiceBioHubPatronId: string

Private voiceControlService

voiceControlService: VoiceControlService = ...

Methods

Private assignToCurrentContact

assignToCurrentContact(callInfo: 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> }>): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:466
assign the event properties to CXoneVoiceContact class property

Parameters
- callInfo: 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> }>
Returns void

end

end(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:779
Method to validate the contact has end button then invoke the endContact method.
example
```
end('123');
```
Returns Promise<HttpResponse | CXoneSdkError>

hold

hold(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:515
Method to validate the contact has hold button then invoke the holdContact method
example
```
hold('123')
```
Returns Promise<HttpResponse | CXoneSdkError>

Private initiateButtonStates

initiateButtonStates(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:178
Method to initiate the button states

Returns void

mask

mask(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:647
Method to validate the contact has mask button then invoke the maskCall method.
example
```
mask();
```
Returns Promise<HttpResponse | CXoneSdkError>

mute

mute(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:581
Method to validate the contact has mute button then invoke the muteAgent method.
example
```
mute();
```
Returns Promise<HttpResponse | CXoneSdkError>

record

record(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:713
Method to validate the contact has record button then invoke the recordCall method.
example
```
record();
```
Returns Promise<HttpResponse | CXoneSdkError>

resume

resume(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:548
Method to validate the contact has hold button then invoke the resumeContact method.
example
```
resume('123');
```
Returns Promise<HttpResponse | CXoneSdkError>

stopRecord

stopRecord(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:746
Method to validate the contact has record button then invoke the stopCallRecording method.
example
```
stopRecord();
```
Returns Promise<HttpResponse | CXoneSdkError>

unmask

unmask(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:680
Method to validate the contact has unmask access then invoke the unmask method.
example
```
unmask();
```
Returns Promise<HttpResponse | CXoneSdkError>

unmute

unmute(): Promise<HttpResponse | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:614
Method to validate the contact has unmute acccess then invoke the unmute method.
example
```
unmute();
```
Returns Promise<HttpResponse | CXoneSdkError>

updateAgentPreference

updateAgentPreference(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:140
Method to check the agent has mute, record and mask permission
example
```
this.updateAgentPreference()
```
Returns void

updateButtonState

updateButtonState(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:459
Update call controls
example
```
this.updateButtonState();
```
Returns void

Private updateCallControlButtons

updateCallControlButtons(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:329
Method to perform the logic for enable / disable the call controls

Returns void

Private updateCallControlButtonsOnACWState

updateCallControlButtonsOnACWState(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:303
This method to set all call buttons visibility true and enable false when status is disconnected in ACW state

Returns void

Private updateCallControlButtonsOnActive

updateCallControlButtonsOnActive(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:216
Method to set state of the call controls when status is Active

Returns void

Private updateCallControlButtonsOnEnd

updateCallControlButtonsOnEnd(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:291
This method to set all call buttons visibility false when status is disconnected

Returns void

Private updateCallControlButtonsOnHold

updateCallControlButtonsOnHold(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:228
Method to set state of the call controls when status is holding

Returns void

Private updateCallControlButtonsOnIncoming

updateCallControlButtonsOnIncoming(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:278
Method to set state of the call control when status is incoming

Returns void

Private updateCallControlButtonsOnMask

updateCallControlButtonsOnMask(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:250
Method to set state of the call controls when status is masking

Returns void

Private updateCallControlButtonsOnMute

updateCallControlButtonsOnMute(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:240
Method to set state of the call controls on mute

Returns void

Private updateCallControlButtonsOnRecord

updateCallControlButtonsOnRecord(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:262
Method to set state of the Record button when isLogging is true

Returns void

Private updateCallControlButtonsOnStopRecord

updateCallControlButtonsOnStopRecord(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:271
Method to set state of the Record button when isLogging is false

Returns void

updateCallControls

updateCallControls(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> }>): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:87
Update the class properties and button state for the consult call
example
```
this.updateCallControls(callContactEvent)
```
Parameters
- Optional 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> }>
  
  call contact event
Returns void

updateConsultCallControls

updateConsultCallControls(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> }>): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:102
Update the class properties and button state for the consult call
example
```
this.updateConsultCallControls(callContactEvent);
```
Parameters
- Optional 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> }>
  
  Call contact event
Returns void

updateControlsOnConsultCallStarted

updateControlsOnConsultCallStarted(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:322
This method to update the call control if consult call is started/running
example
- updateControlsOnConsultCallStarted()
Returns void

Private updateMultiCallControlButtons

updateMultiCallControlButtons(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:381
Method to handle the controls for the second call contact

Returns void

updateMuteState

updateMuteState(isAgentMuted: boolean): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:117
Get agentMute value from mute event to update mute button state
example
```
this.updateMuteState(false)
```
Parameters
- isAgentMuted: boolean
  
  boolean
Returns void

updateVoiceCallRecordState

updateVoiceCallRecordState(isLogging: boolean): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-voice-contact.ts:129
Get isLogging value from record event to update record button state
example
```
this.updateVoiceCallRecordState(true)
```
Parameters
- isLogging: boolean
  
  boolean
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CXoneVoiceContact

Properties

Optional acwTypeId

agentMuted

allowDispositions

ani

ansMachineOverride

ansMachineOverrideEndTime

blendingToSkillName

callControlButton

callType

complianceRecord

confirmationRequired

contactID

customData

customerCardUrl

Optional customerId

customerName

deliveryType

disconnectCode

dnis

externalCustomerId

externalId

finalState

Optional fromProvider

Private hideInboundHangup

interactionId

isInbound

isLinked

isLogging

Private isMaskVisible

Private isMuteVisible

Private isRecordVisible

isRequireManualAccept

Private isStopRecordEnabled

label

lastStateChangeTime

masterID

Optional maxSecondsACW

omniGroupId

originalState

otherInformation

otherInformationNewFormat

Optional outboundStrategy

parentContactId

requireDisposition

screenPopUrl

screenPopUrlVariables

skill

skillName

smartReachTransactionId

startTime

status

timeZones

timeout

type

voiceBioHubPatronId

Private voiceControlService

Methods

Private assignToCurrentContact

Parameters

Returns void

end

Returns Promise<HttpResponse | CXoneSdkError>

hold

Returns Promise<HttpResponse | CXoneSdkError>

Private initiateButtonStates

Returns void

mask

Returns Promise<HttpResponse | CXoneSdkError>

mute

Returns Promise<HttpResponse | CXoneSdkError>

record