Voice

Purpose: To provide information about customizable commands. Updated in: 8.1.3, 8.1.4

Learn about Voice Commands

The commands presented in this page enable your application to manage voice interactions. In addition, to create a new voice interaction, see Manage Voice Media.

Read Use Customizable Commands to see code snippets which demonstrate the usage of the commands.

Managing Voice Interactions

The commands presented in this section are specific to voice interactions and cover the following features (this list is not exhaustive):

• Answer a call;
• Transfer;
• Conference;
• Mute;
• Send DTMF;
• Listen reconnections and disconnections;
• Retrieve and hold calls.

To create a new voice interaction, see the Manage Voice Media.

Chains of Commands to Manage Voice Interactions

Default Commands	Parameters
Chain InteractionVoiceAlternateCall
AlternateCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionVoice</ref> Reasons: KeyValueCollection<ref name="KeyValueCollection" > Genesyslab.Enterprise.Commons.Collections.KeyValueCollection</ref> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceAnswerCall
AnswerCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceAutoCloseConsult
AutoCloseConsult	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceBeforeClose
DoNotCallOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
SetCallResultOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
RescheduleOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
UpdateOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
MarkProcessedOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
IsContactModified Added in 8.1.4	CaseId: String<ref name="String" />
Close Available since: 8.1.100.14	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceClose
DoNotCallOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
SetCallResultOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
RescheduleOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
UpdateOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
MarkProcessedOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
IsContactModified Added in 8.1.4	CaseId: String<ref name="String" />
Close	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceCompleteConference
CompleteConference	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceCompleteTransfer
ParkCallback Available since: 8.1.300.17	CommandParameter: IInteraction<ref name="IInteraction" />
CompleteTransfer	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceDeleteFromConference
DeleteFromConference	CommandParameter: Party<ref name="Party" > Genesyslab.Desktop.Modules.Core.Model.Interactions.Party</ref> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceHoldCall
HoldCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceIfPossibleCloseInteraction
DoNotCallOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
SetCallResultOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
RescheduleOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
UpdateOutboundRecord Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
MarkProcessedOutboundChain Available since: 8.1.100.14	CommandParameter: IInteraction<ref name="IInteraction" />
GetAttachedDataInformationUCS Available since: 8.1.300.17	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" >Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle</ref>
UpdateNotePad	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
IsPossibleToMarkDone	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
CompleteDispositionCode	CommandParameter: IInteraction<ref name="IInteraction" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteraction</ref>
Close	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
StopInteractionVoiceUCS	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
Chain InteractionVoiceInitConference
ConferenceNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> UserData: KeyValueCollection<ref name="KeyValueCollection" />
RequestSaveNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" > Genesyslab.Desktop.Modules.Windows.Interactions.INotepadViewModel</ref>
InitConference	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Destination: <ref name="String" > System.String</ref> Location: String<ref name="String" /> UserData: KeyValueCollection<ref name="KeyValueCollection" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionVoiceInitTransfer
TransferNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> UserData: KeyValueCollection<ref name="KeyValueCollection" />
RequestSaveNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
InitTransfer	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Destination: String<ref name="String" /> Location: String<ref name="String" /> UserData: KeyValueCollection<ref name="KeyValueCollection" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" /> CorrelatorData: String<ref name="String" /> Available since: 8.1.300.17
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" > Genesyslab.Desktop.Modules.TeamCommunicator.ObjectTC</ref>
Chain InteractionVoiceIsPossibleToClose
IsContactModified Added in 8.1.4	CaseId: String<ref name="String" />
IsPossibleToMarkDone	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
CompleteDispositionCode	CommandParameter: IInteraction<ref name="IInteraction" />
Chain InteractionVoiceListenDisconnect
ListenDisconnect	CommandParameter: Party<ref name="Party" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceListenReconnect
ListenReconnect	CommandParameter: Party<ref name="Party" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceMuteOff Deprecated since 8.1.2
MuteOff	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceMuteOnDeprecated since 8.1.2
MuteOn	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoicePauseRecordCall Available since: 8.1.200.16
PauseRecordCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoicePauseRecordScreenCall Deprecated in 8.1.4
PauseRecordScreenCall Deprecated in 8.1.4	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Deprecated in 8.1.4
Chain InteractionVoiceReconnectCall
PromptEnd Available since: 8.1.200.16	CommandParameter: IInteraction<ref name="IInteraction" /> ConfirmParentWindow: Window<ref name="Window">Window</ref>
ReconnectCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceRecordCall
RecordCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceRedirectCall
RedirectCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> OtherDn: String<ref name="String" /> OtherDnLocation: String<ref name="String" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceReleaseCall
SetSupervisorSilentCommand Available since: 8.1.300.17
PromptEnd Available since: 8.1.200.16	CommandParameter: IInteraction<ref name="IInteraction" /> ConfirmParentWindow: Window<ref name="Window" />
ReleaseCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceReportBadQualityOfMedia Added in 8.1.4
ReportBadQualityOfMedia	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceResume
Resume	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceResumeRecordCall Available since: 8.1.200.16
ResumeRecordCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceResumeRecordScreenCall Deprecated in 8.1.4
ResumeRecordScreenCall Deprecated in 8.1.4	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Deprecated in 8.1.4
Chain InteractionVoiceRetrieveCall
RetrieveCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceSendDTMF
SendDTMF	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> DtmfDigits: String<ref name="String" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionVoiceSingleStepConference
ConferenceSingleStepNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> UserData: KeyValueCollection<ref name="KeyValueCollection" />
RequestSaveNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
SingleStepConference	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Destination: String<ref name="String" /> Location: String<ref name="String" /> UserData: KeyValueCollection<ref name="KeyValueCollection" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionVoiceSingleStepTransfer
ParkCallback Available since: 8.1.300.17	CommandParameter: IInteraction<ref name="IInteraction" />
TransferSingleStepNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> UserData: KeyValueCollection<ref name="KeyValueCollection" />
RequestSaveNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
SingleStepTransfer	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Destination: String<ref name="String" /> Location: String<ref name="String" /> UserData: KeyValueCollection<ref name="KeyValueCollection" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionVoiceStartRecordScreenCall Deprecated in 8.1.4
StartRecordCaScreenCall Deprecated in 8.1.4	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Deprecated in 8.1.4
Chain InteractionVoiceStopRecordCall
StopRecordCall	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" />
Chain InteractionVoiceStopRecordScreenCall Deprecated in 8.1.4
StopRecordScreenCall Deprecated in 8.1.4	CommandParameter: IInteractionVoice<ref name="IInteractionVoice" /> Deprecated in 8.1.4
Commands common to all interactions
Chain InteractionSetAttachedDataWithDelay
SetAttachedData	CommandParameter: IInteraction<ref name="IInteraction" /> AttachedData: KeyValueCollection<ref name="KeyValueCollection" />
Chain BundleClose
GetAttachedDataInformationUCS	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle</ref>
UpdateNotePadForVoice Available since: 8.1.300.17	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
ResetInteractionChatConsultation	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
IsContactModified Available since: 8.1.4	CaseId: String<ref name="String" />
IsPossibleToClose	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
CompleteDispositionCodeOnBundle	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
Close	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
StopInteractionVoiceUCS	CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" />
GetOutboundPreviewRecord	CommandParameter: ICampaign<ref name="ICampaign" > Genesyslab.Enterprise.Model.Interaction.ICampaign</ref>

<references />