Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

Introduction

The CHAT role is used for conducting chat sessions with agents from external websites. In addition, the CHAT role can also be converted into a WhatsApp Connector with the provider TynTec. This allows clients to offer their customers the option to send requests through WhatsApp, instead of a Web-Based CHAT. Chat and WhatsApp Connectors can be used in parallel.

Requirements

  • The jtel Chat Module
  • The installation can either be done in parallel with an already existing web server or load balancer - with a corresponding RAM extension of about 4 GB per server - or on a separate server

Configuration

Creating a new Chat Connector

A new Connector can be created via the web-interface. Logged in as a Client Administrator, navigate to "Menu → Chat → Chat Connectors" and press "new". In the resulting popup, the assigned Client ID is shown, as well as the fields to provide a name and title for the Connector.

After clicking "Save", you can enter the configuration page by clicking "Edit" on the Connector.

Settings

Master Data
FieldExplanation
Client IDID of the client in which the Connector is created
NameName of the Connector
Title

Title of the Connector

WhatsApp

When inactive, the Connector is a Chat Connector

When active, the Connector functions both as a Chat and a Whatsapp Connector

Distribution
FieldExplanation
ACD GroupThe ACD-Group inside which the events are distributed

Max Chats all Agents

The maximum amount of simultaneous chat events that can be handled by the Connector amongst all agents in the configured ACD-Group 
PriorityThe priority of incoming chat events. Used primarily when more than one Connector is attached to the same ACD-Group
Maximum connect wait time (s)The amount of time that can pass before an agent must have opened the incoming chat event by pressing on the indicator. If the configured value is exceeded, the event will be redistributed to another agent 
Maximum agent answer time (s)The amount of time that can pass before the agent has sent the first reply to the customer. If the configured value is exceeded, the event will be redistributed to another agent
Maximum free agent search time (s)The maximum amount of time the system will search for an available agent. If the configured value is exceeded the event will be closed and the customer will be informed
Skill 1The first skill which can be attached to incoming events.
Minimum Skill 1The minimum value of skill 1 required by an agent to have the event distributed to him
Ignore skill 1 after timeout (s)The amount of time that will pass until skill 1 is ignored and not considered in event distribution
Skill 2The second skill which can be attached to incoming events.
Minimum Skill 2The minimum value of skill 2 required by an agent to have the event distributed to him
Ignore skill 2 after timeout (s)The amount of time that will pass until skill 2 is ignored and not considered in event distribution
Skill 3The third skill which can be attached to incoming events.
Minimum Skill 3The minimum value of skill 3 required by an agent to have the event distributed to him
Ignore skill 3 after timeout (s)The amount of time that will pass until skill 3 is ignored and not considered in event distribution
Ignore Skills after timeout (s)The amount of time that will pass until all configured skills are ignored and not considered in event distribution
Ignore skills if no agents with skills availableIf checked, skill distribution will be inactive when no agents with the required skills are available in the ACD-Group
Code
Field

Example Configuration

Configuration

{
"noAgents":"Sorry, currently there are no agents available. Please try again later.",
"noAgents#de":"Es tut uns leid, aber derzeit sind keine Agenten verfügbar. Bitte probieren Sie etwas später nochmal.",
"outOfService":"Sorry, but currently we are closed. Please try again during office hours.",
"outOfService#de":"Es tut uns leid, derzeit sind wir geschlossen. Bitte probieren Sie es während unsere Öffnungszeiten wieder.",
"agentTyping":"Agent $agent is typing...",
"agentTyping#de":"Agent $agent schreibt ...",
"bye":"Thank you for using our service. Goodbye.",
"bye#de":"Danke, dass Sie unseren Service genutzt haben. Auf Wiedersehen.",
"byeNoAgent": "Sorry, currently there are no agents available. Please try again later.",
"byeNoAgent#de":"Es tut uns leid, aber derzeit sind keine Agenten verfügbar. Bitte probieren Sie etwas später nochmal.",
"welcomeMessage":"Welcome!",
"welcomeMessage#de":"Herzlich willkommen!.",
"editorPlaceholder":"Enter your message here.",
"editorPlaceholder#de":"Geben Sie Ihre Nachricht hier ein."
}

Explanation:
noAgentsWhen no agent is available, the configured message is sent to the customer
outOfServiceWhen a customer sends a message outside business hours, the configured message is sent to the customer
agentTyping

