Comprensión de Enterprise Chat and Email (ECE) 11.6 Interfaz de programación de aplicaciones (API) de chat para clientes

Introducción

Este documento describe los casos prácticos de las API de chat ECE 11.6.

Prerequisites

Requirements

Cisco recomienda que tenga conocimiento sobre estos temas:

• ECE
• API

Componentes Utilizados

La información de este documento se basa en la norma ECE 11.6.

La información que contiene este documento se creó a partir de los dispositivos en un ambiente de laboratorio específico. Todos los dispositivos que se utilizan en este documento se pusieron en funcionamiento con una configuración verificada (predeterminada). Si tiene una red en vivo, asegúrese de entender el posible impacto de cualquier comando.

Antecedentes

Gain ha introducido una API orientada al cliente que se puede utilizar para mostrar u ocultar el botón de chat en el sitio web del cliente.

Las API de chat se pueden utilizar para los siguientes fines:

1. Mostrar el chat basado en:

• Disponibilidad del agente
• Capacidad del agente para chats
• Profundidad de cola y tiempo de espera
• Profundidad de la cola y disponibilidad del agente
• Profundidad de la cola, Tiempo de espera y Estado del punto de entrada

2. Envíe encuestas personalizadas por chat.

Hay algunos casos prácticos que se pueden realizar con la API:

• El botón Chat puede activarse o desactivarse en función de la respuesta de la API.
• Obtenga la cantidad de tiempo que un cliente tiene que esperar antes de que un agente esté disponible para chatear.
• Busque la posición del cliente en una cola para calcular cuánto tiempo debe esperar un cliente antes de que un agente esté disponible para conversar.
• Escriba nuevas encuestas personalizadas para las sesiones de chat a fin de recopilar datos adicionales.

API de disponibilidad de agentes

La API de disponibilidad de agentes comprueba si hay agentes disponibles para tomar los chats de un punto de entrada determinado. Se aplican restricciones de Dominio de routing de medios (MRD) para la disponibilidad del agente. Se recomienda ir a la sección de prácticas recomendadas de la configuración de MRD para reflejar los resultados correctos.

Petición

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

Nota: Para dirigir esta API debe utilizar este formato: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000

Parámetro de URL

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para parámetros opcionales
ID	El ID del punto de entrada para el que desea comprobar la disponibilidad del agente	largo	Yes

Códigos de éxito

200: se devuelve el estado de disponibilidad del agente. Una respuesta True significa que hay un agente disponible. Una respuesta falsa significa que no hay ningún agente disponible.

Códigos de Error

500: No se puede recuperar la información de disponibilidad del agente.

Cuerpo de respuesta

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 capacidad del agente

Esta API obtiene la capacidad de todos los agentes para trabajar en nuevas actividades de chat en la cola asignada al punto de entrada determinado. Devuelve la diferencia entre la carga máxima (CTL) que pueden soportar todos los agentes y la carga actual de todos los agentes en la cola del punto de entrada.

Petición

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

Nota: Para dirigir esta API debe utilizar este formato: http://hostname/system/egain/chat/entrypoint/capacity/1000

Parámetro de URL

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para parámetros opcionales
ID	ID del punto de entrada cuya capacidad de agente desea comprobar.	largo	Yes

Códigos de éxito

200: se devuelve la capacidad restante de los agentes para el punto de entrada. Un número positivo refleja la capacidad restante. Cero significa que no hay agentes disponibles en el sistema o que todos los agentes están trabajando hasta su carga máxima.

Códigos de Error

500: No se puede recuperar la información de capacidad del agente.

Cuerpo de respuesta

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 de profundidad de cola y tiempo de espera

Esta API se utiliza para obtener detalles del número de conversaciones en espera en la cola para la asignación y el tiempo de espera estimado en la cola.

Petición

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

Nota: Para dirigir esta API debe utilizar este formato: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000

