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/multimediale). Identifica in modo univoco ciascun contatto in gestione sulla postazione operatore.
Gestione Contatto
Funzione | Descrizione |
---|---|
AGENTDESKTOP.CONTACT.MakeCall String DestinationNumber, String <ResourceType>, String <ServiceID>, String <CallProfileID>, String <CallData> | Effettua una chiamata telefonica. E' possibile specificare i seguenti parametri aggiuntivi:
|
AGENTDESKTOP.CONTACT.Hangup String <ContactID> | Conclude la fase online di un contatto telefonico o chat terminando la conversazione in corso. |
AGENTDESKTOP.CONTACT.HangupByContactID String ContactID | Conclude la fase online del contatto avente come identificativo il valore del parametro "ContactID" |
AGENTDESKTOP.CONTACT.Hold String ContactID | Mette o riprende dallo stato di attesa una chiamata telefonica. |
AGENTDESKTOP.CONTACT.Answer String ContactID | Risponde ad un contatto in ingresso/fase di accettazione sulla postazione operatore. |
AGENTDESKTOP.CONTACT.OfflineEnd String ContactID | Esce dallo stato offline (After Call Work) di un contatto e termina la fase di gestione del contatto stesso. |
AGENTDESKTOP.CONTACT.OfflineEnable String ContactID, Boolean Active | Abilita/Disabilita pulsante di offline presente sulla toolbar principale. |
AGENTDESKTOP.CONTACT.SetCallData String ContactID, String CallData | Imposta una variabile di CallData associata al contatto. Le variabili di CallData consentono di memorizzare sul singolo contatto dei dati personalizzati nel formato chiave=valore. AGENTDESKTOP.CONTACT.SetCallData("2d-5e5fbc28@B2BUAEP.enghouse.com", "CUSTOMERID=12345"); |
AGENTDESKTOP.CONTACT.StartRecording String ContactID, String <CallRecorders>, String <CallData> | Richiede la registrazione della chiamata telefonica. E' possibile specificare l'identificativo di un Registratore configurato sul sistema CTI. |
AGENTDESKTOP.CONTACT.StopRecording String ContactID, String <CallRecorders> | Interrompe la registrazione in corso della chiamata telefonica. |
AGENTDESKTOP.CONTACT.PlayDTMF String DTMF | Riproduce uno o più toni DTMF sulla chiamata in corso. AGENTDESKTOP.CONTACT.PlayDTMF("1#"); |
AGENTDESKTOP.CONTACT.Transfer_Direct String ContactID, String Destination, String ResourceType | Richiede il trasferimento diretto di una telefonata. Come destinazione del trasferimento è possibile specificare una delle seguenti tipologie di risorsa: Destination:
ResourceType:
|
AGENTDESKTOP.CONTACT.Transfer_Consultation String ContactID, String DestinationNumber, String ResourceType, String CallProfileID, String CallData | Richiede il trasferimento con consultazione di una telefonata. La telefonata del cliente in linea verrà messa in attesa e l'operatore verrà automaticamente rediretto verso la chiamata di consultazione con la numerazione specificata nel parametro DestinationNumber. CallProfileID: identificativo di un profilo di chiamata configurato sul sistema CTI CallData: eventuale CallData aggiuntivo che deve essere creato al momento del trasferimento. |
AGENTDESKTOP.CONTACT.Transfer_Complete String ResourceType, String <CallData> | Viene richiesto il completamento della chiamata di consultazione ed il trasferimento della telefonata verso il destinatario della consultazione. |
AGENTDESKTOP.CONTACT.Transfer_Complete_Conference String ResourceType | Viene richiesto il completamento della chiamata di consultazione mediante la instaurazione di una conference a tre partecipanti: cliente in linea, operatore che ha gestito la telefonata e destinatario della consultazione. |
Gestione WIDGET
Funzione | Descrizione |
AGENTDESKTOP.WIDGET.getToken | Restituisce il token ottenuto dalla login Single Sign On di EasyCIM |
AGENTDESKTOP.WIDGET.getTokenOneShot | Restituisce il token OneShot ottenuto dalla login Single Sign On di EasyCIM |
AGENTDESKTOP.WIDGET.getContainerID | Restituisce l'identificativo del WIDGET definito in fase di configurazione. |
AGENTDESKTOP.WIDGET.bindContactCallback(javascript function) | Effettua la bind di una propria funzione javascript al fine di ricevere le notifiche sui contatti in gestione. |
AGENTDESKTOP.WIDGET.unbindContactCallback(javascript function) | Effettua la unbind della vostra funzione |
AGENTDESKTOP.WIDGET.bindWidgetDataCallback(function function) | Effettua la bind di una propria funzione javascript al fine di ricevere le notifiche relative alla ricezione di dati custom da parte di 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 identificato nel parametro destinationWidgetID (o paradossalmente anche a se stessi se si specifica il proprio ID) E' possibile inviare anche dati strutturati come array ed oggetti anche se è fortemente raccomandato convertirli in formato stringa mediante l'utilizzo dell'istruzione JSON.stringify. |
AGENTDESKTOP.WIDGET.sendDataToAllWidget String data | Invia dei dati custom a tutti i Widget presenti in AgentDesktop, sia di primo livello sia quelli caricati all'interno di ciascun contatto nel Widget Multi-Contatto. Alla ricezione del data sul singolo Widget verrà risvegliata la callback custom agganciata mediante il metodo AGENTDESKTOP.WIDGET.bindWidgetDataCallback |
AGENTDESKTOP.WIDGET.sendDataToMultiContactWidget String destinationMultiContactWidgetID, String data | Invia dei dati custom ad un singolo Widget caricato in una scheda o tab del Multi-Contatto. NOTA: L'invio dei dati tra Widgets avverrà solo all'interno del contesto del singolo contatto in gestione e non potrà essere propagato cross-tab, ovverosia tra contatti differenti in gestione all'operatore. |
AGENTDESKTOP.WIDGET.addCustomMenu JSON String menu | Inserisce un menu contestuale sul TAB di selezione del proprio WIDGET. Il menu deve avere la seguente struttura JSON: { |
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 | Consente ad un Widget di scrivere all'interno dei log applicativi di AgentDesktop situati in %appdata%\Reitek\Contact\BrowserPlugin. Ogni loggata sarà preceduta dal timestamp generato automaticamente e dall'identificativo del Widget che ha generato la riga di log: 30/04/2020 - 15:09:22.153 [AGENTDESKTOP_WIDGET_AGENDA] <testo> |
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 il contenuto del Widget |
AGENTDESKTOP.WIDGET.GetTimeStamp() | Restituisce stringa contenente data e ora attuale nel formato: dd/mm/yyyy – hh:mm:ss |
AGENTDESKTOP.WIDGET.getLanguage | Restituisce la lingua utilizzata in AgentDesktop. Esempio: "it", "en". |
Gestione TAB
Funzione | Descrizione |
---|---|
AGENTDESKTOP.TAB.Badge(String Badge) | Imposta il Badge all'interno del Tab di selezione del Widget. Se il parametro stringa è vuoto 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 |
AGENTDESKTOP.TAB.Add(String ID, String Title, String URL, String Icon) | Aggiunge dinamicamente da codice un nuovo Widget di primo livello. |
AGENTDESKTOP.TAB.Remove(String ID) | Rimuove il Widget il cui ID è specificato dal parametro stringa. |
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 ma mediante API dedicata.
|
AGENTDESKTOP.ALERT.CustomDialogClose() | Chiude la finestra di dialogo custom aperta |
Gestione dello Stato dell'Operatore
Funzione | Descrizione |
---|---|
AGENTDESKTOP.AGENT.PauseSubStateFilter(String filter) | Permette di aggiungere un filtro alla visualizzazione dei sottostati di pausa riservati all'operatore. Il filtro è rappresentato mediante regular expression. |
AGENTDESKTOP.AGENT.PauseSubState(String SubStateCode) | Richiede il sottostato di pausa indicato dal codice SubStateCode |
AGENTDESKTOP.AGENT.Login | Richiede la login (disponibile) per l'operatore |
AGENTDESKTOP.AGENT.Pause | Richiede stato di pausa per l'operatore |
AGENTDESKTOP.AGENT.getAgentID | Restituisce l'identificativo completo dell' operatore (esempio: agent1@acd.engouse.com) |
AGENTDESKTOP.AGENT.getMediaID | Restituisce l'identificativo completo del media attestato sull'operatore (esempio: 80400@B2BUAEP.enghouse.com) |
AGENTDESKTOP.AGENT.getAgentState | Restituisce lo stato in cui si trova l'operatore. Possono essere restituiti i seguenti valori:
|
AGENTDESKTOP.AGENT.getGroups | Restituisce un array di tutti i Gruppi di lavoro visibili all'operatore. Ciascun elemento dell'array ha le seguenti proprietà:
|
AGENTDESKTOP.AGENT.getAgentGroups | Restituisce un array di tutti i Gruppi di lavoro dove risulta loggato l'operatore. Il formato dell'array è identico a quello del metodo AGENTDESKTOP.AGENT.getGroups. |
AGENTDESKTOP.AGENT.getAgentName | Restituisce il nome dell'operatore come da configurazione sul sistema ContaCT7 |
AGENTDESKTOP.AGENT.getAgentSurname | Restituisce il cognome dell'operatore come da configurazione sul sistema ContaCT7 |
AGENTDESKTOP.AGENT.setAgentGroups(String Groups) | Modifica i Gruppi di lavoro associati all'operatore. Il parametro Groups è una stringa contenente la lista di tutti gli identificativi separati da ";" |
Gestione Chat CTLive
Funzione | Descrizione |
---|---|
AGENTDESKTOP.CHAT.SendText String Text | Invia un messaggio testuale verso la chat in gestione all'interno del Tab/Scheda corrente del Widget MultiContatto |
AGENTDESKTOP.CHAT.GetEvents String ContactID | Restituisce un array contenente lista di eventi intercorsi per l'identificativo della chat specificato dal parametro ContactID |
Funzionalità avanzate sulla User Interface
Funzione | Descrizione |
---|---|
AGENTDESKTOP.UI.bindModalCallback(function javascript) | Effettua la bind di una propria funzione al fine di essere notificati sugli eventi relativi all'apertura/chiusura di finestre di dialogo in AgentDesktop. Questa funzionalità è utile per conoscere e venire informati ogni volta che l'operatore clicca ed apre alcuni pannelli di gestione come per esempio "Gestione Gruppi di lavoro" o la maschera dei "Trasferimenti". |
AGENTDESKTOP.UI.unbindModalCallback(function javascript) | Effettua la unbind della vostra funzione |