Comprendre le chat et l'e-mail d'entreprise (ECE) 11.6 Interface de programmation d'applications de chat (API) destinée au client

Introduction

Ce document décrit les cas d'utilisation des API de conversation ECE 11.6.

Conditions préalables

Exigences

Cisco vous recommande de prendre connaissance des rubriques suivantes :

• ECE
• API

Composants utilisés

Les informations contenues dans le présent document sont fondées sur la norme ECE 11.6.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. Si votre réseau est en ligne, assurez-vous de bien comprendre l’incidence possible des commandes.

Informations générales

eGain a introduit une API destinée au client qui peut être utilisée pour afficher ou masquer le bouton de conversation sur le site Web du client.

Les API de conversation peuvent être utilisées à ces fins :

1. Affichez la discussion en fonction des éléments suivants :

• Disponibilité des agents
• Capacité des agents pour les discussions
• Profondeur et durée d'attente
• Profondeur de la file et disponibilité des agents
• Profondeur de file d'attente, temps d'attente et état du point d'entrée

2. Soumettez des enquêtes personnalisées par chat.

Quelques exemples d'utilisation peuvent être réalisés avec l'API :

• Le bouton Discussion peut être activé ou désactivé en fonction de la réponse de l'API.
• Obtenir le temps d'attente d'un client avant qu'un agent ne soit disponible pour discuter.
• Trouvez la position d'un client dans une file d'attente pour estimer le temps d'attente d'un client avant qu'un agent ne soit disponible pour discuter.
• Rédiger de nouvelles enquêtes personnalisées pour les sessions de discussion afin de capturer des données supplémentaires.

API de disponibilité des agents

L'API de disponibilité de l'agent vérifie si des agents sont disponibles pour prendre les discussions à partir d'un point d'entrée particulier. Les restrictions MRD (Media Routing Domain) s'appliquent à la disponibilité des agents. Il est recommandé de passer par la section des meilleures pratiques de la configuration MRD pour refléter les résultats corrects.

Demande

Méthode	URL
GET	/chat/entrypoint/agentAvailability/id

Remarque : pour gérer cette API, vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/agentAvilability/1000

Paramètre d'URL

Nom	Description	Type	Requis	Valeur par défaut des paramètres facultatifs
ID	ID du point d'entrée pour lequel vous souhaitez vérifier la disponibilité de l'agent	désireux	Oui

Codes de réussite

200 : l'état de disponibilité de l'agent est renvoyé. Une réponse Vrai signifie qu'un agent est disponible. Une réponse erronée signifie qu'aucun agent n'est disponible.

Codes d'erreur

500 : Impossible de récupérer les informations de disponibilité de l'agent.

Organisme D'Intervention

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 de capacité d'agent

Cette API recherche la capacité de tous les agents à travailler sur de nouvelles activités de discussion dans la file d'attente mappée au point d'entrée donné. Elle renvoie la différence entre la charge maximale (CTL) que tous les agents peuvent prendre et la charge actuelle de tous les agents dans la file d'attente du point d'entrée.

Demande

Méthode	URL
GET	/chat/entrypoint/capacity/id

Remarque : pour gérer cette API, vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/capacity/1000

Paramètre d'URL

Nom	Description	Type	Requis	Valeur par défaut des paramètres facultatifs
ID	ID du point d'entrée pour lequel vous souhaitez vérifier la capacité de l'agent	désireux	Oui

Codes de réussite

200 : la capacité restante des agents pour le point d'entrée est renvoyée. Un nombre positif reflète la capacité restante. Zéro signifie qu'il n'y a aucun agent disponible dans le système ou que tous les agents fonctionnent à leur charge maximale.

Codes d'erreur

500 : Impossible de récupérer les informations de capacité de l'agent.

Organisme D'Intervention

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>

Profondeur de file d'attente et temps d'attente API

Cette API est utilisée pour obtenir des détails sur le nombre de conversations en attente dans la file d'attente pour l'affectation et le temps d'attente estimé dans la file d'attente.

Demande

Méthode	URL
GET	/chat/entrypoint/liveSessionStatus/id

Remarque : pour gérer cette API, vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000

Paramètre d'URL

Nom	Description	Type	Requis	Valeur par défaut des paramètres facultatifs
ID	ID du point d'entrée pour lequel vous souhaitez vérifier la profondeur de la file d'attente et le temps d'attente	désireux	Oui

