Differenze tra le versioni di "AdminGuide:Service:DynamicRouting"

Da Kalliope Wiki.
Jump to navigation Jump to search
(Versione segnata per la traduzione)
Riga 1: Riga 1:
<languages />
<languages />
<translate>
<translate>
<!--T:28-->
Torna a [[AdminGuide:Service]]
Torna a [[AdminGuide:Service]]



Versione delle 09:16, 17 apr 2018

Altre lingue:

Torna a AdminGuide:Service


Api esterne.png

Questo servizio permette di effettuare l’instradamento di una chiamata in ingresso in base alla risposta ad una API HTTP invocata su un WEB server esterno o al riscontro di uno o più parametri definiti in un file caricato sul PBX.

La richiesta al server web o il riscontro del file possono essere effettuate passando una serie di parametri numerici da richiedere al chiamante tramite prompt vocali pre-registrati.

Configurazione del servizio

La configurazione del servizio viene effettuata nel pannello Applicazioni PBX -> Instradamento dinamico.
In fase di configurazione è necessario specificare i seguenti valori:

  • Nome: identificativo dell’instradamento.
  • Tipo: richiesta HTTP (Richiesta a WEB server esterno) / Interno (Riscontro su file locale)
  • Controllo Orario: indica il controllo orario da verificare prima di eseguire l’instradamento. Il trabocco in caso si voglia eseguire l’instradamento dinamico deve essere impostato a “Ritorna al livello superiore”.
  • Parametri: per ciascun parametro (numerico) da richiedere al chiamante, è possibile inserire un messaggio vocale (ad esempio con la richiesta di inserimento) e, opzionalmente, è possibile specificare il massimo numero di cifre inseribili.

Se non viene specificato tale valore, il sistema assume che l’utente abbia terminato l’inserimento del parametro dopo un timeout di 5 secondi, o alla pressione del tasto “#”. In caso di mancata digitazione di una qualsiasi cifra, è prevista la ripetizione della richiesta per un massimo di 3 volte. Il massimo numero di parametri in ingresso è 5.

È infine possibile abilitare la richiesta di conferma, mediante l’apposita checkbox; se abilitata, il sistema ripete all'utente le cifre inserite e chiede di confermare la correttezza dell’inserimento mediante la digitazione del tasto “1”. In caso di assenza di conferma, viene ripetuta la richiesta di inserimento del parametro.

Impostazioni della richiesta

Richiesta HTTP

Nel caso in cui la richiesta sia di tipo HTTP devono essere specificate le seguenti impostazioni:

  • URL: URL a cui deve essere effettuata la richiesta (è supportato sia il protocollo HTTP che HTTPS).
  • Tipo Auth: identifica il tipo di autenticazione utilizzato dal web server e può essere NONE (nessuna autenticazione) o BASIC (Basic HTTP Authentication). Nel caso di Basic Authentication è necessario specificare le credenziali di autenticazione (username e password).
  • Tipo Request: indica il metodo della richiesta (sono supportati GET e POST).

Nel caso in cui si utilizzi il metodo POST è possibile specificare il formato del corpo della richiesta ed il relativo Content-Type.

Il passaggio dei parametri all’API avviene tramite dei placeholder inseriti nell’URL o nel contenuto del POST; i placeholder riconosciuti sono:

  • %CALLER_NUM%: indica il numero chiamante
  • %DNID%: indica il numero chiamato
  • %PARAM1%, …, %PARAM5%: indica i 5 parametri richiesti al chiamante tramite un menù vocale interattivo.
  • %UNIQUE_ID%: indica il codice identificativo univoco della chiamata. Tramite tale identificativo è possibile rintracciare la chiamata sul CDR.

A titolo di esempio, nel caso di richiesta GET l’URL potrebbe essere costruito come:
http://www.myserver.com/api?arg1=%CALLER_NUM%&arg2=%PARAM1%&arg3=%PARAM2%

Nel caso di richiesta di tipo POST, il corpo potrebbe essere:
<?xml version="1.0"?>
<parameters>
<caller>%CALLER_NUM%</caller>
<param_01>%PARAM1</param_01>
<param_02>%PARAM2</param_02>
</parameters>

Interno

Nel caso in cui la richiesta sia di tipo interno il file da utilizzare deve essere caricato nella cartella Accesso TFTP tramite il Gestore File.
Il file può avere estensione .xls/.xlsx/.ods/.csv e contenere o meno le intestazioni di colonna. Nel caso negativo deve essere specificato il mappaggio delle colonne, indicando per ciascun campo l’esatta posizione nel file. A tal scopo è importante ricordare che la numerazione delle colonne parte da 0.

Il file sorgente deve essere conforme al seguente template:

