Inhoud

Inleiding

Voorwaarden

Vereisten

Gebruikte componenten

Achtergrondinformatie

API voor beschikbaarheid van Agent

Agent Capture API

Diepte van wachtrij en API wachten

Diepte en beschikbaarheid van wachtrij

Diepte van wachtrij, beschikbaarheid en Status-API voor boekingen

Aangepaste Chat Surveillance API

Inleiding

In dit document worden de gebruiksgevallen voor ECE 11.6 Chat API’s beschreven.

Voorwaarden

Vereisten

Cisco raadt kennis van de volgende onderwerpen aan:

- ECE

Gebruikte componenten

De informatie in dit document is gebaseerd op de volgende software- en hardware-versies:

- ECE 11,6

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk levend is, zorg er dan voor dat u de mogelijke impact van om het even welke opdracht begrijpt.

Achtergrondinformatie

Gain is een klant-gerichte API geïntroduceerd die kan worden gebruikt om de chat-knop op de website van de klant te tonen of te verbergen.

Chat API’s kunnen worden gebruikt voor de volgende doeleinden:

1. Geef de chat weer op basis van:

- Beschikbaarheid agent

- Agent-capaciteit voor chats

- Diepte van wachtrij en tijd wachten

- Diepte en beschikbaarheid van wachtrij

- Diepte van wachtrij, wacht tijd en invoerpunt

2. Indienen van enquêtes naar het gebruik van chat.

Er zijn een paar gebruiksgevallen die met API kunnen worden gerealiseerd:

- De knop Chat kan aan- of uitgeschakeld worden op basis van de API-respons

- Ontvang de hoeveelheid tijd die een klant moet wachten voordat een agent beschikbaar is om te chatten

- Vind de positie van klant in een rij om te schatten hoe lang een klant moet wachten alvorens een agent beschikbaar is om te chatten

- Schrijf nieuwe aangepaste onderzoeken voor chatsessies om extra gegevens op te nemen

API voor beschikbaarheid van Agent

De agent beschikbaarheid API controles als er agenten beschikbaar zijn om de tekens van een bepaald toegangspunt te nemen. Media Routing Domain (MRD)-beperkingen zijn van toepassing op de beschikbaarheid van de agent. Het wordt aanbevolen om de optimale werkwijzen van de MRD-configuratie te bekijken om de juiste resultaten te bereiken.

Aanvragen

Methode

URL

KRIJGEN

/chat/entrypoint/agentAvailability/id

Opmerking: Om deze API aan te pakken moet u de volgende indeling gebruiken: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000

URL-parameter

Name

Beschrijving

Type

Vereist

Standaardwaarde voor optionele parameters

legitimatiebewijs

Het ID van het invoerpunt waarvoor u de beschikbaarheid van de agent wilt controleren

lang

Ja

Succescodes

200: De status van de Agent beschikbaarheid wordt teruggegeven. Een echte reactie betekent dat er een agent beschikbaar is. Een valse reactie betekent dat er geen agent beschikbaar is.

Foutcodes

500: Kan de beschikbare informatie over agent niet ophalen.

Respons

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

Agent Capture API

Deze API vergroot de capaciteit van alle agents om aan nieuwe chatactiviteiten te werken in de wachtrij die aan het gegeven ingangspunt is toegewezen. Het geeft het verschil tussen de maximum lading (CTL) terug die alle agenten kunnen nemen en de huidige lading van alle agenten in de rij van het ingangspunt.

Aanvragen

Methode

URL

KRIJGEN

/chat/entrypoint/capacity/id

Opmerking: Om deze API aan te pakken moet u de volgende indeling gebruiken: http://hostname/system/egain/chat/entrypoint/capacity/1000

URL-parameter

Name

Beschrijving

Type

Vereist

Standaardwaarde voor optionele parameters

legitimatiebewijs

Het ID van het invoerpunt waarvoor u de Agent-capaciteit wilt controleren

lang

Ja

Succescodes

200: De resterende capaciteit van de agenten voor het invoerpunt wordt teruggegeven. Een positief getal weerspiegelt de resterende capaciteit. Nul betekent dat er geen agents beschikbaar zijn in het systeem of dat alle agents werken aan hun maximale lading.

Foutcodes

500: Kan de capaciteitsinformatie van de agent niet ophalen.

Respons

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>

Diepte van wachtrij en API wachten

Deze API wordt gebruikt om details te krijgen over het aantal chats dat in de wachtrij voor toewijzing wacht, en de geschatte wachttijd in de wachtrij.

Aanvragen

Methode

URL

KRIJGEN

/chat/entrypoint/liveSessionStatus/id

Opmerking: Om deze API aan te pakken moet u de volgende indeling gebruiken: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000

URL-parameter

Name

Beschrijving

Type

Vereist

Standaardwaarde voor optionele parameters