Codes de réussite

200 : profondeur de la file d'attente et délai d'attente

Codes d'erreur

500 : Impossible de récupérer la profondeur de la file d'attente et le temps d'attente.

Organisme D'Intervention

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>

Profondeur de file d'attente et API de disponibilité

Cette API vérifie l'éligibilité d'un point d'entrée de chat pour gérer de nouvelles activités de chat en fonction des conditions suivantes :

• S'il y a des agents disponibles pour travailler sur de nouvelles activités de discussion.
• Si la file d'attente associée à ce point d'entrée a atteint sa profondeur maximale configurée, c'est-à-dire que le nombre total de conversations traitées par la file d'attente est égal au nombre maximal de conversations que la file d'attente peut traiter à un moment donné.

Demande

Méthode	URL
GET	/chat/entrypoint/checkEligibility/id

Remarque : pour gérer cette API, vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Paramètre d'URL

Nom	Description	Type	Requis	Valeur par défaut des paramètres facultatifs
ID	ID du point d'entrée pour lequel vous souhaitez vérifier l'admissibilité	désireux	Oui

Codes de réussite

200 : l'admissibilité au point d'entrée est renvoyée. L'attribut responseType peut avoir l'une des valeurs suivantes :

• 0 : la file d'attente associée à ce point d'entrée peut gérer les nouvelles discussions.
• 1 : Aucun agent n'est disponible pour travailler sur de nouvelles discussions.
• 2 : La profondeur maximale de la file d'attente a été atteinte pour la file d'attente associée au point d'entrée donné et aucune nouvelle conversation n'est traitée.

Codes d'erreur

500 : Impossible de récupérer la profondeur de la file d'attente et le temps d'attente.

Organisme D'Intervention

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

Profondeur de file d'attente, disponibilité et API d'état du point d'entrée

Cette API vérifie si de nouvelles discussions peuvent être traitées par un point d'entrée de discussion donné en fonction des conditions suivantes :

• Le point d'entrée de discussion est actif.
• S'il y a des agents disponibles pour travailler sur de nouvelles activités de discussion.
• Si la file d'attente associée à ce point d'entrée a atteint sa profondeur maximale configurée, c'est-à-dire que le nombre total de conversations traitées par la file d'attente est égal au nombre maximal de conversations que la file d'attente peut traiter à un moment donné.

Demande

Méthode	URL
GET	/chat/entrypoint/chatAllowed/id

Remarque : pour gérer cette API, vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Paramètre d'URL

Nom	Description	Type	Requis	Valeur par défaut des paramètres facultatifs
ID	ID du point d'entrée pour lequel vous souhaitez vérifier si la discussion est autorisée	désireux	Oui

Codes de réussite

200 : Si de nouvelles discussions peuvent être traitées par le point d'entrée, ce code est renvoyé. Ceci est identifié par la valeur de l'attribut autorisé. Cet attribut peut avoir la valeur true ou false. Si la valeur est false, l'attribut reason peut avoir l'une de ces valeurs pour identifier la cause de l'indisponibilité :

• queue_depth_reaché : la profondeur maximale de la file d'attente a été atteinte pour la file d'attente associée au point d'entrée donné et aucune nouvelle discussion n'est traitée.
• agent_not_available : aucun agent n'est disponible pour travailler sur une nouvelle discussion.
• service_not_running : le service d'affectation d'agent n'est pas en cours d'exécution.
• invalid_entry_point : le point d'entrée passé dans la demande n'est pas valide.
• entry_point_inactive : le point d'entrée passé dans la demande n'est pas actif.
• other : Ce point d'entrée ne peut pas gérer de nouvelles discussions pour d'autres raisons.

Codes d'erreur

500 : Impossible de savoir si ce point d'entrée peut gérer les nouvelles discussions.

Organisme D'Intervention

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

OU

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 d'enquête de conversation personnalisée

Cette API peut être utilisée pour envoyer des formulaires d'enquête personnalisés affichés à la fin de la session de discussion.

Demande

Méthode	URL
POST	/chat/entrypoint/survey

Corps de demande

Nom	Description	Type	Requis
Question	Question faisant partie de l'enquête qui est affichée au client	Chaîne (string)	Oui
Réponse	Réponse à la question correspondante	Chaîne (string)	Oui

Exemple de corps de demande

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

Codes de réussite

2004 : l'enquête a été envoyée.