When the agent enters a response to the customer, the configured message is sent to the customer.

Note
iconfalse
titleWhatsApp

This message is not displayed to customers who use WhatsApp


byeWhen the chat event is closed,  
byeNoAgentWhen no agent is available, 
welcomeMessageAfter a customer has sent a message and opened a new event, 
editorPlaceholder

This message is displayed to the customer after the window for chat is opened at the external website. 

Note
iconfalse
titleWhatsApp

This message is not displayed to customers who use WhatsApp



Code


Code Block
languagetext
<script src='https://websiteurl.de:3003/gui//chat.js'></script>
<script type="text/javascript">
   JTEL.initChat({ 
       Hash: 'ZkGgUcDkLPEY',
       BaseWSURI: 'wss://chatserverurl.de:3003',
       BaseResourceURI: 'https://storageserverurl:3003/gui', //optional
       pdata: {name:'John Doe', email:'john.doe@example.com', sender:'John Doe', receiver:'My Chat Connector', userdata:'123456', userdata2:'userdata2', userdata3:'userdata3'},
       udata: {anyfield1:'Any Field 1', anyfield2:'Any Field 2'} });
</script>


Explanation:

To access the jtel server, the code is embedded into the external website. The code is generated with the settings from the parameters in the jtel portal, as well as the settings from the page Master Data in the chat Connector configuration.

REST
Token Post
Field

Example Configuration

Url


Code Block
languagetext
https://myrestservice.example.com/service/GetToken


Header


Code Block
languagetext
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX


Body


Code Block
languagetext
grant_type=client_credentials&redirect_uri=https://myrestservice.example.com/service/api/v1/Customers/Contacts


Report Export Post
Field

Example Configuration

Url


Code Block
languagetext
https://myrestservice.example.com/service/api/v1/Customers/Contacts


Header


Code Block
languagetext
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer $tokenResponse.body.JSON.access_token


Body


Code Block
languagetext
{"CustomerNumber":"$chatConnector.id",
"XMLCodedData":"$xmlTemplate.encoded.base64"}


Xml Template


Code Block
languagetext
<?xml version="1.0" encoding="utf-8"?>
<chatReport>
<Size>$report.bytes</Size>
<Content>$report.encoded.base64</Content>
</chatReport>


See also: Chat Report Export

Portal Configuration

Additional configuration in the portal is necessary, regarding the distribution of Chat and WhatsApp events

Agent Status

Agent status for chat - or an existing status - must be configured to allow a chat event to be distributed to the agent:

Image Modified

Max chats per agent

The maximum number of parallel chats per agent must be configured. This value is set to 0 by default for all agents. The checkmark at "Ticket via Web Interface" has to be checked.

Image Modified

Additional configurations for WhatsApp

Additional parameters are required for WhatsApp connectors 

Master Data
FieldExplanation
WhatsApp

When active, the Connector is changed to a WhatsApp Connector

Whatsapp ApiKeyThe TynTec API Key is entered in this field 
Whatsapp NumberThe phone number is entered in E.164 format

The additional configuration required on the server side is described here: Role CHAT

Sv translation
languagede

Einführung

Die Rolle CHAT wird für die Durchführung von Chat-Sitzungen mit Agenten von externen Websites verwendet. Darüber hinaus kann die Rolle CHAT mit dem Provider TynTec auch in einen WhatsApp Konnektor  umgewandelt werden. Dies ermöglicht es Klienten, ihren Kunden die Möglichkeit anzubieten, Anfragen über WhatsApp statt über einen webbasierten CHAT zu senden. Chat und WhatsApp Konnektoren können parallel verwendet werden.

Anforderungen

  • Das jtel Chat Modul
  • Die Installation kann entweder parallel zu einem bereits vorhandenen Webserver oder Loadbalancer - mit einer entsprechenden RAM-Erweiterung von etwa 4 GB pro Server - oder auf einem separaten Server erfolgen

Konfiguration

Erstellen eines neuen Chat-Connectors

Ein neuer Konnektor kann über das Portal erstellt werden. Melden Sie sich als Client Administrator an, navigieren Sie zu "Menü → Chat → Chat-Konnektoren" und drücken Sie "Neu". Im daraufhin erscheinenden Popup-Fenster werden die zugewiesene Client-ID sowie die Felder zur Angabe eines Namens und Titels für den Konnektor angezeigt.

