INDICE
Connettore Webhook
Setera OneCloud dispone di un Connettore Webhook per ciascuna organizzazione.
Tale connettore permette di inviare i dati relativi alle chiamate degli utenti in tempo reale da Setera verso un sistema terzo come CRM o ERP.
NOTE:
- Il connettore Webhook non invia alcun dato relativo ai numeri di funzione come IVR, ACD, Hunt Group ecc...
- Il connettore Webhook ha effetto solo sulle chiamate effettuate/ricevute dagli utenti.
Dati inclusi:
- Numero chiamante
- Date e ora della chiamata in uscita seguita da fuso orario UTC
- Stato corrente della chiamata
- Indirizzo Email del chiamante
- User ID del chiamante
- Dispositivo utilizzato dal quale è stata effettuata/ricevuta la chiamata
- Numero chiamato
- Indirizzo Email del chiamato
- User ID del chiamato
Il Webhook invierà questi dati come richiesta HTTPS POST
con payload in formato JSON verso un URL che dovrai fornire al tuo referente tecnico Setera, insieme agli utenti indicati per il monitoraggio.
Per ogni chiamata vengono inviate più notifiche in momenti distinti, ciascuna contenente un singolo oggetto JSON che rappresenta uno specifico stato della chiamata.
Dati di Esempio
Esempio chiamata in ingresso
In questo esempio, l'utente OneCloud (setera.test@seteratesting.fi, +35894272XXXX) riceve una chiamata sulla sua applicazione Softphone dal numero +35840940XXXX.
Il sistema invierà quindi al tuo endpoint richieste HTTPS POST
separate, ciascuna con un payload JSON relativo allo stato attuale della chiamata.
Di seguito un esempio di sequenza tipica per una chiamata in ingresso:
- Sequenza 1: Chiamata in arrivo (EARLY)
{ "seq_num": 1, "call_id": "tvNAazZlEwDZTCO74Pk95Q", "branch_id": "L1FIItkNwW0.", "timestamp": "2021-09-30T10:36:19.315+00:00", "state": "EARLY", "direction": "INCOMING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
- Sequenza 2: L'utente risponde (CONFIRMED)
{ "seq_num": 2, "call_id": "tvNAazZlEwDZTCO74Pk95Q", "branch_id": "L1FIItkNwW0.", "timestamp": "2021-09-30T10:36:21.970+00:00", "state": "CONFIRMED", "direction": "INCOMING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
- Sequenza 3: Chiamata terminata (TERMINATED)
{ "seq_num": 3, "call_id": "tvNAazZlEwDZTCO74Pk95Q", "branch_id": "L1FIItkNwW0.", "timestamp": "2021-09-30T10:36:26.018+00:00", "state": "TERMINATED", "termination-reason": "HANGUP", "direction": "INCOMING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
Esempio chiamata in uscita
In questo esempio, l'utente OneCloud (setera.test@seteratesting.fi, +35894272XXXX) effettua una chiamata in uscita dalla sua applicazione Softphone verso il numero +35840940XXXX.
Come per la chiamata in ingresso, l'Endpoint riceve li dati per ciascun avvenimento:
- Sequenza 1: Chiamata in uscita (EARLY)
{ "seq_num": 1, "call_id": "lbDc8Xh8eqzweI1BOr8apg", "branch_id": "VrcWMeJVUDc.", "timestamp": "2021-09-30T12:04:23.242+00:00", "state": "EARLY", "direction": "OUTGOING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
- Sequenza 2: Il chiamato risponde (CONFIRMED)
{ "seq_num": 2, "call_id": "lbDc8Xh8eqzweI1BOr8apg", "branch_id": "VrcWMeJVUDc.", "timestamp": "2021-09-30T12:04:25.739+00:00", "state": "CONFIRMED", "direction": "OUTGOING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
- Sequenza 3: Chiamata terminata (TERMINATED)
{ "seq_num": 3, "call_id": "lbDc8Xh8eqzweI1BOr8apg", "branch_id": "VrcWMeJVUDc.", "timestamp": "2021-09-30T12:04:28.448+00:00", "state": "TERMINATED", "termination-reason": "HANGUP", "direction": "OUTGOING", "local_user_id": "setera.test@seteratesting.fi", "local_number": "+35894272XXXX", "device_type": "SOFT", "remote_number": "+35840940XXXX" }
Legenda dati
Dato | Significato |
seq_num | Numero del messaggio. Viene utilizzato per tracciare il messaggio unico quando vengono inviate più risposte per la stessa chiamata. |
call_id | Codice di identificazione univoco della chiamata. |
timestamp | Data e ora seguita da fuso orario UTC. |
state | Lo stato corrente della chiamata. I possibili valori per questo campo sono: "TRYING", " PROCEEDING", " EARLY", " CONFIRMED" o "TERMINATED". |
termination-reason | Il motivo relativo la chiusura della chiamata. I possibili valori per questo campo sono: "CANCELLED", "ANSWERED_ELSEWHERE", "HANGUP" o "REJECTED". |
direction | La direzione della chiamata. I possibili valori per questo campo sono: "OUTGOING" o "INCOMING". |
local_email | Indirizzo email dell'utente locale. |
local_user_id | Identificativo dell'utente locale. |
local_number | Numero dell'utente locale. |
device_type | Il tipo di dispositivo con la quale è stata effettuata/ricevuta la chiamata dall'utente locale. I possibili valori per questo campo sono: "MOBILE", " SOFT", " DESKTOP", " FXS", " EXTERNAL_PBX", " FAX", " VOICEMAIL", " EXTERNAL", " MOBILE_EXT", " CONFERENCE", " QUEUE", " MOBILE_VOIP", "WEB". |
remote_email | Indirizzo email del chiamato/chiamante remoto. |
remote_user_id | Identificativo del chiamato/chiamante remoto. |
remote_number | Numero del chiamato/chiamante remoto. |
Privacy dei dati
Tra le impostazioni del connettore Webhook è possibile applicare una restrizione sulla visibilità dei dati che verranno trasmessi all'indirizzo URL precedentemente definito ed è quindi possibile rimuovere o mascherare alcuni dati relativi ad informazioni personali.
A seguire le opzioni possibili:
- Rimozione dell'User-Id dell'utente.
- Modifica il Numero dell'utente. Scegli se Rimuovere o Mascherare le ultime X cifre del numero (tra 1 - 15 cifre)
- Rimozione Email dell'utente.
- Rimozione dell'User-Id del chiamato/chiamante remoto.
- Modifica il Numero del chiamato/chiamante remoto. Scegli se Rimuovere o Mascherare le ultime X cifre del numero (tra 1 - 15 cifre)
- Rimozione Email dell'utente del chiamato/chiamante remoto.
- Rimozione del tipo dispositivo
Questa risposta ti è stata utile?
Fantastico!
Grazie per il tuo feedback
Siamo spiacenti di non poterti essere di aiuto
Grazie per il tuo feedback
Feedback inviato
Apprezziamo il tuo sforzo e cercheremo di correggere l’articolo