Open Media

Purpose: To provide information about customizable commands.

Learn about Open Media Commands

The open media interactions are top level interfaces implemented by e-mail, chat, and work item interactions. The open media commands presented in this page are basic operations which apply to open media interactions by inheritance: e-mail, chat, and workitem interactions. E-Mails, Chat, and Work Items are specific to e-mail, chat, and work items respectively, and present an addition to the commands detailed in this page. You can also use specific Windows which apply to open media interactions in some GUI components.

Important

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

Managing Open Media Interactions

Open media commands cover the following features (this list is not exhaustive):

• Accept and decline;
• Place in queue;
• Transfer;
• Move to workbins.

Chains of Commands to Manage Open Media Interactions

Default commands	Parameters
Chain InteractionOpenMediaCanPullInteraction
CanPullInteraction	CommandParameter: Dictionary<ref name="Dictionary" >Dictionary<string, object></ref>
Chain InteractionOpenMediaClose
IsContactModified	CaseId: String<ref name="String" />
Close	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionOpenMediaCloseOnOutOfService
UpdateInteractionUCS	CommandParameter: IInteraction<ref name="IInteraction" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteraction</ref>
SmsReleaseParty	CommandParameter: IInteractionSms<ref name="IInteractionSms" >Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Sms.IInteractionSms</ref>
ReleaseMyParty	CommandParameter: IInteractionChat<ref name="IInteractionChat" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IInteractionChat</ref> AfterActionMode: String <ref name="String" >System.String</ref>
CloseConsult	CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Close	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.IInteractionOpenMedia</ref>
Chain InteractionOpenMediaConferenceAgent
ConferenceAgent	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Visibility: String<ref name="String" /> Destination: String<ref name="String" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" > Genesyslab.Enterprise.Commons.Collections.KeyValueCollection</ref>
Chain InteractionOpenMediaGetInteractionStateById
GetInteractionState	CommandParameter: String<ref name="String" />
Chain InteractionOpenMediaHandlingTimeout
UpdateInteractionUCS	CommandParameter: IInteraction<ref name="IInteraction" />
SmsReleaseParty	CommandParameter: IInteractionSms<ref name="IInteractionSms" />
ReleaseMyParty	CommandParameter: IInteractionChat<ref name="IInteractionChat" /> AfterActionMode: String<ref name="String" />
CloseConsult	CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Close	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionOpenMediaMoveToQueue
PlaceInQueue	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Destination: String<ref name="String" /> Reason: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionOpenMediaMoveToWorkbin
MoveToWorkbin	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> WorkbinId: String<ref name="String" /> WorkbinParameter: String<ref name="String" /> WorkbinType: WorkbinType<ref name="WorkbinType" > Genesyslab.Platform.OpenMedia.Protocols.OpenMediaAttributes.WorkbinType</ref> Deprecated in: 8.5
Chain InteractionOpenMediaPlaceInQueue
UpdateInteractionUCS	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
IsContactModified	CaseId: String<ref name="String" />
SaveAttachedData	CommandParameter: IInteraction<ref name="IInteraction" /> UserData: KeyValueCollection<ref name="KeyValueCollection" />
SetAutoClose	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
PlaceInQueue	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Destination: String<ref name="String" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
UpdateContactInformation	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" > Genesyslab.Desktop.Modules.TeamCommunicator.ObjectTC</ref>
Chain InteractionOpenMediaPullById
PullInteraction	CommandParameter: String<ref name="String" /> queue: String<ref name="String" /> sourceType: String<ref name="String" /> agentId: String<ref name="String" />
Chain InteractionOpenMediaPullFromWorkbinById
GetInteractionState	CommandParameter: String<ref name="String" />
CanPullInteraction	CommandParameter: Dictionary<ref name="Dictionary" />
DisplayWarningPullNotPossible	canPullInteraction (result: String<ref name="String" />)
PullFromWorkbin	CommandParameter: String<ref name="String" /> WorkbinId: String<ref name="String" />
Chain InteractionOpenMediaUCSStopProcessing
StopProcessing	CommandParameter: String<ref name="String" /> UserData: KeyValueCollection<ref name="KeyValueCollection" /> MediaType: String<ref name="String" />
Chain InteractionOpenMediaUCSUpdate
UpdateInteraction	CommandParameter: IInteraction<ref name="IInteraction" />
Chain InteractionOpenMediaPullFromWorkbinById
GetInteractionState	CommandParameter: String<ref name="String" />
CanPullInteraction	CommandParameter: Dictionary<string, object><ref name="Dictionary" />
DisplayWarningPullNotPossible	canPullInteraction (result: String<ref name="String" />)
PullFromWorkbin	CommandParameter: String<ref name="String" /> QueueId: String<ref name="String" />
Chain InteractionOpenMediaTransferAgent
SetAutoClose	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
RequestSaveNotepad	CommandParameter: IInteraction<ref name="IInteraction" /> NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" > Genesyslab.Desktop.Modules.Windows.Interactions.INotepadViewModel</ref>
TransferAgent	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Destination: String<ref name="String" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
AddRecentCall	RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionOpenMediaWorkflow
PromptDone	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> ConfirmParentWindow: Window<ref name="Window" >System.Window.Window</ref>
Workflow	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Workflow: String<ref name="String" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionPossibleToMoveToWorkbin
IsWorkbinDestinationDefined Available since: 8.1.3	WorkbinId: String<ref name="String" /> WorkbinOptionName: String<ref name="String" /> CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionInternalConferenceInviteAccept
Accept	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionInternalConferenceInviteConferenceAgent
ConferenceAgent	CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Invite.IInteractionInternalConferenceInvite</ref> Visibility: String<ref name="String" /> Destination: String<ref name="String" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionInternalConferenceInviteDecline
Decline	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" /> Reasons: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Close	CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionInternalConferenceInvitePull
GetInteractionProperties	CommandParameter: String<ref name="String" />
Pull	CommandParameter: String<ref name="String" /> Source: String<ref name="String" /> Added in 8.5 OwnerInteractionId: String<ref name="String" /> Added in 8.5
Chain InteractionInternalConferenceInviteSendInvite
SetCollaborationQueueContext	CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" /> System.String: Queue, output parameter
SetOwner	CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" />
PlaceInQueueCollaboration	CommandParameter: IInteractionInternalConferenceInvite<ref name="IInteractionInternalConferenceInvite" /> Queue: String<ref name="String" /> Reason: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" /> CorrelatorData: String<ref name="String" />
Chain InteractionInternalConferenceInviteStopProcessing
StopProcessing	CommandParameter: IIOpenMediaInteraction<ref name="IIOpenMediaInteraction">Genesyslab.Enterprise.Model.Interaction.IIOpenMediaInteraction</ref> Reason: KeyValueCollection<ref name="KeyValueCollection" /> Extensions: KeyValueCollection<ref name="KeyValueCollection" /> CorrelatorData: String<ref name="String" />
Chain OpenMediaEsdkInteractionPutBackInOriginalLocation Added in 8.5
PutBack
Commands common to all interactions
Chain InteractionSetAttachedDataWithDelay
SetAttachedData	CommandParameter: IInteraction AttachedData: KeyValueCollection
Chain BundleClose
GetAttachedDataInformationUCS	CommandParameter: IInteractionsBundle - Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle
UpdateNotePadForVoice	CommandParameter: IInteractionsBundle
ResetInteractionChatConsultation	CommandParameter: IInteractionsBundle
IsContactModified	CaseId: String
IsPossibleToClose	CommandParameter: IInteractionsBundle
CompleteDispositionCodeOnBundle	CommandParameter: IInteractionsBundle
Close	CommandParameter: IInteractionsBundle
StopInteractionVoiceUCS	CommandParameter: IInteractionsBundle
GetOutboundPreviewRecord	CommandParameter: ICampaign - Genesyslab.Enterprise.Model.Interaction.ICampaign

<references />