Nachdem Sie auf "Speichern" geklickt haben, können Sie die Konfigurationsseite aufrufen, indem Sie auf "Bearbeiten" auf dem Konnektor klicken.

Einstellungen

Stammdaten
FeldErläuterung
Client IDID des Clients, in dem der Konnektor erstellt wird
NameName des Konnektors
Titel

Titel des Konnektors

WhatsApp

Wenn der Haken inaktiv ist, ist der Konnektor ein Chat-Konnektor

Wenn der Haken aktiv ist, fungiert der Konnektor sowohl als Chat- als auch als Whatsapp-Konnektor

Verteilung
FeldErläuterung
ACD GruppeDie ACD-Gruppe, in der die Medienereignisse verteilt werden

Max Chats alle Agenten

Die maximale Anzahl gleichzeitiger Chat-Ereignisse, die vom Konnektor zwischen allen Agenten in der konfigurierten ACD-Gruppe bearbeitet werden können 
PrioritätDie Priorität der eingehenden Chat-Ereignisse. Wird hauptsächlich verwendet, wenn mehr als ein Konnektor an dieselbe ACD-Gruppe angeschlossen ist.
Maximale Konnektwartezeit (s)Die Zeitspanne, die vergehen kann, bis ein Agent das eingehende Chat-Ereignis durch Drücken auf den Indikator geöffnet haben muss. Wenn der konfigurierte Wert überschritten wird, wird das Ereignis auf einen anderen Agenten umverteilt. 
Maximale Antwortwartezeit (s)Die Zeitspanne, die vergehen kann, bis der Agent die erste Antwort an den Kunden gesendet hat. Wenn der konfigurierte Wert überschritten wird, wird das Ereignis an einen anderen Agenten neu verteilt.
Maximale Suchzeit nach freien Agenten (s)Die maximale Zeitspanne, die das System für die Suche nach einem verfügbaren Agenten verwendet. Wenn der konfigurierte Wert überschritten wird, wird das Ereignis geschlossen und der Kunde informiert.
Skill 1Der erste Skill, der mit eingehenden Ereignissen verknüpft werden kann.
Mindestwert Skill 1Der Mindestwert von Skill 1, der von einem Agenten benötigt wird, um das Ereignis an ihn zu verteilen
Ignoriere Skill 1 nach Timeout (s) (s)Die Zeitspanne, die vergeht, bis Skill 1 ignoriert und bei der Ereignisverteilung nicht berücksichtigt wird
Skill 2Der zweite Skill, der mit eingehenden Ereignissen verknüpft werden kann.
Mindestwert Skill 2Der Mindestwert von Skill 2, der von einem Agenten benötigt wird, um das Ereignis an ihn zu verteilen
Ignoriere Skill 2 nach Timeout (s) (s)Die Zeitspanne, die vergeht, bis Skill 2 ignoriert und bei der Ereignisverteilung nicht berücksichtigt wird
Skill 3Der dritte Skill, der mit eingehenden Ereignissen verbunden werden kann.
Mindestwert Skill 3Der Mindestwert von Skill 3, den ein Agent benötigt, um das Ereignis an sich verteilen zu lassen
Ignoriere Skill 3 nach Timeout (s)Die Zeitspanne, die vergeht, bis Skill 3 ignoriert und bei der Ereignisverteilung nicht berücksichtigt wird
Ignore Skills after timeout (s)Die Zeitspanne, die vergeht, bis alle konfigurierten Skills ignoriert und bei der Ereignisverteilung nicht berücksichtigt werden
Ignoriere Skills, wenn keine Agenten mit den Skills verfügbar sindFalls angekreuzt, ist die Kompetenzverteilung inaktiv, wenn keine Agenten mit den erforderlichen Fähigkeiten in der ACD-Gruppe verfügbar sind.
Code
Feld

Example Configuration

Configuration

