Inhalt

Einführung

Voraussetzungen

Anforderungen

Verwendete Komponenten

Hintergrundinformationen

API zur Mitarbeiterverfügbarkeit

API für Agentenkapazität

API für Warteschlangentiefe und Wartezeit

Warteschlangentiefe und Verfügbarkeits-API

Warteschlangentiefe, Verfügbarkeit und Status-API für Einstiegspunkte

API für benutzerdefinierte Chat-Umfrage

Einführung

Dieses Dokument beschreibt die Anwendungsfälle für ECE 11.6 Chat-APIs.

Voraussetzungen

Anforderungen

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

- ECE

Verwendete Komponenten

Die Informationen in diesem Dokument basieren auf den folgenden Software- und Hardwareversionen:

- ECE 11,6

Die Informationen in diesem Dokument wurden von den Geräten in einer bestimmten Laborumgebung erstellt. Alle in diesem Dokument verwendeten Geräte haben mit einer leeren (Standard-)Konfiguration begonnen. Wenn Ihr Netzwerk in Betrieb ist, stellen Sie sicher, dass Sie die potenziellen Auswirkungen eines Befehls verstehen.

Hintergrundinformationen

eGain hat eine kundenorientierte API eingeführt, mit der die Chat-Schaltfläche auf der Website des Kunden ein- oder ausgeblendet werden kann.

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

1. Chat basierend auf:

- Mitarbeiterverfügbarkeit

- Agentenkapazität für Chats

- Warteschlangentiefe und Wartezeit

- Warteschlangentiefe und Agentenverfügbarkeit

- Warteschlangentiefe, Wartezeit und Status des Eingangspunkts

2. Senden Sie individuell angepasste Chat-Umfragen.

Es gibt einige Anwendungsfälle, die mit der API umgesetzt werden können:

- Die Chat-Schaltfläche kann abhängig von der API-Antwort aktiviert oder deaktiviert werden.

- Erhalten Sie die Zeit, die ein Kunde warten muss, bevor ein Mitarbeiter im Chat verfügbar ist.

- Finden Sie die Position des Kunden in einer Warteschlange, um zu schätzen, wie lange ein Kunde warten muss, bevor ein Mitarbeiter für den Chat verfügbar ist.

- Neue benutzerdefinierte Umfragen für Chat-Sitzungen erstellen, um zusätzliche Daten zu erfassen

API zur Mitarbeiterverfügbarkeit

Die Agent Availability API prüft, ob Agenten für die Teilnahme an Chats an einem bestimmten Einstiegspunkt verfügbar sind. Für die Agentenverfügbarkeit gelten Einschränkungen der Media Routing Domain (MRD). Es wird empfohlen, den Abschnitt "Best Practices" der MRD-Konfiguration zu durchlaufen, um die richtigen Ergebnisse zu erzielen.

Anfrage

Methode

URL

ERHALTEN

/chat/entrypoint/agentVerfügbarkeit/ID

Hinweis: Um auf diese API zugreifen 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 Agentenverfügbarkeitsstatus wird zurückgegeben. Eine True-Antwort bedeutet, dass ein Agent verfügbar ist. Eine falsche Antwort bedeutet, dass kein Agent verfügbar ist.

Fehlercodes

500: Verfügbarkeitsinformationen für Agenten können 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"/>

API für Agentenkapazität

Diese API ermöglicht es allen Agenten, an neuen Chataktivitäten in der Warteschlange zu arbeiten, die dem jeweiligen Einstiegspunkt zugeordnet ist. Sie gibt den Unterschied zwischen der maximalen Last (CTL) zurück, die alle Agenten übernehmen können, und der aktuellen Last aller Agenten in der Warteschlange des Einstiegspunkts.

Anfrage

Methode

URL

ERHALTEN

/chat/entrypoint/acity/id

Hinweis: Um diese API zu adressieren, 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 Eingangspunkts, für den Sie die Agentenkapazität prü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 maximal arbeiten.

Fehlercodes

500: Die Kapazitätsdaten des Agenten 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