| callerNum | calledNum | param1 | param2 | param3 | param4 | param5 | response | newCallerNameFull | newCallerNamePrefix | newCallerNum|}

Azioni

In questa sezione si configurano le regole di instradamento da attuare in base alla risposta ottenuta dal Web Server esterno o all'esito del riscontro su file.

Richiesta HTTP

Nel caso in cui la richiesta si di tipo HTTP il sistema si aspetta dal server web una risposta di tipo “200 OK”, il cui corpo deve contenere un testo XML come segue:
<?xml version="1.0"?>
<response>
<message>
<elem>digit:1</elem>
<elem>number:200</elem>
<elem>alpha:c234</elem>
<elem>audio:custom/misc/pluto</elem>
<elem>number:201</elem>
<elem>digit:123</elem>
<elem>audio:custom/misc/pippo</elem>
</message>
<value>105</value>
</response>

Il tag <value> indica la risposta dell’API, in base alla quale vengono definite le azioni da compiere.

Le azioni da compiere possono essere costruite come segue:

  • Riproduzione di un file audio statico caricato sul sistema
  • Riproduzione di un contenuto dinamico.

Il contenuto dinamico da riprodurre puo essere costituito una serie di altri messaggi concatenati l’uno all’altro, e composti in base alla sequenza dei tag <elem> presenti nella risposta <message>.
I valori ammessi per il tag <elem> sono:
- digit: riproduce i singoli digit, uno alla volta (possono essere specificati numeri composti da più cifre, che saranno lette una alla volta)
- number: riproduce l’intero numero
- alpha: accetta cifre e lettere alfabetiche, che riproduce una alla volta
- audio: specifica il percorso di un file audio (contenuto nel PBX) da riprodurre

  • Regola di instradamento

In questo punto viene definita l’azione di inoltro da eseguire. In aggiunta alle normali azioni di uscita è prevista anche la possibilità di inoltrare la chiamata al Piano di numerazione, utilizzando come selezione il valore contenuto nella risposta.

Interno

Nel caso in cui la richiesta sia di tipo interno il sistema verifica le corrispondenze di numero chiamante, numero chiamato e parametri sul file e restituisce il valore della colonna response che sarà utilizzato per stabilire le azioni da compiere.
Nel caso in cui ci siano più righe che riscontrino i dati di ingresso viene selezionata l’azione corrispondente alla riga con più riscontri effettuati (best match).

In questo caso non è prevista la riproduzione di un contenuto dinamico e pertanto le azioni da compiere sono costruite come segue:

  • Riproduzione di un file audio statico caricato sul sistema
  • Regola di instradamento

In questo punto viene definita l’azione di inoltro da eseguire. In aggiunta alle normali azioni di uscita è prevista anche la possibilità di inoltrare la chiamata al Piano di numerazione, utilizzando come selezione il valore contenuto nella risposta.

Nei casi negativi in cui i parametri non siano corretti, o la chiamata provenga da un numero non specificato nel file o non sia specificato il valore delle response, verrà sempre eseguita l’azione di gestione errori.

E’ inoltre possibile inserendo dei valori nei campi newCallerNameFull, newCallerNamePrefix, newCallerNum modificare il nome e numero chiamante che verranno mostrati sul display del telefono chiamato.

In particolare se inserisco il newCallerNameFull il nome del chiamante verrà sostituito con questo valore, se inserisco il newCallerNamePrefix questo valore viene anteposto al nome chiamante mentre se inserisco newCallerNum viene sostituito il numero chiamante.

  • Gestione errori: Nel caso in cui la richiesta al server WEB restituisca un errore oppure il riscontro sul file non vada a buon fine la chiamata viene gestita come indicato in questa sessione.

Esempio instradamento dinamico interno

callerNum calledNum param1 param2 param3 param4 param5 response newCallerNameFull newCallerNamePrefix newCallerNum
102 - - - - - - - - simona 111
103 - 111 22 - - - 100 - - -
- - 123 123 333 123 123 100 - - 321

Dopo aver creato sul Piano di numerazione l’esatta selezione per l’instradamento dinamico, da uno degli interni si effettua la chiamata a tale numero.
Se la chiamata proviene dal numero 102, il sistema invierà la risposta 200 e verrà eseguita l’azione associata a quella response.
Se la chiamata proviene dal 103, verranno richiesti tramite un messaggio vocale, i valori dei parametri; se i parametri inseriti sono corretti il sistema invierà la risposta 100 e verrà eseguita l’azione associata a quella response.
Se la chiamata proviene da altro interno non specificato nel file, verranno richiesti i valori dei parametri e se i parametri inseriti sono corretti il sistema invierà la risposta 100 e verrà eseguita l’azione associata a quella response.
In tutti gli altri casi viene seguita l’azione definita nella gestione errori.