{
"noAgents":"Sorry, currently there are no agents available. Please try again later.",
"noAgents#de":"Es tut uns leid, aber derzeit sind keine Agenten verfügbar. Bitte probieren Sie etwas später nochmal.",
"outOfService":"Sorry, but currently we are closed. Please try again during office hours.",
"outOfService#de":"Es tut uns leid, derzeit sind wir geschlossen. Bitte probieren Sie es während unsere Öffnungszeiten wieder.",
"agentTyping":"Agent $agent is typing...",
"agentTyping#de":"Agent $agent schreibt ...",
"bye":"Thank you for using our service. Goodbye.",
"bye#de":"Danke, dass Sie unseren Service genutzt haben. Auf Wiedersehen.",
"byeNoAgent": "Sorry, currently there are no agents available. Please try again later.",
"byeNoAgent#de":"Es tut uns leid, aber derzeit sind keine Agenten verfügbar. Bitte probieren Sie etwas später nochmal.",
"welcomeMessage":"Welcome!",
"welcomeMessage#de":"Herzlich willkommen!.",
"editorPlaceholder":"Enter your message here.",
"editorPlaceholder#de":"Geben Sie Ihre Nachricht hier ein."
}

Erläuterung:
noAgentsWhen no agent is available, the configured message is sent to the customer
outOfServiceWhen a customer sends a message outside business hours, the configured message is sent to the customer
agentTyping

When the agent enters a response to the customer, the configured message is sent to the customer.

Note
iconfalse
titleWhatsApp

This message is not displayed to customers who use WhatsApp


byeWhen the chat event is closed,  
byeNoAgentWhen no agent is available, 
welcomeMessageAfter a customer has sent a message and opened a new event, 
editorPlaceholder

This message is displayed to the customer after the window for chat is opened at the external website. 

Note
iconfalse
titleWhatsApp

This message is not displayed to customers who use WhatsApp



Code


Code Block
languagetext
<script src='https://websiteurl.de:3003/gui//chat.js'></script>
<script type="text/javascript">
   JTEL.initChat({ 
       Hash: 'ZkGgUcDkLPEY',
       BaseWSURI: 'wss://chatserverurl.de:3003',
       BaseResourceURI: 'https://storageserverurl:3003/gui', //optional
       pdata: {name:'John Doe', email:'john.doe@example.com', sender:'John Doe', receiver:'My Chat Connector', userdata:'123456', userdata2:'userdata2', userdata3:'userdata3'},
       udata: {anyFeld1:'Any Feld 1', anyFeld2:'Any Feld 2'} });
</script>


Erläuterung:

To access the jtel server, the code is embedded into the external website. The code is generated with the settings from the parameters in the jtel portal, as well as the settings from the page Master Data in the chat Connector configuration.

REST
Token Post
Feld

Example Configuration

Url


Code Block
languagetext
https://myrestservice.example.com/service/GetToken


Header


Code Block
languagetext
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX


Body


Code Block
languagetext
grant_type=client_credentials&redirect_uri=https://myrestservice.example.com/service/api/v1/Customers/Contacts


Report Export Post
Feld

Example Configuration

Url


Code Block
languagetext
https://myrestservice.example.com/service/api/v1/Customers/Contacts


Header


Code Block
languagetext
Cache-Control: no-cache
Content-Type: application/json
Authorization: Bearer $tokenResponse.body.JSON.access_token


Body


Code Block
languagetext
{"CustomerNumber":"$chatConnector.id",
"XMLCodedData":"$xmlTemplate.encoded.base64"}


Xml Template


Code Block
languagetext
<?xml version="1.0" encoding="utf-8"?>
<chatReport>
<Size>$report.bytes</Size>
<Content>$report.encoded.base64</Content>
</chatReport>


See also: Chat Report Export

Portal Configuration

Additional configuration in the portal is necessary, regarding the distribution of Chat and WhatsApp events

Agent Status

Agent status for chat - or an existing status - must be configured to allow a chat event to be distributed to the agent:

Image Added

Max chats per agent

The maximum number of parallel chats per agent must be configured. This value is set to 0 by default for all agents. The checkmark at "Ticket via Web Interface" has to be checked.

Image Added

Additional configurations for WhatsApp

Additional parameters are required for WhatsApp connectors 

Master Data
FeldErläuterung
WhatsApp

When active, the Connector is changed to a WhatsApp Connector

Whatsapp ApiKeyThe TynTec API Key is entered in this Feld 
Whatsapp NumberThe phone number is entered in E.164 format

The additional configuration required on the server side is described here: Role CHAT