Comprendere Enterprise Chat and Email (ECE) 11.6 API (Customer Facing Chat Application Programming Interface)

Introduzione

Questo documento descrive gli use case per le API Chat ECE 11.6.

Prerequisiti

Requisiti

Cisco raccomanda la conoscenza dei seguenti argomenti:

• ECE
• API

Componenti usati

Le informazioni fornite in questo documento si basano sulla norma ECE 11.6.

Le informazioni discusse in questo documento fanno riferimento a dispositivi usati in uno specifico ambiente di emulazione. Su tutti i dispositivi menzionati nel documento la configurazione è stata ripristinata ai valori predefiniti. Se la rete è operativa, valutare attentamente eventuali conseguenze derivanti dall'uso dei comandi.

Premesse

eGain ha introdotto un'API rivolta al cliente che può essere utilizzata per mostrare o nascondere il pulsante di chat sul sito Web del cliente.

Le API di chat possono essere utilizzate per i seguenti scopi:

1. Visualizza la chat in base a:

• Disponibilità agente
• Capacità agente per chat
• Profondità coda e tempo di attesa
• Profondità coda e disponibilità agente
• Profondità coda, tempo di attesa e stato punto di ingresso

2. Invia sondaggi chat personalizzati.

L'API può essere utilizzata in alcuni casi:

• Il pulsante Chat può essere abilitato o disabilitato in base alla risposta API.
• Ottenere il tempo di attesa di un cliente prima che un agente sia disponibile per la chat.
• Individuare la posizione del cliente in una coda per stimare il tempo di attesa di un cliente prima che un agente sia disponibile per la chat.
• Scrivere nuovi sondaggi personalizzati per le sessioni di chat per acquisire dati aggiuntivi.

API Disponibilità agente

L'API di disponibilità dell'agente verifica se sono disponibili agenti per eseguire le chat da un determinato punto di ingresso. Per la disponibilità dell'agente si applicano le restrizioni MRD (Media Routing Domain). Si consiglia di consultare la sezione sulle migliori pratiche della configurazione MRD per riflettere i risultati corretti.

Richiesta

Metodo	URL
OTTIENI	/chat/entrypoint/agentAvailability/id

Nota: per indirizzare questa API è necessario utilizzare questo formato: http://hostname/system/egain/chat/entrypoint/agentAvilability/1000

Parametro URL

Nome	Descrizione	Tipo	Obbligatorio	Valore predefinito per i parametri facoltativi
ID	ID del punto di ingresso per il quale si desidera verificare la disponibilità dell'agente	lungo	Sì

Codici di riuscita

200: viene restituito lo stato di disponibilità dell'agente. Una risposta True indica che è disponibile un agente. Una risposta falsa indica che non è disponibile alcun agente.

Codici di errore

500: impossibile recuperare le informazioni sulla disponibilità dell'agente.

Corpo risposta

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 capacità agente

Questa API recupera la capacità di tutti gli agenti di lavorare su nuove attività di chat nella coda mappata al punto di ingresso specificato. Restituisce la differenza tra il carico massimo (CTL) che tutti gli agenti possono assumere e il carico corrente di tutti gli agenti nella coda del punto di ingresso.

Richiesta

Metodo	URL
OTTIENI	/chat/entrypoint/capacity/id

Nota: per indirizzare questa API è necessario utilizzare questo formato: http://hostname/system/egain/chat/entrypoint/capacity/1000

Parametro URL

Nome	Descrizione	Tipo	Obbligatorio	Valore predefinito per i parametri facoltativi
ID	ID del punto di ingresso per il quale si desidera controllare la capacità dell'agente	lungo	Sì

Codici di riuscita

200: viene restituita la capacità rimanente degli agenti per il punto di ingresso. Un numero positivo riflette la capacità rimanente. Zero significa che non vi sono agenti disponibili nel sistema oppure che tutti gli agenti stanno lavorando al massimo carico.

Codici di errore

500: impossibile recuperare le informazioni sulla capacità dell'agente.

Corpo risposta

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 Profondità coda e tempo di attesa

Questa API viene utilizzata per ottenere i dettagli del numero di chat in attesa nella coda per l'assegnazione e il tempo di attesa stimato nella coda.

Richiesta

Metodo	URL
OTTIENI	/chat/entrypoint/liveSessionStatus/id

Nota: per indirizzare questa API è necessario utilizzare questo formato: http://hostname/system/egain/chat/entrypoint/liveSessionStatus/1000

