Bate-papo da empresa e cliente 11.6 do email (ECE) que enfrenta a interface de programação de aplicativo do bate-papo (API)

Introdução

Este documento descreve os exemplos do uso para o bate-papo API ECE 11.6.

Pré-requisitos

Requisitos

A Cisco recomenda que você tenha conhecimento destes tópicos:

• ECE

Componentes Utilizados

As informações neste documento são baseadas nestas versões de software e hardware:

• ECE 11.6

As informações neste documento foram criadas a partir de dispositivos em um ambiente de laboratório específico. Todos os dispositivos utilizados neste documento foram iniciados com uma configuração (padrão) inicial. Se sua rede está viva, assegure-se de que você compreenda o impacto potencial do comando any.

Informações de Apoio

o eGain introduziu um cliente que enfrenta o API que pode ser usado para mostrar ou esconder o botão do bate-papo no site dos cutomer.

O bate-papo API pode ser usado para as seguintes finalidades:

1. Indique o bate-papo baseado sobre:

• Disponibilidade de agente
• Capacidade do agente para bate-papos
• Profundidade de fila e tempo de espera
• Profundidade de fila e disponibilidade de agente
• Estado da profundidade de fila, do tempo de espera e do ponto de entrada

2. Submeta avaliações feitas sob encomenda do bate-papo.

Há alguns casos do uso que podem ser realizados com o API:

• O botão do bate-papo pode ser permitido ou enfermos ser baseado na resposta API
• Obtenha a quantidade de tempo que um cliente tem que esperar antes que um agente esteja disponível para conversar
• Encontre a posição do cliente em uma fila para calcular quanto tempo um cliente tem que esperar antes que um agente esteja disponível para conversar
• Escreva avaliações feitas sob encomenda novas para que as sessões do bate-papo capturem dados adicionais

Disponibilidade de agente API

A disponibilidade de agente API verifica se há algum agente disponível para tomar os bate-papos de um ponto de entrada particular. As limitações do domínio de roteamento dos media (MRD) aplicam-se para a disponibilidade de agente. Recomenda-se atravessar a seção dos melhores prática da configuração MRD refletir os resultados corretos.

Requisição

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

Nota: A fim endereçar este API você tem que usar o seguinte formato: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000 

Parâmetro de URL

Nome	Descrição	Tipo	Necessário	Valor padrão para parâmetros opcionais
ID	O ID do ponto de entrada para ver se há que você quer verificar a disponibilidade de agente	por muito tempo	Sim

Códigos do sucesso

200: A disponibilidade de agente do estado é retornada. Uma resposta verdadeira significa que um agente está disponível. Uma resposta falsa significa que nenhum agente está disponível.

Códigos de erro

500: Incapaz de recuperar a disponibilidade de agente da informação.

Corpo da resposta

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

Capacidade API do agente

Este API busca a capacidade de todos os agentes trabalhar em atividades novas do bate-papo na fila traçada ao ponto de entrada dado. Retorna a diferença entre a carga máxima (CTL) que todos os agentes podem tomar e a carga atual de todos os agentes na fila do ponto de entrada.

Requisição

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

Nota: A fim endereçar este API você tem que usar o seguinte formato: http://hostname/system/egain/chat/entrypoint/capacity/1000 

Parâmetro de URL

Nome	Descrição	Tipo	Necessário	Valor padrão para parâmetros opcionais
ID	O ID do ponto de entrada para ver se há que você quer verificar a capacidade do agente	por muito tempo	Sim

Códigos do sucesso

200: A capacidade restante de agentes para o ponto de entrada é retornada. Um número positivo reflete a capacidade restante. Zero significam que ou não há nenhum agente disponível no sistema, ou todos os agentes estão trabalhando a sua carga máxima.

Códigos de erro

500: Incapaz de recuperar a informação de capacidade do agente.

Corpo da resposta

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>

Profundidade de fila e tempo de espera API

Este API é usado para obter detalhes do número de bate-papos que esperam na fila para a atribuição, e o tempo de espera calculado na fila.

Requisição

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

Nota: A fim endereçar este API você tem que usar o seguinte formato: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000 

Parâmetro de URL