Parámetro de URL

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para parámetros opcionales
ID	ID del punto de entrada para el que desea comprobar la profundidad de la cola y el tiempo de espera	largo	Yes

Códigos de éxito

200: Se devuelve la profundidad de la cola y el tiempo de espera

Códigos de Error

500: No se puede recuperar la profundidad de la cola y el tiempo de espera.

Cuerpo de respuesta

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 de disponibilidad y profundidad de cola

Esta API comprueba la idoneidad de un punto de entrada de chat para gestionar nuevas actividades de chat en función de estas condiciones:

• Si hay agentes disponibles para trabajar en nuevas actividades de chat.
• Si la cola asociada a ese punto de entrada ha alcanzado su profundidad máxima configurada, es decir, el número total de conversaciones que está procesando la cola es igual al número máximo de conversaciones que la cola puede procesar en un momento dado.

Petición

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

Nota: Para dirigir esta API debe utilizar este formato: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Parámetro de URL

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para parámetros opcionales
ID	El ID del punto de entrada para el que desea comprobar la idoneidad	largo	Yes

Códigos de éxito

200: Se devuelve la opción de punto de entrada. El atributo responseType puede tener cualquiera de estos valores:

• 0: la cola asociada a este punto de entrada puede manejar nuevos chats.
• 1: ningún agente está disponible para trabajar en nuevos chats.
• 2: Se ha alcanzado la profundidad máxima de la cola asociada con el punto de entrada especificado y no se procesan nuevos chats.

Códigos de Error

500: No se puede recuperar la profundidad de la cola y el tiempo de espera.

Cuerpo de respuesta

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 de estado de punto de entrada, disponibilidad y profundidad de cola

Esta API comprueba si un punto de entrada de chat determinado puede procesar nuevos chats en función de las siguientes condiciones:

• El punto de entrada de conversación está activo.
• Si hay agentes disponibles para trabajar en nuevas actividades de chat.
• Si la cola asociada a ese punto de entrada ha alcanzado su profundidad máxima configurada, es decir, el número total de conversaciones que está procesando la cola es igual al número máximo de conversaciones que la cola puede procesar en un momento dado.

Petición

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

Nota: Para dirigir esta API debe utilizar este formato: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Parámetro de URL

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para parámetros opcionales
ID	ID del punto de entrada para el que desea comprobar si se permite el chat	largo	Yes

Códigos de éxito

200: Si el punto de entrada puede procesar nuevos chats, se devuelve este código. Esto se identifica por el valor del atributo allowed. Este atributo puede tener el valor true o false. Si el valor es false, el atributo reason puede tener uno de estos valores para identificar la causa de la no disponibilidad:

• queue_depth_reach: se ha alcanzado la profundidad máxima de la cola para la cola asociada con el punto de entrada especificado y no se procesa ningún chat nuevo.
• agent_not_available: ningún agente está disponible para trabajar en un nuevo chat.
• service_not_running: El servicio de asignación de agente no se está ejecutando.
• invalid_entry_point: el punto de entrada pasado en la solicitud no es válido.
• entry_point_inactive: El punto de entrada pasado en la solicitud no está activo.
• other: Este punto de entrada no puede manejar nuevos chats debido a otras razones.

Códigos de Error

500: No se puede recuperar si este punto de entrada puede manejar nuevos chats.

Cuerpo de respuesta

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

O bien

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 de encuestas de chat personalizadas

Esta API se puede utilizar para enviar formularios de encuesta personalizados que se muestran al final de la sesión de chat.

Petición

Método	URL
POST	/chat/entrypoint/survey

Cuerpo de solicitud

Nombre	Descripción	Tipo	Necesario
Pregunta	Pregunta que forma parte de la encuesta que se muestra al cliente	String (cadena)	Yes
Respuesta	Respuesta a la pregunta correspondiente	String (cadena)	Yes

Cuerpo de solicitud de ejemplo

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

Códigos de éxito

204: la encuesta se ha enviado correctamente.