Enterprise Chat und E-Mail (ECE) 11.6 Customer Facing Chat Application Programming Interface (API)

Einleitung

In diesem Dokument werden die Anwendungsfälle für ECE 11.6 Chat-APIs beschrieben.

Voraussetzungen

Anforderungen

Cisco empfiehlt, dass Sie über Kenntnisse in folgenden Bereichen verfügen:

• ECE
• API

Verwendete Komponenten

Die Angaben in diesem Dokument basieren auf ECE 11.6.

Die Informationen in diesem Dokument beziehen sich auf Geräte in einer speziell eingerichteten Testumgebung. Alle Geräte, die in diesem Dokument benutzt wurden, begannen mit einer gelöschten (Nichterfüllungs) Konfiguration. Wenn Ihr Netzwerk in Betrieb ist, stellen Sie sicher, dass Sie die möglichen Auswirkungen aller Befehle kennen.

Hintergrundinformationen

Gain hat eine kundenseitige API eingeführt, über die die Chat-Schaltfläche auf der Website des Kunden angezeigt oder ausgeblendet werden kann.

Chat-APIs können für folgende Zwecke verwendet werden:

1. Chat anzeigen nach:

• Agentenverfügbarkeit
• Agentenkapazität für Chats
• Warteschlangentiefe und Wartezeit
• Warteschlangentiefe und Agentenverfügbarkeit
• Warteschlangentiefe, Wartezeit und Einstiegspunktstatus

2. Senden Sie individuelle Chatumfragen.

Mit der API lassen sich einige Anwendungsfälle realisieren:

• Die Chat-Schaltfläche kann je nach API-Antwort aktiviert oder deaktiviert werden.
• Ermitteln Sie die Wartezeit, die ein Kunde benötigt, bevor ein Mitarbeiter für den Chat zur Verfügung steht.
• Ermitteln Sie die Position des Kunden in einer Warteschlange, um zu schätzen, wie lange ein Kunde warten muss, bis ein Mitarbeiter für den Chat zur Verfügung steht.
• Verfassen Sie neue Umfragen für Chat-Sitzungen, um zusätzliche Daten zu erfassen.

API für Agentenverfügbarkeit

Die API zur Agentenverfügbarkeit prüft, ob Agenten verfügbar sind, die die Chats von einem bestimmten Einstiegspunkt übernehmen können. Für die Verfügbarkeit des Agenten gelten MRD-Beschränkungen (Media Routing Domain). Es wird empfohlen, den Abschnitt "Best Practices" der MRD-Konfiguration zu durchlaufen, um die richtigen Ergebnisse anzuzeigen.

Anfrage

Methode	URL
HOLEN	/chat/entrypoint/agentAvailability/id

Hinweis: Um diese API nutzen zu können, müssen Sie folgendes Format verwenden: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000

URL-Parameter

Name	Beschreibung	Typ	Erforderlich	Standardwert für optionale Parameter
ID	Die ID des Einstiegspunkts, für den Sie die Verfügbarkeit des Agenten überprüfen möchten.	lang	Ja

Erfolgscodes

200: Der Status der Agentenverfügbarkeit wird zurückgegeben. Eine echte Antwort bedeutet, dass ein Agent verfügbar ist. Bei einer falschen Antwort ist kein Agent verfügbar.

Fehlercodes

500: Die Informationen zur Verfügbarkeit des Agenten konnten nicht abgerufen werden.

Antworttext

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"/>
<agentAvailability available="true" xmlns:ns2="http://bindIngs.egain.com/chat"
xmlns:ns4="urn:ietf:params:xml:ns:xmpp-stanzas" xmlna:ns3="jabber:client"
xmlns:ns5="http://jabber.org/protocol/httpbind"/>

Agentenkapazitäts-API

Diese API ruft die Kapazität aller Agenten ab, neue Chat-Aktivitäten in der Warteschlange auszuführen, die dem jeweiligen Einstiegspunkt zugeordnet sind. Es gibt die Differenz zwischen der maximalen Last (CTL), die alle Agenten übernehmen können, und der aktuellen Last aller Agenten in der Warteschlange des Einstiegspunkts zurück.

Anfrage

Methode	URL
HOLEN	/chat/entrypoint/capacity/id

Hinweis: Um diese API nutzen zu können, müssen Sie folgendes Format verwenden: http://hostname/system/egain/chat/entrypoint/capacity/1000