Parametro URL

Nome	Descrizione	Tipo	Obbligatorio	Valore predefinito per i parametri facoltativi
ID	ID del punto di ingresso per il quale si desidera controllare la profondità della coda e il tempo di attesa	lungo	Sì

Codici di riuscita

200: vengono restituiti la profondità della coda e il tempo di attesa

Codici di errore

500. Impossibile recuperare la profondità della coda e il tempo di attesa.

Corpo risposta

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 Profondità coda e disponibilità

Questa API verifica l'idoneità di un punto di ingresso chat per gestire nuove attività chat in base alle seguenti condizioni:

• Se ci sono agenti disponibili per lavorare su nuove attività di chat.
• Se la coda associata al punto di ingresso ha raggiunto la profondità massima configurata, il numero totale di chat elaborate dalla coda è uguale al numero massimo di chat che la coda può elaborare in un determinato momento.

Richiesta

Metodo	URL
OTTIENI	/chat/entrypoint/checkEligibility/id

Nota: per indirizzare questa API è necessario utilizzare questo formato: http://hostname/system/egain/chat/entrypoint/checkEligibility/1000

Parametro URL

Nome	Descrizione	Tipo	Obbligatorio	Valore predefinito per i parametri facoltativi
ID	ID del punto di ingresso per il quale si desidera verificare l'idoneità	lungo	Sì

Codici di riuscita

200: viene restituita l'idoneità del punto di ingresso. L'attributo responseType può avere uno dei seguenti valori:

• 0: la coda associata a questo punto di ingresso può gestire nuove chat.
• 1: Nessun agente disponibile per lavorare su nuove chat.
• 2: è stata raggiunta la profondità massima della coda associata al punto di ingresso specificato e non sono state elaborate nuove chat.

Codici di errore

500. Impossibile recuperare la profondità della coda e il tempo di attesa.

Corpo risposta

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 Profondità coda, disponibilità e stato punto di ingresso

Questa API controlla se è possibile elaborare nuove chat da un determinato punto di ingresso della chat in base alle seguenti condizioni:

• Il punto di ingresso della chat è attivo.
• Se ci sono agenti disponibili per lavorare su nuove attività di chat.
• Se la coda associata al punto di ingresso ha raggiunto la profondità massima configurata, il numero totale di chat elaborate dalla coda è uguale al numero massimo di chat che la coda può elaborare in un determinato momento.

Richiesta

Metodo	URL
OTTIENI	/chat/entrypoint/chatAllowed/id

Nota: per indirizzare questa API è necessario utilizzare questo formato: http://hostname/system/egain/chat/entrypoint/chatAllowed/1000

Parametro URL

Nome	Descrizione	Tipo	Obbligatorio	Valore predefinito per i parametri facoltativi
ID	ID del punto di ingresso per il quale si desidera verificare se la chat è consentita	lungo	Sì

Codici di riuscita

200: se è possibile elaborare nuove chat per punto di ingresso, viene restituito questo codice. È identificato dal valore dell'attributo consentito. Il valore di questo attributo può essere true o false. Se il valore è false, il motivo dell'attributo può avere uno di questi valori per identificare la causa della mancata disponibilità:

• queue_depth_reach: la profondità massima della coda è stata raggiunta per la coda associata al punto di ingresso specificato e non viene elaborata alcuna nuova chat.
• agent_not_available: nessun agente disponibile per lavorare su una nuova chat.
• service_not_running: il servizio di assegnazione dell'agente non è in esecuzione.
• invalid_entry_point: il punto di ingresso passato nella richiesta non è valido.
• entry_point_inactive: il punto di ingresso passato nella richiesta non è attivo.
• altro: questo punto di ingresso non è in grado di gestire nuove chat per altri motivi.

Codici di errore

500: impossibile stabilire se il punto di ingresso può gestire nuove chat.

Corpo risposta

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

API sondaggio chat personalizzato

Questa API può essere utilizzata per inviare moduli di sondaggio personalizzati visualizzati al termine della sessione di chat.

Richiesta

Metodo	URL
POST	/chat/entrypoint/survey

Corpo richiesta

Nome	Descrizione	Tipo	Obbligatorio
Domanda	Domanda che fa parte del sondaggio visualizzato al cliente	Stringa	Sì
Rispondi	Risposta alla domanda corrispondente	Stringa	Sì

Corpo richiesta di esempio

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

Codici di riuscita

204: Invio del sondaggio completato.