Nome	Descrição	Tipo	Necessário	Valor padrão para parâmetros opcionais
ID	O ID do ponto de entrada para ver se há que você quer verificar a profundidade de fila e o tempo de espera	por muito tempo	Sim

Códigos do sucesso

200: A profundidade de fila e o tempo de espera são retornados

Códigos de erro

500: Incapaz de recuperar a profundidade de fila e o tempo de espera.

Corpo da resposta

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>

Profundidade de fila e Disponibilidade API

Este API verifica a aptidão de um ponto de entrada do bate-papo para segurar as atividades novas do bate-papo baseadas nas seguintes circunstâncias:

• Se há todos os agentes disponíveis para trabalhar em novo conversam atividades
• Se a fila associada com esse ponto de entrada alcançou sua máxima configurada de profundidade isto é o número total de bate-papos que está sendo processado pela fila é igual ao número máximo de bate-papos que a fila pode processar em algum momento dado

Requisição

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

Nota: A fim endereçar este API você tem que usar o seguinte formato: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Parâmetro de URL

Nome	Descrição	Tipo	Necessário	Valor padrão para parâmetros opcionais
ID	O ID do ponto de entrada para ver se há que você quer verificar a aptidão	por muito tempo	Sim

Códigos do sucesso

200: A aptidão do ponto de entrada é retornada. o atributo do responseType pode ter qualquer dos seguintes valores:

• 0: A fila associada com este ponto de entrada pode segurar bate-papos novos
• 1: Nenhum agente está disponível para trabalhar em bate-papos novos
• 2: O Maximum Queue Depth foi alcançado para a fila associada com o ponto de entrada dado e nenhum bate-papo novo será processado

Códigos de erro

500: Incapaz de recuperar a profundidade de fila e o tempo de espera.

Corpo da resposta

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

Estado API da profundidade de fila, da Disponibilidade e do ponto de entrada

Este API verifica se os bate-papos novos podem ser processados por um ponto de entrada dado do bate-papo baseado nas seguintes circunstâncias:

• O ponto de entrada do bate-papo é ativo
• Se há todos os agentes disponíveis para trabalhar em novo conversam atividades
• Se a fila associada com esse ponto de entrada alcançou sua máxima configurada de profundidade isto é o número total de bate-papos que está sendo processado pela fila é igual ao número máximo de bate-papos que a fila pode processar em algum momento dado

Requisição

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

Nota: A fim endereçar este API você tem que usar o seguinte formato: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Parâmetro de URL

Nome	Descrição	Tipo	Necessário	Valor padrão para parâmetros opcionais
ID	O ID do ponto de entrada para ver se há que você quer verificar se o bate-papo é permitido	por muito tempo	Sim

Códigos do sucesso

200: Se os bate-papos novos podem ser processados pelo ponto de entrada este código está retornado. Isto é identificado pelo valor do atributo permitido. Este atributo pode ter o valor verdadeiro ou falso. Se o valor é falso, a razão do atributo pode ter um dos valores abaixo para identificar a causa da indisponibilidade:

• queue_depth_reached: A profundidade de fila de Maximm alcançou para a fila associada com o ponto de entrada dado e nenhum bate-papo novo será processado
• agent_not_available: Nenhum agente está disponível para trabalhar no bate-papo novo
• service_not_running: O serviço da atribuição do agente não está sendo executado
• invalid_entry_point: O ponto de entrada passado no pedido é inválido
• entry_point_inactive: O ponto de entrada passado no pedido não é ativo
• outro: Este ponto de entrada não pode segurar os bate-papos novos devido a outras razões

Códigos de erro

500: Incapaz de recuperar se este ponto de entrada pode segurar bate-papos novos.

Corpo da resposta

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

Avaliação feita sob encomenda API do bate-papo

Este API pode ser usado para submeter os formulários feitos sob encomenda da avaliação mostrados no fim da sessão do bate-papo.

Requisição

Método	URL
POST	/chat/entrypoint/survey

Corpo do pedido

Nome	Descrição	Tipo	Necessário
Pergunta	Pergunta que é parte da avaliação que é indicada ao cliente	Série	Sim
Resposta	Resposta à pergunta correspondente	Série	Sim

Corpo do pedido da amostra

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

204: A avaliação é submetida com sucesso.