URL-Parameter

Name	Beschreibung	Typ	Erforderlich	Standardwert für optionale Parameter
ID	Die ID des Einstiegspunkts, für den Sie die Agentenkapazität überprüfen möchten.	lang	Ja

Erfolgscodes

200: Die verbleibende Kapazität der Agenten für den Einstiegspunkt wird zurückgegeben. Eine positive Zahl spiegelt die verbleibende Kapazität wider. Null bedeutet, dass entweder keine Agenten im System verfügbar sind oder alle Agenten ihre maximale Auslastung erreichen.

Fehlercodes

500: Die Informationen zur Agentenkapazität konnten nicht abgerufen werden.

Antworttext

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<availableSlots xmlns:ns2="http://bindings.egain.com/chat"
xmlns:ns4="urn:letf:params:xmlms:xmpp-smanzas"
xmlns:ns5="http://jabber.org/protocol/httbind">
<ns2:count>4</ns2:count>
</availableSlots>

API für Warteschlangentiefe und Wartezeit

Diese API wird verwendet, um Details zur Anzahl der Chats, die in der Warteschlange auf Zuweisung warten, und zur geschätzten Wartezeit in der Warteschlange abzurufen.

Anfrage

Methode	URL
HOLEN	/chat/entrypoint/liveSessionStatus/id

Hinweis: Um diese API nutzen zu können, müssen Sie folgendes Format verwenden: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000

URL-Parameter

Name	Beschreibung	Typ	Erforderlich	Standardwert für optionale Parameter
ID	Die ID des Einstiegspunkts, für den Sie die Warteschlangentiefe und die Wartezeit überprüfen möchten.	lang	Ja

Erfolgscodes

200: Warteschlangentiefe und Wartezeit werden zurückgegeben

Fehlercodes

500: Warteschlangentiefe und Wartezeit konnten nicht abgerufen werden.

Antworttext

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sessionStatus xmlns:ns2="http://bindings.egain.com/chat"
xmlns:ns4="urn:letf:params:xmlms:xmpp-smanzas"
xmlns:ns5="http://jabber.org/protocol/httbind">
      <ns2:waitTime>3.0</ns2:waitTime>
      <ns2:queueDepth>1</ns2: queueDepth >
</sessionStatus>

API für Warteschlangentiefe und Verfügbarkeit

Diese API prüft die Berechtigung eines Chat-Eingangspunkts für neue Chat-Aktivitäten auf Basis der folgenden Bedingungen:

• Wenn Agenten verfügbar sind, die an neuen Chat-Aktivitäten arbeiten.
• Wenn die mit diesem Einstiegspunkt verbundene Warteschlange ihre konfigurierte maximale Tiefe erreicht hat, entspricht die Gesamtzahl der von der Warteschlange verarbeiteten Chats der maximalen Anzahl von Chats, die die Warteschlange zu einem bestimmten Zeitpunkt verarbeiten kann.

Anfrage

Methode	URL
HOLEN	/chat/entrypoint/checkEligibility/id

Hinweis: Um diese API nutzen zu können, müssen Sie folgendes Format verwenden: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

URL-Parameter

Name	Beschreibung	Typ	Erforderlich	Standardwert für optionale Parameter
ID	Die ID des Einstiegspunkts, für den Sie die Berechtigung prüfen möchten.	lang	Ja

Erfolgscodes

200: Die Berechtigung für Einstiegspunkte wird zurückgegeben. Das responseType-Attribut kann einen der folgenden Werte aufweisen:

• 0: Die diesem Einstiegspunkt zugeordnete Warteschlange kann neue Chats verarbeiten.
• 1: Kein Mitarbeiter ist verfügbar, um an neuen Chats zu arbeiten.
• 2: Für die Warteschlange, die dem angegebenen Einstiegspunkt zugeordnet ist, wurde die maximale Warteschlangentiefe erreicht, und es werden keine neuen Chats verarbeitet.

Fehlercodes

500: Warteschlangentiefe und Wartezeit konnten nicht abgerufen werden.

Antworttext

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<checkEligibility xmlns:ns2="http://bindings.egain.com/chat"
xmlns:ns4="urn:letf:params:xmlms:xmpp-smanzas" xmlns:ns3="jabber:client"
xmlns:ns5="http://jabber.org/protocol/httbind" responseType=0 />

