Enterprise Chat en e-mail (ECE) 11.6 Customer Facing Chat Application Programming Interface (API)

Inleiding

In dit document worden de gebruikscases voor ECE 11.6 Chat API's beschreven.

Voorwaarden

Vereisten

Cisco raadt kennis van de volgende onderwerpen aan:

• ECE
• API

Gebruikte componenten

De informatie in dit document is gebaseerd op 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 live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Achtergrondinformatie

Gain heeft een klant onder ogen ziende API geïntroduceerd die kan worden gebruikt om de praatjesknop op de website van de klant te tonen of te verbergen.

ChatAPI's kunnen voor deze doeleinden worden gebruikt:

1. Geef de chat weer op basis van:

• Beschikbaarheid van agents
• Agent-capaciteit voor chats
• Queue-diepte en wachttijd
• Diepte van wachtrij en beschikbaarheid van agents
• Wachtwoorddiepte, wachttijd en status van ingangspunt

2. Voer aangepaste chatingenquêtes in.

Er zijn een paar gebruikscases die met de API kunnen worden gerealiseerd:

• De knop Chat kan worden ingeschakeld of uitgeschakeld op basis van de API-respons.
• Krijg de hoeveelheid tijd een klant moet wachten voordat een agent beschikbaar is om te chatten.
• Vind de positie van klant in een wachtrij om te schatten hoe lang een klant moet wachten voordat een agent beschikbaar is om te chatten.
• Schrijf nieuwe aangepaste enquêtes voor chat sessies om extra gegevens te verzamelen.

API voor beschikbaarheid van agents

De agent Availability API controleert of er agents beschikbaar zijn om de chats van een bepaald invoerpunt te nemen. Media Routing Domain (MRD)-beperkingen zijn van toepassing op de beschikbaarheid van de agent. Het wordt aanbevolen om de best practices sectie van MRD configuratie te doorlopen om de juiste resultaten weer te geven.

Aanvragen

Methode	URL
KRIJGEN	/chat/entrypoint/agentAvailability/id

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

URL-parameter

Name	Beschrijving	Type	Vereist	Standaardwaarde voor optionele parameters
ID	De ID van het invoerpunt waarvoor u de beschikbaarheid van de agent wilt controleren	lang	Ja

Succescodes

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

Foutcodes

500: Kan de beschikbaarheidsinformatie van de agent niet ophalen.

Respons Body

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

Capaciteit van agent API

Dit API haalt de capaciteit van alle agenten om aan nieuwe praatjeactiviteiten in de rij te werken die aan het bepaalde ingangspunt in kaart wordt gebracht. Het retourneert het verschil tussen de maximale lading (CTL) die alle agents kunnen nemen en de huidige lading van alle agents in de wachtrij van het entry point.

Aanvragen

Methode	URL
KRIJGEN	/chat/entrypoint/capacity/id

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

URL-parameter

Name	Beschrijving	Type	Vereist	Standaardwaarde voor optionele parameters
ID	De ID van het invoerpunt waarvoor u de agentcapaciteit wilt controleren	lang	Ja

Succescodes

200: De resterende capaciteit van agenten voor het ingangspunt wordt teruggegeven. Een positief getal geeft de resterende capaciteit weer. Nul betekent of er geen agenten beschikbaar in het systeem zijn, of alle agenten werken aan hun maximumlading.

Foutcodes

500: Kan de capaciteitsinformatie van de agent niet ophalen.

Respons Body

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 voor diepte en wachttijd van wachtrij

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

Aanvragen

Methode	URL
KRIJGEN	/chat/entrypoint/liveSessionStatus/id

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

URL-parameter

Name	Beschrijving	Type	Vereist	Standaardwaarde voor optionele parameters
ID	De ID van het invoerpunt waarvoor u de wachtrijdiepte en de wachttijd wilt controleren	lang	Ja

Succescodes

200: Wachtdiepte en wachttijd worden geretourneerd

Foutcodes

500: Kan de wachtrijdiepte niet ophalen en wacht op tijd.

Respons Body

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 voor diepte en beschikbaarheid van wachtrijen

Deze API controleert de geschiktheid van een chatingangspunt om nieuwe chatactiviteiten te verwerken op basis van deze voorwaarden:

• Als er agenten beschikbaar zijn om aan nieuwe praatjeactiviteiten te werken.
• Als de wachtrij die gekoppeld is aan dat ingangspunt de ingestelde maximale diepte heeft bereikt, dat wil zeggen het totale aantal chats die door de wachtrij worden 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 deze indeling gebruiken: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

URL-parameter

Name	Beschrijving	Type	Vereist	Standaardwaarde voor optionele parameters
ID	De ID van het invoerpunt waarvoor u de subsidiabiliteit wilt controleren	lang	Ja

Succescodes

200: Inschrijvingspunt beleenbaarheid wordt teruggegeven. responseType attribuut kan één van deze waarden hebben:

• 0: De wachtrij voor dit invoerpunt kan nieuwe chats verwerken.
• 1: Er is geen agent beschikbaar voor nieuwe chats.
• 2: De maximale wachtrijdiepte is bereikt voor de wachtrij die gekoppeld is aan het opgegeven ingangspunt en er worden geen nieuwe chats verwerkt.

Foutcodes

500: Kan de wachtrijdiepte niet ophalen en wacht op tijd.

Respons Body

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 voor wachtrijdiepte, beschikbaarheid en status van toegangspunt

Deze API controleert of nieuwe chats verwerkt kunnen worden door een bepaald chatingangspunt op basis van deze voorwaarden:

• Het invoerpunt voor chatten is actief.
• Als er agenten beschikbaar zijn om aan nieuwe praatjeactiviteiten te werken.
• Als de wachtrij die gekoppeld is aan dat ingangspunt de ingestelde maximale diepte heeft bereikt, dat wil zeggen het totale aantal chats die door de wachtrij worden 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 deze indeling gebruiken: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

URL-parameter

Name	Beschrijving	Type	Vereist	Standaardwaarde voor optionele parameters
ID	De ID van het invoerpunt waarvoor u wilt controleren of de chat is toegestaan	lang	Ja

Succescodes

200: Als nieuwe chats kunnen worden verwerkt door entry point, wordt deze code teruggestuurd. Dit wordt aangegeven door de waarde van de toegestane eigenschap. Deze eigenschap kan waarde of waar of vals hebben. Als de waarde vals is, kan attributenreden één van deze waarden hebben om de oorzaak van niet beschikbaarheid te identificeren:

• row_deep_reach: Maximale wachtrijdiepte is bereikt voor de wachtrij die gekoppeld is aan het gegeven ingangspunt en er wordt geen nieuwe chat verwerkt.
• agent_not_available: Er is geen agent beschikbaar om aan een nieuwe chat te werken.
• service_not_run: de taakservice van de agent is niet actief.
• Invalid_entry_point: Entry point dat in het request is doorgegeven is ongeldig.
• entry_point_inactive: Entry point dat in het verzoek wordt doorgegeven is niet actief.
• overig: Dit invoerpunt kan om andere redenen geen nieuwe chats verwerken.

Foutcodes

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

Respons Body

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 API voor chatonderzoek

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

Aanvragen

Methode	URL
POST	/chat/entrypoint/survey

Aanvraagorgaan

Name	Beschrijving	Type	Vereist
Vraag	Vraag die deel uitmaakt van de enquête die aan de klant wordt getoond	String	Ja
Antwoord	Antwoord op de desbetreffende vraag	String	Ja

Tekst voorbeeldverzoek

<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

2004: De enquête is met succes ingediend.