La charla de la empresa y envía por correo electrónico (ECE) al cliente 11.6 que hace frente a la interfaz de programación de aplicaciones de la charla (el API)

Introducción

Este documento describe los casos del uso para la charla API ECE 11.6.

Prerrequisitos

Requisitos

Cisco recomienda que tenga conocimiento sobre estos temas:

• ECE

Componentes Utilizados

La información que contiene este documento se basa en las siguientes versiones de software y hardware.

• 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 su red está viva, asegúrese de que usted entienda el impacto potencial del comando any.

Antecedentes

el eGain ha presentado a un cliente que hacía frente al API que se puede utilizar para mostrar o para ocultar el botón de la charla en el sitio web de los cutomer.

La charla API se puede utilizar para los propósitos siguientes:

1. Visualice la charla basada encendido:

• Disponibilidad del agente
• Capacidad del agente para las charlas
• Profundidad de espera en cola y tiempo de espera
• Profundidad de espera en cola y disponibilidad del agente
• Estatus de la profundidad de espera en cola, del tiempo de espera y del punto de entrada

2. Someta las encuestas sobre de encargo la charla.

Hay algunos casos del uso que se pueden observar con el API:

• El botón de la charla se puede ser habilitado o los minusválidos basar en la respuesta API
• Consiga la cantidad de tiempo que un cliente tiene que esperar antes de que un agente esté disponible charlar
• Encuentre la posición del cliente en una cola para estimar cuánto tiempo un cliente tiene que esperar antes de que un agente esté disponible charlar
• Escriba las nuevas encuestas de encargo para que las sesiones de la charla capturen los datos adicionales

Disponibilidad del agente API

La disponibilidad del agente API marca si hay algunos agentes disponibles tomar las charlas de una punta de la entrada determinada. Las restricciones del dominio de ruteo de los media (milirutherford) solicitan la disponibilidad del agente. Se recomienda para pasar a través de la sección de las mejores prácticas de la configuración milirutherford reflejar los resultados correctos.

Petición

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

Nota: Para dirigir este API usted tiene que utilizar el formato siguiente: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000 

Parámetro url

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para los parámetros optativos
ID	El ID del punto de entrada para saber si hay el cual usted quiere marcar la disponibilidad del agente	de largo	Sí

Códigos del éxito

200: Se vuelve la disponibilidad del agente del estatus. Una respuesta verdadera significa que un agente está disponible. Una respuesta falsa significa que no hay agente disponible.

Códigos de Error

500: Incapaz de extraer la disponibilidad del agente de la información.

Cuerpo de la 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"/>

Capacidad API del agente

Este API trae la capacidad de todos los agentes de trabajar en las nuevas actividades de la charla en la cola asociada al punto de entrada dado. Vuelve la diferencia entre la carga máxima (CTL) que todos los agentes pueden tomar 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 este API usted tiene que utilizar el formato siguiente: http://hostname/system/egain/chat/entrypoint/capacity/1000 

Parámetro url

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para los parámetros optativos
ID	El ID del punto de entrada para saber si hay el cual usted quiere marcar la capacidad del agente	de largo	Sí

Códigos del éxito

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

Códigos de Error

500: Incapaz de extraer la información de capacidad del agente.

Cuerpo de la 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>

Profundidad de espera en cola y tiempo de espera API

Este API se utiliza para conseguir los detalles del número de charlas que esperan 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 este API usted tiene que utilizar el formato siguiente: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000 

Parámetro url

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para los parámetros optativos
ID	El ID del punto de entrada para saber si hay el cual usted quiere marcar la profundidad de espera en cola y el tiempo de espera	de largo	Sí

Códigos del éxito

200: Se vuelve la profundidad de espera en cola y el tiempo de espera

Códigos de Error

500: Incapaz de extraer la profundidad de espera en cola y el tiempo de espera.

Cuerpo de la 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>

Profundidad de espera en cola y Disponibilidad API

Este API marca la elegibilidad de un punto de entrada de la charla para manejar las nuevas actividades de la charla basadas en las condiciones siguientes:

• Si hay cualquier agente disponible trabajar en nuevo charla las actividades
• Si la cola asociada a ese punto de entrada ha alcanzado su Máximo configurado de profundidad es decir el número total de charlas que es procesado por la cola es igual al número máximo de charlas que la cola pueda procesar en cualquier punta del tiempo dada

Petición

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

Nota: Para dirigir este API usted tiene que utilizar el formato siguiente: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Parámetro url

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para los parámetros optativos
ID	El ID del punto de entrada para saber si hay el cual usted quiere marcar la elegibilidad	de largo	Sí

Códigos del éxito

200: Se vuelve la elegibilidad del punto de entrada. el atributo del responseType puede tener de los valores siguientes:

• 0: La cola asociada a este punto de entrada puede manejar las nuevas charlas
• 1: No hay agente disponible trabajar en las nuevas charlas
• 2: El Maximum Queue Depth se ha alcanzado para la cola asociada al punto de entrada dado y no se procesará ningunas nuevas charlas

Códigos de Error

500: Incapaz de extraer la profundidad de espera en cola y el tiempo de espera.

Cuerpo de la 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 />

Estatus API de la profundidad de espera en cola, de la Disponibilidad y del punto de entrada

Este API marca si las nuevas charlas se pueden procesar por un punto de entrada dado de la charla basado en las condiciones siguientes:

• El punto de entrada de la charla es activo
• Si hay cualquier agente disponible trabajar en nuevo charla las actividades
• Si la cola asociada a ese punto de entrada ha alcanzado su Máximo configurado de profundidad es decir el número total de charlas que es procesado por la cola es igual al número máximo de charlas que la cola pueda procesar en cualquier punta del tiempo dada

Petición

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

Nota: Para dirigir este API usted tiene que utilizar el formato siguiente: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Parámetro url

Nombre	Descripción	Tipo	Necesario	Valor predeterminado para los parámetros optativos
ID	El ID del punto de entrada para saber si hay el cual usted quiere marcar si se permite la charla	de largo	Sí

Códigos del éxito

200: Si las nuevas charlas se pueden procesar por el punto de entrada se vuelve este código. Esto es identificada por el valor del atributo permitido. Este atributo puede tener valor verdad o falso. Si el valor es falso, la razón del atributo puede tener uno de los valores abajo para identificar la causa de la indisponibilidad:

• queue_depth_reached: La profundidad de espera en cola de Maximm ha alcanzado para la cola asociada al punto de entrada dado y no se procesará ninguna nueva charla
• agent_not_available: No hay agente disponible trabajar en la nueva charla
• el service_not_running: El servicio de la asignación del agente no se está ejecutando
• invalid_entry_point: El punto de entrada pasajero en la petición es inválido
• entry_point_inactive: El punto de entrada pasajero en la petición no es activo
• otro: Este punto de entrada no puede manejar las nuevas charlas debido a otras razones

Códigos de Error

500: Incapaz de extraer si este punto de entrada puede manejar las nuevas charlas.

Cuerpo de la 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

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

Encuesta sobre de encargo API la charla

Este API se puede utilizar para presentar los impresos de encargo de la encuesta mostrados en el final de la sesión de la charla.

Petición

Método	URL
POST	/chat/entrypoint/survey

Cuerpo de la petición

Nombre	Descripción	Tipo	Necesario
Pregunta	Pregunta que es parte de la encuesta que se visualiza al cliente	String (cadena)	Sí
Respuesta	Respuesta a la pregunta correspondiente	String (cadena)	Sí

Cuerpo de la petición de la muestra

<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 del éxito

204: La encuesta se somete con éxito.