Convenzioni
Di seguito le convenzioni utilizzate nella descrizione delle funzioni.
- nome_parametro: descrizione breve del parametro obbligatorio
- <nome_parametro>: descrizione breve del parametro opzionale
- ContactID: ID del contatto (telefonico/chat). Vi viene passato nella callback che avete registrato per mezzo del metodo AGENTDESKTOP.WIDGET.bindContactCallback
Gestione Contatto
Funzione |
Descrizione |
AGENTDESKTOP.CONTACT.MakeCall(String DestinationNumber, String <ResourceType>, String <ServiceID>, String <CallProfileID>, String <CallData>) |
Effettua una chiamata telefonica |
AGENTDESKTOP.CONTACT.Hangup() |
Abbatte una chiamata telefonica |
AGENTDESKTOP.CONTACT.Answer(String <ContactID>) |
Risponde ad un contatto in ingresso/fase di accettazione |
AGENTDESKTOP.CONTACT.OfflineEnd(String ContactID) |
Esce dallo stato Offline (After Call Work) di un contatto |
AGENTDESKTOP.CONTACT.HangupByContactID(String ContactID) |
Abbatte la chiamata telefonica con l'ID del contatto specificato |
AGENTDESKTOP.CONTACT.OfflineEnable(String ContactID, boolean bActive) |
Abilita/Disabilita pulsante di OFFLINE |
AGENTDESKTOP.CONTACT.SetCallData(String ContactID, String CallData) |
Setta una variabile di CallData |
AGENTDESKTOP.CONTACT.StartRecording(String ContactID, String <CallRecorders>, String <CallData>) |
Inizia registrazione chiamata telefonica |
AGENTDESKTOP.CONTACT.StopRecording(String ContactID, String <CallRecorders>) |
Interrompe registrazione chiamata telefonica |
Gestione WIDGET
Funzione |
Descrizione |
AGENTDESKTOP.WIDGET.getToken() |
Restituisce il token ottenuto dalla login SSO |
AGENTDESKTOP.WIDGET.getTokenOneShot() |
Restituisce il token OneShot ottenuto dalla login SSO |
AGENTDESKTOP.WIDGET.getContainerID() |
Restituisce l'ID del WIDGET |
AGENTDESKTOP.WIDGET.bindContactCallback(function callback) |
Effettua la bind di una vostra funzione al fine di ricevere le notifiche sui contatti in gestione. |
AGENTDESKTOP.WIDGET.unbindContactCallback(function callback) |
Effettua la unbind della vostra funzione |
AGENTDESKTOP.WIDGET.bindWidgetDataCallback(function callback) |
Effettua la bind di una vostra funzione al fine di ricevere le notifiche relative alla ricezione di dati custom da un altro Widget |
AGENTDESKTOP.WIDGET.unbindWidgetDataCallback(function callback) |
Effettua la unbind della vostra funzione |
AGENTDESKTOP.WIDGET.sendDataToWidget(String destinationWidgetID, String data) |
Invia dei dati custom ad un altro WIDGET (o paradossalmente anche a se stessi se si specifica il proprio ID) |
AGENTDESKTOP.WIDGET.addCustomMenu(JSON String menu) |
Inserisce un menu contestuale sul TAB di selezione del proprio WIDGET. Vedi sintassi JSON (vedi 9.4.1) |
AGENTDESKTOP.WIDGET.enableCustomMenuItem(String ItemID, boolean [true/false]) |
Abilita/Disabilita una singola voce di menu nel TAB di selezione del WIDGET |
AGENTDESKTOP.WIDGET.LOG(String testo) |
LOG: Scrive una propria stringa nel log applicativo di AgentDesktop situato in %appdata%\Reitek\Contact\BrowserPlugin |
AGENTDESKTOP.WIDGET.bindWidgetFocusCallback(function callback) |
Effettua la bind di una vostra funzione al fine di notificare al Widget la selezione dell'utente e la conseguente ricezione del Focus sul proprio Tab. |
AGENTDESKTOP.WIDGET.unbindWidgetFocusCallback (function callback) |
Effettua la unbind della vostra funzione |
AGENTDESKTOP.WIDGET.Reload(String < JumpToWidget>) |
Ricarica Widget |
AGENTDESKTOP.WIDGET.triggerContactCallback( String param) |
Scatena la vostra funzione di cui avete fatto la bind con bindContactCallback() |
AGENTDESKTOP.WIDGET.triggerWidgetDataCallback (String param) |
Scatena la vostra funzione di cui avete fatto la bind con bindWidgetDataCallback() |
AGENTDESKTOP.WIDGET. triggerWidgetFocusCallback(String param) |
Scatena la vostra funzione di cui avete fatto la bind con bindWidgetFocusCallback() |
AGENTDESKTOP.WIDGET.receiveDataFromWidget (String senderWidgetID, String data) |
Riceve dei dati custom ad un altro WIDGET |
AGENTDESKTOP.WIDGET.GetTimeStamp() |
Restituisce stringa contenente data e ora attuale nel formato: |
AGENTDESKTOP.WIDGET.getLanguage() |
Restituisce la lingua utilizzata in AgentDesktop. Esempio: "it", "en". |
AGENTDESKTOP.WIDGET.activateCustomMenuItem(String itemID, param) |
Permette di attivare la voce del menu contestuale con id itemID sul TAB di selezione del proprio WIDGET |
Sintassi JSON
Per inserire voci di menu all'interno di un TAB, deve essere indicata una struttura dati come di seguito indicata. Si otterrà un elemento grafico come in Figura 1.
Figura 1 - Menu all'interno di un tab
Elenco la sintassi del JSON:
{
"TabMenu": [
{
"id": "MYID1",
"title": "Repubblica",
"icon": "",
"url": "http://www.repubblica.it/"
},
{
"id": "MYID2",
"title": "IlSole24Ore",
"icon": "",
"url": "http://www.ilsole24ore.com/"
}
]
}
id: id univoco della singola voce del menu a vostra discrezione. Sarà utile per quando si vorrà disabilitare o abilitare la voce di menu per mezzo della funzione AGENTDESKTOP.WIDGET.enableCustomMenuItem
title: il titolo che si vuole avere visualizzato nel menu
icon: stringa che descrive la icona di Font-Awesome, nel formato "fa fa-XXXX"
url: indirizzo da caricare associato alla voce del menu contestuale
Esempio di gestione di un evento CTI
Gli eventi notificati da AD verso l'SDK hanno una struttura JSON, in cui la proprietà "event" descrive l'evento stesso.
Come esempio, osserviamo la sequenza di eventi notificati alla ricezione di un contatto inbound telefonico.
Tra di essi, una particolare attenzione si deve prestare verso l'evento di POPUP (del quale viene riportato il JSON completo) che determina il primo momento utile di presa in carico di un contatto da parte dell'operatore.
"event": "jobscheduled", |
.
Un eventuale integratore, dopo aver importato l'SDK (<script type="text/javascript" src="./agentdesktop_widget.js"></script>), dovrebbe effettuare la bind della funzione di callback:
AGENTDESKTOP.WIDGET.bindContactCallback(WidgetContactCallback);
Questa funzione può essere definita per intercettare e gestire certi titpi di eventi:
function WidgetContactCallback(jQuery_eventType, data) {
try {
var DataObj = null;
DataObj = JSON.parse(data);
if (DataObj.event == "AGENT:LOGGEDIN") {
// Operatore Loggato
}
if (DataObj.event == "AGENT:PAUSE") {
// Operatore in Pausa
}
if (DataObj.event == "POPUP") {
if (DataObj.isACD == true) {
// Gestione chiamata ACD, non manual
if (DataObj.type == "inbound") {
// Gestione chiamata inbound
}
if (DataObj.type == "outbound") {
// Gestione chiamata outbound
}
}
}
} catch (err_WidgetContactCallback) {
}
}
In particolare, la proprietà "media_type" indica il canale su cui sta viaggiando il contatto (telephony, chat, channel), la proprietà "type" indica la tipologia della chiamata (inbound, outbound, calltask), la proprietà "job_type" descrive la natura del contatto (manual/non manual), la proprietà "job_state" descrive lo stato in cui si trova il contatto (scheduled, setup, online, offline).
Si noti la differenza tra gli eventi che sono pura segnalazione SIP (connectionstarted, ringing, established, connectioncleared,…) da quelli che sono job, cioè che arricchiscono la segnalazione e fanno capire che l'operatore sta gestendo un contatto gestito dal Sistema (isACD = true) (jobscheduled, jobchenged, jobstarted, jobfinished).
Esempio di log
La loggata avrà il seguente formato:
"14/01/2015 - 14:57:52 [ID WIDGET] " + testo
Gestione TAB
Funzione |
Descrizione |
AGENTDESKTOP.TAB.Badge(String Badge) |
Imposta il Badge all'interno del Tab di selezione del WIDGET. Se stringa vuota il Badge viene cancellato |
AGENTDESKTOP.TAB.Focus() |
Sposta la selezione sul TAB del proprio WIDGET |
AGENTDESKTOP.TAB.Home() |
Sposta la selezione sul TAB di HOME di AGENTDESKTOP (il primo) |
AGENTDESKTOP.TAB.Add(String ID, String Title, String URL, String Icon) |
Permette di inserire voci di menu all'interno di un TAB |
AGENTDESKTOP.TAB.Remove(String ID) |
Rimuove voce di menu con ID specificato dal TAB |
AGENTDESKTOP.TAB.GoTo(String ID) |
Sposta la selezione sul TAB del WIDGET con l'ID specificato |
Finestre informative
Funzione |
Descrizione |
AGENTDESKTOP.ALERT.Notify(String Title, String Text, String Icon, Integer Timeout) |
Visualizza una finestra informativa specificando anche un tempo di visualizzazione. |
AGENTDESKTOP.ALERT.CustomDialog(String URL, Integer width, Integer heigth) |
Apre una finestra di dialogo custom ridimensionabile e trascinabile a piacere all'interno di AD. La finestra non può essere chiusa tramite interfaccia. |
AGENTDESKTOP.ALERT.CustomDialogClose() |
Chiude la finestra di dialogo custom aperta |
Gestione stato operatore
Funzione |
Descrizione |
AGENTDESKTOP.AGENT.PauseSubStateFilter(String filter) |
Permette di aggiungere un sottostato di pausa |
AGENTDESKTOP.AGENT.PauseSubState(String SubStateCode) |
Richiede sottostato di pausa indicato dal codice |
AGENTDESKTOP.AGENT.Login() |
Richiede stato disponibile per operatore |
AGENTDESKTOP.AGENT.Pause() |
Richiede stato di pausa per operatore |
AGENTDESKTOP.AGENT.getAgentID() |
Restituisce l'ID dell' operatore |
AGENTDESKTOP.AGENT.getMediaID() |
Restituisce l'ID del media |
AGENTDESKTOP.AGENT.getAgentState() |
Restituisce lo stato in cui si trova l'operatore |
Gestione chat
Funzione |
Descrizione |
AGENTDESKTOP.CHAT.SendText(String Text) |
TODO |
AGENTDESKTOP.CHAT.GetEvents(String ContactID) |
Restituisce array contenente lista di eventi per l'ID del contatto specificato |
Finestre di dialogo
Funzione |
Descrizione |
AGENTDESKTOP.UI.bindModalCallback(function callback) |
Effettua la bind di una vostra funzione al fine di gestire gli eventi relativi all'apertura/chiusura di finestre di dialogo |
AGENTDESKTOP.UI.unbindModalCallback(function callback) |
Effettua la unbind della vostra funzione |
AGENTDESKTOP.UI.triggerModalCallback(String param) |
Scatena la vostra funzione di cui avete fatto la bind con bindModalCallback() |