legitimatiebewijs

Het ID van het invoerpunt waarvoor u de wachtrijdiepte en de wachttijd wilt controleren

lang

Ja

Succescodes

200: Wachtrij-diepte en wachttijd worden teruggegeven

Foutcodes

500: Kan de wachtrijdiepte niet ophalen en wacht tijd.

Respons

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>

Diepte en beschikbaarheid van wachtrij

Deze API controleert of een chat entry point in aanmerking komt voor nieuwe chatactiviteiten op basis van de volgende voorwaarden:

- Als er personeelsleden beschikbaar zijn om aan nieuwe chatactiviteiten te werken

- Indien de wachtrij die aan dat inreispunt gekoppeld is, zijn maximale diepte heeft bereikt, d.w.z. het totale aantal chats dat door de wachtrij wordt verwerkt, is gelijk aan het maximale aantal chats dat de wachtrij op een bepaald tijdstip kan verwerken

Aanvragen

Methode

URL

KRIJGEN

/chat/entrypoint/checkEligibility/id

Opmerking: Om deze API aan te pakken moet u de volgende indeling gebruiken: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

URL-parameter

Name

Beschrijving

Type

Vereist

Standaardwaarde voor optionele parameters

legitimatiebewijs

De ID van het invoerpunt waarvoor u de subsidiabiliteit wilt controleren

lang

Ja

Succescodes

200: Toekenning van het toegangspunt is terug te geven. ResponseType-eigenschap kan een van de volgende waarden hebben:

- 0: De rij die bij dit ingangspunt is gekoppeld, kan nieuwe chats verwerken

- 1: Er is geen agent beschikbaar om aan nieuwe chats te werken

- 2: De maximale rijdiepte is bereikt voor de wachtrij die aan het gegeven ingangpunt is gekoppeld en er worden geen nieuwe chats verwerkt

Foutcodes

500: Kan de wachtrijdiepte niet ophalen en wacht tijd.

Respons

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

Diepte van wachtrij, beschikbaarheid en Status-API voor boekingen

Deze API controleert of nieuwe chats kunnen worden verwerkt door een bepaald chatingangpunt op basis van de volgende voorwaarden:

- Chat entry point is actief

- Als er personeelsleden beschikbaar zijn om aan nieuwe chatactiviteiten te werken

- Indien de wachtrij die aan dat inreispunt gekoppeld is, zijn maximale diepte heeft bereikt, d.w.z. het totale aantal chats dat door de wachtrij wordt verwerkt, is gelijk aan het maximale aantal chats dat de wachtrij op een bepaald tijdstip kan verwerken

Aanvragen

Methode

URL

KRIJGEN

/chat/entrypoint/chatAllowed/id

Opmerking: Om deze API aan te pakken moet u de volgende indeling gebruiken: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

URL-parameter

Name

Beschrijving

Type

Vereist

Standaardwaarde voor optionele parameters

legitimatiebewijs

De ID van het invoerpunt waarvoor u wilt controleren of de chat is toegestaan

lang

Ja

Succescodes

200: Indien nieuwe tekens kunnen worden verwerkt door een invoerpunt, wordt deze code teruggegeven. Dit wordt bepaald door de waarde van de toegestane eigenschap. Deze eigenschap kan waarde of waar of vals hebben. Als de waarde fout is, kan de reden van de eigenschap één van de volgende waarden hebben om de oorzaak van onbeschikbaarheid te identificeren:

- wachtrij_diepte_uitgebreid: Maximale rijdiepte is bereikt voor de wachtrij die bij het gegeven ingangpunt is gekoppeld en er wordt geen nieuwe chat verwerkt

- agent_not_available: Er is geen agent beschikbaar om aan nieuwe chatting te werken

- Service_not_run: Agent-toewijzing-service is niet actief

- ongeldige_entry_point: Punt van binnenkomst dat in het verzoek is doorgegeven, is niet geldig

- entry_point_inactive: Punt van binnenkomst dat in het verzoek wordt doorgegeven, is niet actief

- andere: Dit punt kan om andere redenen geen nieuwe chats verwerken

Foutcodes

500: Kan niet ophalen of dit entry point nieuwe chats kan verwerken.

Respons

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

Of

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

Aangepaste Chat Surveillance API

Deze API kan worden gebruikt om aangepaste enquêteformulieren in te sturen die aan het eind van de chat-sessie worden getoond.

Aanvragen

Methode

URL

POST

/chat/entrypoint/survey

Aanvraag

Name

Beschrijving

Type

Vereist

vraag

Vraag die deel uitmaakt van het onderzoek dat aan de klant wordt getoond

String

Ja

Antwoord

Antwoord op de corresponderende vraag

String

Ja

Instantie van voorbeeldaanvraag

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

Succescodes

204: De enquête is succesvol ingediend.