La conversation d'entreprise et envoient (CEE) le client 11.6 faisant face à l'interface de programmation de conversation (l'API)

Introduction

Ce document décrit les cas d'utilisation pour la conversation API CEE 11.6.

Conditions préalables

Conditions requises

Cisco vous recommande de prendre connaissance des rubriques suivantes :

• CEE

Composants utilisés

Les informations contenues dans ce document sont basées sur les versions de matériel et de logiciel suivantes :

• CEE 11.6

Les informations contenues dans ce document ont été créées à partir des périphériques d'un environnement de laboratoire spécifique. Tous les périphériques utilisés dans ce document ont démarré avec une configuration effacée (par défaut). Si votre réseau est vivant, assurez-vous que vous comprenez l'impact potentiel de n'importe quelle commande.

Informations générales

l'eGain a présenté un client faisant face à l'API qui peut être utilisé pour afficher ou masquer le bouton discussion sur le site Web des cutomer.

La conversation API peut être utilisée pour les buts suivants :

1. Affichez la conversation basée en fonction :

• Disponibilité d'agent
• Capacité d'agent pour des conversations
• Profondeur de la file d'attente et temps d'attente
• Profondeur de la file d'attente et Disponibilité d'agent
• État de point d'entrée de profondeur de la file d'attente, de temps d'attente et

2. Soumettez les enquêtes faites sur commande de conversation.

Il y a quelques cas d'utilisation qui peuvent être réalisés avec l'API :

• Le bouton discussion peut être activé ou des handicapés être basé sur la réponse API
• Obtenez la durée qu'un client doit attendre avant qu'un agent soit disponible pour causer
• Trouvez la position du client dans une file d'attente pour estimer combien de temps un client doit attendre avant qu'un agent soit disponible pour causer
• Écrivez les nouvelles analyses faites sur commande pour que les sessions de discussion capturent les informations supplémentaires

Disponibilité de l'agent API

La Disponibilité de l'agent API vérifie s'il y a des agents disponibles pour prendre les conversations d'un point d'entrée particulier. Les restrictions du routing domain de medias (MRD) s'appliquent pour la Disponibilité d'agent. Il est recommandé pour passer par la section de pratiques recommandées de la configuration MRD pour refléter les résultats corrects.

Demande

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

Remarque: Afin d'adresser cet API vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/agentAvilability/1000 

Paramètre URL

Nom	Description	Type	Requis	Valeur par défaut pour des paramètres optionnels
ID	L'ID du point d'entrée pour assurer lequel vous voulez examiner la Disponibilité d'agent	long	Oui

Codes de succès

200 : L'état de disponibilité d'agent est retourné. Une réponse vraie signifie qu'un agent est disponible. Une réponse fausse signifie qu'aucun agent n'est disponible.

Codes d'erreur

500 : Incapable de récupérer la Disponibilité de l'information d'agent.

Corps de réponse

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

Capacité API d'agent

Cet API cherche la capacité de tous les agents de travailler sur de nouvelles activités de conversation dans la file d'attente tracée au point d'entrée donné. Il renvoie la différence entre le chargement maximum (CTL) que tous les agents peuvent prendre et le chargement en cours de tous les agents dans la file d'attente du point d'entrée.

Demande

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

Remarque: Afin d'adresser cet API vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/capacity/1000 

Paramètre URL

Nom	Description	Type	Requis	Valeur par défaut pour des paramètres optionnels
ID	L'ID du point d'entrée pour assurer lequel vous voulez examiner la capacité d'agent	long	Oui

Codes de succès

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

Codes d'erreur

500 : Incapable de récupérer les informations de capacité d'agent.

Corps de réponse

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 la file d'attente et temps d'attente API

Cet API est utilisé pour obtenir des détails du nombre de conversations attendant dans la file d'attente pour l'affectation, et le temps d'attente prévu dans la file d'attente.

Demande

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

Remarque: Afin d'adresser cet API vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000 

Paramètre URL

Nom	Description	Type	Requis	Valeur par défaut pour des paramètres optionnels
ID	L'ID du point d'entrée pour assurer lequel vous voulez examiner la profondeur de la file d'attente et le temps d'attente	long	Oui

Codes de succès

200 : La profondeur de la file d'attente et le temps d'attente est retournée

Codes d'erreur

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

Corps de réponse

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 la file d'attente et Disponibilité API

Cet API vérifie l'éligibilité d'un point d'entrée de conversation pour manipuler de nouvelles activités de conversation basées sur les conditions suivantes :

• S'il y a tous les agents disponibles pour travailler à nouveau causent des activités
• Si la file d'attente associée avec ce point d'entrée a atteint sa profondeur maximum configurée c.-à-d. le nombre total de conversations traité par la file d'attente est égal au nombre maximal de conversations que la file d'attente peut traiter à n'importe quel moment donné

Demande

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

Remarque: Afin d'adresser cet API vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Paramètre URL

Nom	Description	Type	Requis	Valeur par défaut pour des paramètres optionnels
ID	L'ID du point d'entrée pour assurer lequel vous voulez examiner l'éligibilité	long	Oui

Codes de succès

200 : L'éligibilité de point d'entrée est retournée. l'attribut de responseType peut avoir des n'importe quelles des valeurs suivantes :

• 0 : La file d'attente associée avec ce point d'entrée peut manipuler de nouvelles conversations
• 1 : Aucun agent n'est disponible pour travailler à de nouvelles conversations
• 2 : La profondeur de la file d'attente maximum a été atteinte pour la file d'attente associée avec le point d'entrée indiqué et aucune nouvelle conversation ne sera traitée

Codes d'erreur

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

Corps de réponse

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

État API de point d'entrée de profondeur de la file d'attente, de Disponibilité et

Cet API vérifie si de nouvelles conversations peuvent être traitées par un point d'entrée donné de conversation basé sur les conditions suivantes :

• Le point d'entrée de conversation est en activité
• S'il y a tous les agents disponibles pour travailler à nouveau causent des activités
• Si la file d'attente associée avec ce point d'entrée a atteint sa profondeur maximum configurée c.-à-d. le nombre total de conversations traité par la file d'attente est égal au nombre maximal de conversations que la file d'attente peut traiter à n'importe quel moment donné

Demande

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

Remarque: Afin d'adresser cet API vous devez utiliser le format suivant : http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Paramètre URL

Nom	Description	Type	Requis	Valeur par défaut pour des paramètres optionnels
ID	L'ID du point d'entrée lequel vous voulez vérifier si la conversation est permise	long	Oui

Codes de succès

200 : Si de nouvelles conversations peuvent être traitées par le point d'entrée ce code est retourné. Ceci est identifié par la valeur de l'attribut permis. Cet attribut peut avoir la valeur vraie ou fausse. Si la valeur est fausse, la raison d'attribut peut avoir une des valeurs ci-dessous pour identifier la cause de l'indisponibilité :

• queue_depth_reached : La profondeur de la file d'attente de Maximm a atteint pour la file d'attente associée avec le point d'entrée indiqué et aucune nouvelle conversation ne sera traitée
• agent_not_available : Aucun agent n'est disponible pour travailler à la nouvelle conversation
• service_not_running : Le service d'affectation d'agent ne s'exécute pas
• invalid_entry_point : Le point d'entrée passé dans la demande est non valide
• entry_point_inactive : Le point d'entrée passé dans la demande n'est pas en activité
• autre : Ce point d'entrée ne peut pas manipuler de nouvelles conversations dues à d'autres raisons

Codes d'erreur

500 : Incapable de récupérer si ce point d'entrée peut manipuler de nouvelles conversations.

Corps de réponse

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

Enquête faite sur commande API de conversation

Cet API peut être utilisé pour soumettre les formes faites sur commande d'analyse affichées à l'extrémité de la session de discussion.

Demande

Méthode	URL
POST	/chat/entrypoint/survey

Corps de demande

Nom	Description	Type	Requis
Question	Question qui fait partie de l'analyse qui est affichée au client	Chaîne	Oui
Réponse	Réponse à la question correspondante	Chaîne	Oui

Corps de demande d'échantillon

<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 succès

204 : L'analyse est soumise avec succès.