Jump to: navigation, search

Chat

DevGuide2.png Purpose: To present for each chat command, the list of default subcommands available and the associated parameters.

Learn about the Chat Commands

The chat commands presented in this page are restricted to chat interactions. However, chat interactions are extended open media interactions and can be used as such in open media commands. In addition to the chat commands, you can use:

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

Managing Chat Interactions

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

  • Accept or decline a chat session;
  • Make chat consultations or transfer the session;
  • Release a party;
  • Close or leave the session.
Chains of Commands to Manage Chat Interactions
Default Commands Parameters
Chain InteractionChatAcceptChat
  • Accept
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IInteractionChat</ref>
Chain InteractionChatAutoCloseInteraction
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • ResetInteractionChatConsultationCommand
  • CommandParameter: IInteractionsBundle<ref name="IInteractionsBundle" >Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle</ref>
  • Close
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • CloseConsultation
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatAutoDisconnect
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • ReleaseMyParty
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • AfterActionMode: String<ref name="String" > System.String</ref>
Chain InteractionChatCloseInteraction
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToClose
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Close
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatCompleteConferenceAgent
  • CompleteConference
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IInteractionChatCommon</ref>
  • Destination: String<ref name="String" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" > Genesyslab.Enterprise.Commons.Collections.KeyValueCollection</ref>
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatCompleteTransferAgent
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteraction</ref>
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" > Genesyslab.Desktop.Modules.Windows.Interactions.INotepadViewModel</ref>
  • CompleteTransfer
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" />
  • Destination: String<ref name="String" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatConferenceAgent
  • ConferenceAgent
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.IInteractionOpenMedia</ref>
  • Visibility: String<ref name="String" />
  • Destination: String<ref name="String" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" > Genesyslab.Desktop.Modules.TeamCommunicator.ObjectTC</ref>
Chain InteractionChatConsultPromptForEnd
  • PromptEnd
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • ConfirmParentWindow: Window<ref name="Window" > System.Window.Window</ref>
Chain InteractionChatConsultRelease
  • SetSupervisorMuteChat
  • Release
  • CommandParameter: IInteractionChatConsult<ref name="IInteractionChatConsult" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IInteractionChatConsult</ref>
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatDeclineChat
  • Decline
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • Close
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionChatDisconnectChat
  • PromptEnd
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • ConfirmParentWindow: Window<ref name="Window" />
  • SetSupervisorMuteChat
  • Disconnect
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatDisconnectChatSessionChannel
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • Disconnect
  • CommandParameter: IClientChannel<ref name="IClientChannel" > Genesyslab.Enterprise.Model.Channel.IClientChannel</ref>
Chain InteractionChatDisconnectMonitoredChat
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • Disconnect
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatDisconnectMonitoredCoachChat
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • DisconnectCoach
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatInitConsultation
  • SetTransferInformation
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • InitConsultation
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionChatInitiateConferenceOtherType
  • SetCollaborationQueueContext
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • System.String: Queue, output parameter<ref name=" Queue, output parameter" > Queue, output parameter</ref>
  • SetCollaborationContext
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Media: IMediaOpenMedia output parameter<ref name="IMediaOpenMedia output parameter" > Genesyslab.Desktop.Modules.OpenMedia.Model.Agents.IMediaOpenMedia output parameter</ref>
  • CreateCollaboration
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • System.String: Queue<ref name=" Queue" > Queue</ref>
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • Media: IMediaOpenMedia<ref name="IMediaOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Agents.IMediaOpenMedia</ref>
  • CorrelatorData: String<ref name="String" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionChatInviteAddInvitingParty
  • AddParty
  • CommandParameter: String<ref name="String" />
  • Destination: String<ref name="String" />
  • DisplayObject: IFormattedObject Type<ref name="IFormattedObjectType" > Genesyslab.Desktop.Infrastructure.ObjectFormat.IFormattedObject Type</ref>
Chain InteractionChatInviteRemoveInvitingParty
  • RemoveParty
  • CommandParameter: String<ref name="String" />
  • Destination: String<ref name="String" />
Chain InteractionChatIsPossibleToClose
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToClose
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatJoinChat
  • Join
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatLeaveInteractionFromConference
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • Leave
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionChatPlaceInQueue
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • UpdateInteractionUCS
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • SaveAttachedData
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • PlaceInQueue
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • ReleaseMyParty
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • AfterActionMode: String<ref name="String" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionChatPushUrl
  • PushUrl
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • Url: String<ref name="String" />
  • Visibility: String<ref name="String" />
Chain InteractionChatReconnect
  • Join
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatReleasePartyFromConference
  • ReleaseParty
  • CommandParameter: IChatParty<ref name="IChatParty" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Chat.IChatParty</ref>
Chain InteractionChatReleasePartyFromConsult
  • ReleaseParty
  • CommandParameter: IChatParty<ref name="IChatParty" />
Chain InteractionChatReopenChannel
  • Reopen
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
Chain InteractionChatSendMessage
  • SendMessage
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" />
  • CaseId: String<ref name="String" />
    Added in: 8.5
  • Visibility: String<ref name="String" />
  • Message: String<ref name="String" />
Chain InteractionChatTransferAgent
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • TransferAgent
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • ReleaseMyParty
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • AfterActionMode: String<ref name="String" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionChatTypingStarted
  • TypingStarted
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" />
  • Visibility: String<ref name="String" />
Chain InteractionChatTypingStopped
  • TypingStopped
  • CommandParameter: IInteractionChatCommon<ref name="IInteractionChatCommon" />
  • Visibility: String<ref name="String" />
Chain InteractionChatWorkflow
  • CloseConsult
  • CommandParameter: IInteractionChat<ref name="IInteractionChat" />
  • ExitJoinIssue
    Available since: 8.5
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • Workflow
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Workflow: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />


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 />

This page was last modified on April 16, 2014, at 12:43.

Feedback

Comment on this article:

blog comments powered by Disqus