Über diese API werden die Anzahl der Chats, die in der Warteschlange auf Zuweisung warten, und die geschätzte Wartezeit in der Warteschlange ermittelt.

Anfrage

Methode

URL

ERHALTEN

/chat/entrypoint/liveSessionStatus/id

Hinweis: Um auf diese API zugreifen 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>

Warteschlangentiefe und Verfügbarkeits-API

Diese API prüft die Berechtigung eines Chat-Eingangspunkts zur Bearbeitung neuer Chat-Aktivitäten auf der Grundlage der folgenden Bedingungen:

- Wenn Agenten für die Arbeit an neuen Chat-Aktivitäten verfügbar sind

- Wenn die mit diesem Einstiegspunkt verknüpfte Warteschlange die konfigurierte maximale Tiefe erreicht hat, d. h. die Gesamtzahl der von der Warteschlange verarbeiteten Chats entspricht der maximalen Anzahl von Chats, die die Warteschlange zu einem bestimmten Zeitpunkt verarbeiten kann

Anfrage

Methode

URL

ERHALTEN

/chat/entrypoint/checkEligibility/id

Hinweis: Um auf diese API zugreifen 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. responseType-Attribut kann einen der folgenden Werte aufweisen:

- 0: Die Warteschlange, die diesem Einstiegspunkt zugeordnet ist, kann neue Chats verarbeiten.

- 1: Es ist kein Agent verfügbar, um an neuen Chats zu arbeiten.

- 2: Die maximale Warteschlangentiefe wurde für die Warteschlange erreicht, die dem gegebenen Einstiegspunkt zugeordnet ist. 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 />

Warteschlangentiefe, Verfügbarkeit und Status-API für Einstiegspunkte

Diese API überprüft, ob neue Chats von einem bestimmten Chat-Eingangspunkt verarbeitet werden können. Dabei gelten folgende Bedingungen:

- Chat-Einstiegspunkt ist aktiv.

- Wenn Agenten für die Arbeit an neuen Chat-Aktivitäten verfügbar sind

- Wenn die mit diesem Einstiegspunkt verknüpfte Warteschlange die konfigurierte maximale Tiefe erreicht hat, d. h. die Gesamtzahl der von der Warteschlange verarbeiteten Chats entspricht der maximalen Anzahl von Chats, die die Warteschlange zu einem bestimmten Zeitpunkt verarbeiten kann

Anfrage

Methode

URL

ERHALTEN

/chat/entrypoint/chatZulässig/id

Hinweis: Um auf diese API zugreifen 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 vom Einstiegspunkt verarbeitet werden können, wird dieser Code zurückgegeben. Dies wird durch den Wert des zulässigen Attributs identifiziert. Dieses Attribut kann einen Wert entweder true oder false aufweisen. Wenn der Wert false ist, kann der Attributgrund einen der folgenden Werte aufweisen, um die Ursache der Nichtverfügbarkeit zu ermitteln:

- queue_deep_erreicht: Für die Warteschlange, die dem gegebenen Einstiegspunkt zugeordnet ist, wurde eine maximale Warteschlangentiefe erreicht, und es wird kein neuer Chat verarbeitet.

- agent_not_available: Es ist kein Agent verfügbar, um an einem neuen Chat zu arbeiten.

- service_not_running: Agentenzuweisungsdienst wird nicht ausgeführt

- invalid_entry_point: Der in der Anfrage weitergeleitete Einstiegspunkt ist ungültig.

- entry_point_inactive: Der in der Anfrage übergebene Einstiegspunkt ist nicht aktiv.

- Sonstige: Dieser Einstiegspunkt kann neue Chats aus anderen Gründen nicht bearbeiten.

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

API für benutzerdefinierte Chat-Umfrage

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

Anfrage

Methode

URL

POST

/chat/entrypoint/umfrage

Text anfordern

Name

Beschreibung

Typ

Erforderlich

Frage

Frage, die Teil der Umfrage ist, die dem Kunden angezeigt wird

Zeichenfolge

Ja

Antwort

Beantworten der entsprechenden Frage

Zeichenfolge

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

2004: Die Umfrage wurde erfolgreich übermittelt.