Revision as of 13:37, October 13, 2016 by Olena (talk | contribs) (Update with the copy of version: DRAFT)
Jump to: navigation, search

How to Send Message or Notice to Chat Session from Workflow

Introduction

Genesys allows to send messages and notices (types are limited) to chat session from a workflow (an URS/ORS strategy).

For example, when a customer starts a chat session from the web page, the chat session is created in Chat Server and corresponding interaction is submitted in Interaction Server. At some point, the interaction is processed by the workflow, which can send a message like "agent will be with you shortly... " and then the routing starts (to find an agent to serve this chat communication).

Prerequisites

Interaction Server application (in configuration) must be connected to Chat Server application's "ESP" port.

How to Implement

The following steps are necessary in order to send a message or notice from the URS strategy:

  1. Verify that the interaction is still online by checking that UData['IsOnline'] != '0'. If the interaction is offline, which means that the chat session is closed, there is no sense to send messages into it.
  2. Extract from the interaction properties the name of the Chat Server application which is processing/handling the ongoing chat session. This can be achieved by assigning UData['ChatServerAppName'] to a local variable.
  3. Use the External Service block in the Data and Services palette in IR Designer (or the External Service block in the Server Side palette in Composer) to send a request. The following general parameters must be specified:
  • The Application type must be set to ChatServer.
  • The Application name must be set to a value obtained from the user data in step 2.
  • The Service name is set to Chat.
  • The Don't send user data must be unchecked.
  • Set the corresponding Method name to send one of the following requests:
    • Message – submits a text message to a chat session. Provide the following parameters:
    Parameter Mandatory Value Description
    MessageText yes Message text to submit to a chat session
    MessageType optional Specify any arbitrary text as message type (transparent for Chat Server).
    Nickname optional Specify a nick name of a participant on behalf of whom the message will be shown in a chat session.
    Visibility optional Possible values:
    • ALL – message will be visible to all chat participants (default value)
    • INT – message will be visible to agents and supervisors only
    • VIP – message will be visible to supervisors only

    Use visibility wisely as not all components (including Genesys Workspace) may show it correctly.

    • Notice – sends a notification of the specified type to a chat session. Provide the following parameters:
    Parameter Mandatory Value Description
    NoticeType yes Possible values:
    • USER_PUSHED_URL – to implement the "push URL" functionality (NoticeText must contain valid URL).
    • USER_CUSTOM – could be used for any custom purpose (completely transparent for Chat Server).
    NoticeText optional Any arbitrary text.
    Nickname and Visibility The same as in the Message Method.
    Comments or questions about this documentation? Contact us for support!