API für Warteschlangentiefe, Verfügbarkeit und Einstiegspunktstatus

Diese API prüft, ob neue Chats von einem bestimmten Chat-Eintrittspunkt verarbeitet werden können, und zwar auf der Grundlage folgender Bedingungen:

• Der Chat-Einstiegspunkt ist aktiv.
• Wenn Agenten verfügbar sind, die an neuen Chat-Aktivitäten arbeiten.
• Wenn die mit diesem Einstiegspunkt verbundene Warteschlange ihre konfigurierte maximale Tiefe erreicht hat, entspricht die Gesamtzahl der von der Warteschlange verarbeiteten Chats der maximalen Anzahl von Chats, die die Warteschlange zu einem bestimmten Zeitpunkt verarbeiten kann.

Anfrage

Methode	URL
HOLEN	/chat/entrypoint/chatAllowed/id

Hinweis: Um diese API nutzen zu können, müssen Sie folgendes Format verwenden: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

URL-Parameter

Name	Beschreibung	Typ	Erforderlich	Standardwert für optionale Parameter
ID	Die ID des Einstiegspunkts, für den Sie überprüfen möchten, ob der Chat zulässig ist.	lang	Ja

Erfolgscodes

200: Wenn neue Chats von einem Einstiegspunkt verarbeitet werden können, wird dieser Code zurückgegeben. Dies wird durch den Wert des zulässigen Attributs identifiziert. Dieses Attribut kann den Wert true oder false haben. Wenn der Wert false ist, kann reason des Attributs einen der folgenden Werte aufweisen, um die Ursache der Nichtverfügbarkeit zu ermitteln:

• queue_depth_reach: Die maximale Warteschlangentiefe für die Warteschlange, die dem angegebenen Einstiegspunkt zugeordnet ist, wurde erreicht, und es wird kein neuer Chat verarbeitet.
• agent_not_available: Es ist kein Agent verfügbar, der an einem neuen Chat arbeitet.
• service_not_running: Der Agent-Zuweisungsdienst wird nicht ausgeführt.
• invalid_entry_point: Der in der Anforderung übergebene Einstiegspunkt ist ungültig.
• entry_point_inactive: Der in der Anforderung übergebene Einstiegspunkt ist nicht aktiv.
• other: Dieser Einstiegspunkt kann neue Chats aus anderen Gründen nicht verarbeiten.

Fehlercodes

500: Es kann nicht abgerufen werden, ob dieser Einstiegspunkt neue Chats verarbeiten kann.

Antworttext

HTTP/1.1 200 OK
<?xml version="1.0. encoding="UTF-8" standalone="yes"?>
<chatAllowed xmlns:ns2="http://bindings.egain.com/chat"
xmlns:ns4="urn:ietf:params:xml:ns:xmpp-stanzas" xmlns”ns3="jabber:client"
xmlns:ns5=:http://jabber.org/protocol/httpbind" allowed="true"/>

ODER

HTTP/1.1 200 OK
<?xml version="1.0. encoding="UTF-8" standalone="yes"?>
<chatAllowed xmlns:ns2="http://bindings.egain.com/chat"
xmlns:ns4="urn:ietf:params:xml:ns:xmpp-stanzas" xmlns”ns3="jabber:client"
xmlns:ns5=:http://jabber.org/protocol/httpbind" allowed="false"
reason="entry_point_inactive"/>

Benutzerdefinierte Chat-Umfrage-API

Über diese API können Sie benutzerdefinierte Umfrageformulare einreichen, die am Ende der Chat-Sitzung angezeigt werden.

Anfrage

Methode	URL
POST	/chat/entrypoint/survey

Text anfordern

Name	Beschreibung	Typ	Erforderlich
Frage	Frage, die Teil der dem Kunden angezeigten Umfrage ist	String	Ja
Antwort	Antwort auf die entsprechende Frage	String	Ja

Beispielanforderungstext

<egainSurvey sid="1000">
<survey><question>Question 1</question> <answer>Answer 1</answer></survey>
<survey><question>Question 2</question> <answer>Answer 2</answer></survey>
<survey><question>Question 3</question> <answer>Answer 3</answer></survey>
<survey><question>Question 4</question> <answer>Answer 4</answer></survey>
</egainSurvey>

Erfolgscodes

204: Umfrage erfolgreich abgesandt.