Manuale per le API. Mostra come poter inviare in modo programmatico i fax da altre applicazioni

Manuale per le API Mostra come poter inviare in modo programmatico i fax da altre applicazioni tramite le API di GFI FaxMaker.

Le informazioni e il contenuto del presente documento vengono forniti esclusivamente a scopi informativi e come sono, senza garanzie di alcun tipo, sia espresse che implicite, ivi incluse, senza limitazione, tutte le garanzie implicite di commerciabilità, idoneità a soddisfare uno scopo particolare e non violazione dei diritti altrui. GFI Software non sarà ritenuta responsabile in nessun caso di qualsiasi perdita o danno, inclusi danni consequenziali o incidentali che possano derivare dalla fornitura, rendimento o utilizzo del presente documento. Le informazioni sono state ottenute da fonti pubblicamente disponibili. Nonostante siano stati compiuti sforzi ragionevoli al fine di garantire la precisione dei dati forniti, GFI non offre garanzie, promesse né tanto meno assicurazioni circa la completezza, la precisione, l aggiornamento o l adeguatezza delle informazioni contenute nel presente documento e non sarà ritenuta responsabile di errori di stampa. GFI si riserva il diritto di rivedere o aggiornare i suoi prodotti, software o documentazione senza preavviso. L utente deve assumersi la piena responsabilità per l utilizzo e l applicazione di qualsiasi prodotto o servizio GFI. Si vieta la riproduzione o la trasmissione, seppur parziale, della presente documentazione, sotto qualsiasi forma o con qualsiasi mezzo, senza previo permesso scritto espresso di GFI Software. Se si ritiene che vi siano errori effettivi nel presente documento, contattarci. Provvederemo a risolvere la cosa quanto prima. GFI e GFI FaxMaker sono marchi o marchi registrati di GFI Software o delle sue affiliate negli Stati Uniti e in altri Paesi. Tutti gli altri marchi commerciali qui contenuti sono di proprietà dei rispettivi proprietari. GFI FaxMaker è copyright di GFI Software Development Ltd. - 1999-2015 GFI Software Development Ltd. Tutti i diritti riservati. Versione documento: 1.3.2 Ultimo aggiornamento (mese/giorno/anno): 5/5/2015

Sommario 1 API di GFI FaxMaker 4 2 API di testo 5 2.1 Funzionamento dell API di testo 5 2.2 Abilitazione dell API di testo in GFI FaxMaker 5 2.3 Creazione di API di testo 7 3 XMLAPI 11 3.1 Funzionamento di XMLAPI 11 3.2 Abilitazione di XMLAPI in GFI FaxMaker 12 3.3 Creazione di XMLAPI 12 3.4 Campi e parametri fax 13 3.5 Campi e parametri SMS 22 4 API servizio Web 26 4.1 Requisiti e note importanti 26 4.2 Guida introduttiva 26 4.3 Funzioni API 27 4.4 Classi 30 4.5 Enums 33 4.6 Gestione coda API servizio Web 34 5 Risoluzione dei problemi e supporto 36 5.1 Altre risorse di risoluzione dei problemi 36

1 API di GFI FaxMaker Cone le API è possibile integrare il software di terze parti con GFI FaxMaker. L automazione di tale processo può essere utilizzata per una vasta gamma di settori e applicazioni, quali la sanità, la vendita al dettaglio e servizi bancari. Ad esempio: utilizzare XMLAPI nel software di fatturazione per creare un modello di report XML per gli estratti conto e i bilanci. Generare periodicamente questo report per tutti i clienti che sono in debito verso l azienda e archiviarlo nella cartella di prelievo di XMLAPI. GFI FaxMaker trasmette automaticamente le dichiarazioni ai rispettivi destinatari. logie di API disponibili in GFI FaxMaker: XMLAPI API di testo API servizio Web Inviare fax o SMS utilizzando i file XML. È possibile configurare software di terze parti per generare automaticamente le API e trasmettere i fax in blocco. GFI FaxMaker preleva e trasmette tutti i file xml memorizzati in una cartella di prelievo XMLAPI. Le XMLAPI devono essere formattate in base a una convenzione standard, utilizzando campi e parametri che GFI FaxMaker può utilizzare per l elaborazione di fax ed SMS. Per ulteriori informazioni, fare riferimento a XMLAPI (pagina 11). Inviare i fax utilizzando i file di testo semplici. È possibile configurare software di terze parti per generare automaticamente le API e trasmettere i fax in blocco. GFI FaxMaker preleva e trasmette tutti i file di testo salvati in una cartella di prelievo personalizzata API di testo. Le API di testo devono essere formattate in base a una convenzione standard, utilizzando campi e parametri che GFI FaxMaker può utilizzare per l elaborazione di fax ed SMS. Per ulteriori informazioni, fare riferimento a API di testo (pagina 5). API Servizio Web di GFI FaxMaker consente di sviluppare le proprie applicazioni che è possibile collegare direttamente a GFI FaxMaker. È quindi possibile inviare e ricevere fax direttamente dall applicazione. Per ulteriori informazioni, fare riferimento a API servizio Web (pagina 26). GFI FaxMaker 1 API di GFI FaxMaker 4

2 API di testo TextAPI è una funzione di GFI FaxMaker che consente la trasmissione di fax dai file di testo. Questi file di testo devono essere formattati in base a una convenzione standard, utilizzando i campi e i parametri che GFI FaxMaker può utilizzare per trasmettere i fax. Archiviare le API di testo in una cartella apposita. GFI FaxMaker preleva tutte le API di testo archiviate nella cartella e trasmette il contenuto via fax. Per configurare l API di testo: Creare e riservare una cartella accessibile da GFI FaxMaker in cui verranno archiviati i file di testo per la trasmissione fax. Abilitare la funzione TextAPI da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Abilitazione dell API di testo in GFI FaxMaker (pagina 5). Creare API di testo utilizzando i campi e i parametri accettati da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). 2.1 Funzionamento dell API di testo Figura 1: Funzionamento dell API di testo Passaggio Generazione TextAPI Un applicazione di terze parti è di solito configurata per generare automaticamente API di testo. Assicurarsi che il file generato soddisfi i parametri, i campi e i requisiti di GFI FaxMaker, come descritto in questo manuale. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). Salvare l API nella cartella di prelievo di TextAPI In GFI FaxMaker configurare le cartelle da cui prelevare le API. Archiviare l API generata nella cartella appropriata. Per ulteriori informazioni, fare riferimento a Abilitazione dell API di testo in GFI FaxMaker (pagina 5). GFI FaxMaker recupera l API GFI FaxMaker esegue periodicamente il polling delle cartelle configurate per le API *.txt. GFI FaxMaker elabora e trasmette il fax GFI FaxMaker elabora le API recuperate e trasmette il fax in base ai campi e ai parametri specificati nell API. NOTA Prima di archiviare le API nella cartella di prelievo, assicurarsi che gli allegati e i file del corpo siano ben archiviati nella posizione corretta. Archiviazione degli allegati nella cartella TextAPI. 2.2 Abilitazione dell API di testo in GFI FaxMaker Per abilitare e configurare l API di testo: 1. Dalla configurazione di GFI FaxMaker fare clic con il pulsante destro del mouse sul nodo Avanzate > Testo API/XMLAPI, quindi selezionare Proprietà. GFI FaxMaker 2 API di testo 5

Schermata 1: Abilitazione dell API di testo 2. Dalla scheda API di testo configurare le opzioni seguenti: Tabella 1: Opzioni API di testo Opzione Abilitato Cartelle da scansionare Archivia tutti i file di risposta in una cartella Formattazione testo con frontespizio Abilita API di testo. Specificare le cartella dove salvare le API di testo che devono essere elaborate da GFI FaxMaker. Fare clic su Aggiungi per selezionare le cartelle. Per eseguire la scansione delle API di testo ricorsive nelle sottocartelle, selezionare Includi sottocartelle. Dopo l elaborazione di una TextAPI dove non è indicato il parametro FROM, GFI FaxMaker crea un file di risposta. Per impostazione predefinita, GFI FaxMaker archivia i file di risposta nelle cartelle di prelievo. Per archiviare tutti i file di risposta in un unica posizione, selezionare questa opzione e indicare una posizione. Per ulteriori informazioni, fare riferimento a File di risposta TextAPI (pagina 9). Selezionare il frontespizio da utilizzare per i fax dell API di testo. Per ulteriori informazioni sui frontespizi, fare riferimento a GFI FaxMaker Manuale di amministrazione e configurazione. 3. Fare clic su OK. Passaggio successivo: Iniziare la creazione di TextAPI. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). GFI FaxMaker 2 API di testo 6

2.3 Creazione di API di testo Quando si utilizza TextAPI, creare un file di testo (formato.txt) strutturato come segue: Tabella 2: Struttura del file TextAPI Riga Prima riga Seconda riga (facoltativa) Altre righe Specificare il numero di fax del destinatario preceduto dal doppio simbolo dei due punti nel formato seguente: ::numero fax Ad esempio: ::12345678 Nel formato seguente è inoltre possibile includere altri parametri: ::nome, azienda, cognome, ufficio, indirizzo e-mail, numero fax Ad esempio, per inviare un fax ad Andrea Rossi che lavora nell'ufficio vendite di Azienda Giovanni, il cui indirizzo di posta elettronica e numero di fax sono rispettivamente vendite@aziendagiovanni.com e 12345678, si dovrà inserire: ::John, John Company, Smith, Sales, sales@johncompany.com, 12345678 Specificare le altre opzioni di invio precedute dal doppio simbolo dei due punti. Ad esempio: ::S=listino prezzi Separare più parametri con virgole. Ad esempio: ::c=cover1,23:15,b=5 Per ulteriori informazioni, fare riferimento a Opzioni di invio API di testo (pagina 7). Immettere il testo del messaggio da inviare per fax. 2.3.1 Opzioni di invio API di testo Nella seconda riga dell API di testo è possibile specificare una serie di opzioni di invio. NOTA È possibile specificare più opzioni. Separare più parametri con virgole. Ad esempio: ::s=oggetto,from=peter,c=frontespizio1,23:15,b=5 NOTA Per GFI FaxMaker non si applica la distinzione tra maiuscole e minuscole. I parametri possono essere specificati sia con le lettere maiuscole che con le lettere minuscole. Tabella 3: Parametri API di testo Opzione di invio Parametro Oggetto Mittente ::S=Questo è l oggetto o ::subject=questo è l oggetto ::fr=nome o ::from=nome Specificare l'oggetto del fax. Questo testo viene inserito nel campo <subject> del frontespizio. Sostituire Questo è l oggetto con il testo dell oggetto. Utilizzare il parametro per specificare il nome del mittente del fax. Il nome specificato è incluso come nome mittente nel frontespizio. Sostituire nome con il nome del mittente. NOTA: Quando l opzione non è specificata, GFI FaxMaker non dispone di informazioni sul mittente e non è pertanto in grado di restituire un report di trasmissione via e-mail. Invece, viene generato un file di risposta. Per ulteriori informazioni, fare riferimento a File di risposta TextAPI (pagina 9). GFI FaxMaker 2 API di testo 7

Opzione di invio Parametro Allegato ::A=Nome file Specificare un file da allegare al fax. Il file deve essere archiviato nella stessa cartella di prelievo di TextAPI. Sostituire nome file con il nome e l estensione del file da allegare. Ad esempio, ::A=FaxAttachment.tif È possibile allegare più file specificando il comando più volte. Ad esempio: ::A=FaxAttachment.tif,A=disclaimer.tif NOTA: Gli allegati vengono rimossi definitivamente dalla cartella di prelievo. Se è necessaria una copia, assicurarsi che venga eseguita prima di spostare l allegato nella cartella TextAPI. Priorità Codice di addebito Pianifica Frontespizio Nota di copertina anteriore Priorità alta ::p=high o ::p=h o ::priority=high o ::priority=h Priorità bassa ::p=low o ::p=l o ::priority=low o ::priority=l ::B=nnnn o ::billingcode=nnnn ::YYYY-MM-DD-hh:mm:ss o ::hh:mm ::C=NomeFrontespizio o ::Coverpage=NomeFrontespizio ::F=NotaCopertina o ::frontcover=notacopertina Specificare la priorità del fax (alta o bassa) da utilizzare per inviare il fax. Utilizzare questo parametro per specificare un codice di addebito, se GFI FaxMaker è configurato per richiederne uno. Sostituire nnnn con il codice di addebito. Indicare data e ora oppure solo l ora per l invio di un fax. Sostituire: AAAA - anno MM - mese DD - giorno hh - ora nel formato 24 ore mm - minuti ss - secondi Ad esempio, ::2012-04-21-16:05:00 Per impostazione predefinita, GFI FaxMaker utilizza il frontespizio predefinito configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. Sostituire NomeFrontespizio con il nome del frontespizio da usare, come configurato in GFI FaxMaker. È inoltre possibile utilizzare ::C=none per non aggiungere un frontespizio. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. Sostituire NotadicopertinaAnteriore con il nome della nota di copertina anteriore da usare, come configurato in GFI FaxMaker. GFI FaxMaker 2 API di testo 8

Opzione di invio Linea fax massima Intestazione Riepilogo report di trasmissione Parametro ::line=n o ::l=n Alta risoluzione ::H o ::high Risoluzione normale ::N o ::normal ::fh=intestazione o ::faxheader=intestazione Invia riepilogo report di trasmissione ::tr=summary Non mandare mai riepilogo ::tr=none Specificare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Sostituire n con il numero della linea fax come configurato in Configurazione di GFI FaxMaker. NOTA: Se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea particolare, utilizzare il parametro seguente: ::dl=n Il fax non viene inviato fino a quando la linea fax specificata non è disponibile. NOTA: il parametro dl è disponibile anche durante l utilizzo dei comandi TextAPI negli SMS per la richiesta di invio di un SMS tramite una specifica linea GSM. Utilizzare il parametro per specificare la risoluzione del fax. Utilizzare una risoluzione elevata (200 * 200 dpi) o normale (200 * 100 dpi). Questa opzione consente di impostare un'intestazione personalizzata aggiunta a quella predefinita all'inizio del fax. Sostituire intestazione con il testo dell intestazione da aggiungere. Usare summary per ricevere solo un report di trasmissione all invio di un fax a destinatari multipli. Usare none per non inviare un report di trasmissione dopo la trasmissione fax. 2.3.2 di TextAPI ::John, società di John, Smith, Sales, sales@johnscompany.com, 12345678 ::from=bob Jones,subject=Hi John,H,fh=Fax di prova Questo è il messaggio del fax. Cordiali saluti, Paul 2.3.3 File di risposta TextAPI Dopo aver elaborato un TextAPI dove non è specificato il mittente (opzioni from o fr nella seconda riga), GFI FaxMaker crea un file di risposta per indicare il risultato della trasmissione fax. Se il mittente è specificato, il messaggio di risposta viene inviato per e-mail al mittente come rapporto di trasmissione. Per impostazione predefinita, il file di risposta viene creato nella medesima cartella da cui è stato prelevato TextAPI. In alternativa, GFI FaxMaker può essere configurato per archiviare tutti i file di risposta in un percorso. Per ulteriori informazioni, fare riferimento a Archivia tutti i file di risposta in una cartella (pagina 6). Il nome del file di risposta corrisponde al nome di TextAPI. L estensione del file dipende dal risultato di trasmissione: *.ok: indica che il fax è stato trasmesso correttamente. *.err: indica che non è stato possibile inviare il fax. Per facilitare la risoluzione dei problemi, rivedere il messaggio Description. GFI FaxMaker 2 API di testo 9

Schermata 2: Messaggio di risposta TextAPI di esempio GFI FaxMaker 2 API di testo 10

3 XMLAPI XMLAPI è una funzione di GFI FaxMaker che consente la trasmissione di fax dai file XML. I file XML devono essere formattati in base a una convenzione standard, utilizzando i campi e i parametri che GFI FaxMaker può utilizzare per trasmettere i fax. Archiviare le XMLAPI in una cartella apposita. GFI FaxMaker preleva tutte le XMLAPI archiviate nella cartella e trasmette il contenuto via fax. Per configurare le XMLAPI: Creare e riservare una cartella accessibile da GFI FaxMaker in cui saranno archiviati i file XML per la trasmissione fax. Abilitare la funzione XMLAPI da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Abilitazione di XMLAPI in GFI FaxMaker (pagina 12). Creare XMLAPI utilizzando i campi e i parametri accettati da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di XMLAPI (pagina 12). 3.1 Funzionamento di XMLAPI Figura 2: Funzionamento di XMLAPI Passaggio Generazione XMLAPI Un applicazione di terze parti è di solito configurata per generare automaticamente le API XML. Assicurarsi che il file generato soddisfi i parametri, i campi e i requisiti di GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di XMLAPI (pagina 12). Archiviazione dell API nella cartella di prelievo XMLAPI In GFI FaxMaker configurare le cartelle da cui prelevare le API. Archiviare l API generata nella cartella appropriata. Per ulteriori informazioni, fare riferimento a Abilitazione di XMLAPI in GFI FaxMaker (pagina 12). GFI FaxMaker recupera l API GFI FaxMaker esegue periodicamente il polling delle cartelle configurate per le API +.xml. GFI FaxMaker elabora e trasmette il fax/l SMS GFI FaxMaker elabora le API recuperate e trasmette il fax/l SMS in base ai campi e ai parametri specificati nell API. NOTA Archiviare gli allegati e i file del corpo come configurato all interno dei parametri XML dell API. Assicurarsi che gli allegati e i file del corpo siano ben archiviati nella posizione indicata prima di memorizzare gli XMLAPI nella cartella di prelievo. Se gli allegati o i file del corpo non sono accessibili a GFI FaxMaker durante il prelievo, il fax dà esito negativo. NOTA Dopo aver trasmesso un fax con XMLAPI, GFI FaxMaker genera un messaggio di risposta (file *.status) nella cartella XMLAPI che include i dettagli relativi alla trasmissione fax. Questo può essere utilizzato dagli utenti, amministratori o dalle applicazioni di terzi per monitorare la trasmissione fax. Per ulteriori informazioni, fare riferimento a File di risposta XMLAPI (pagina 20). GFI FaxMaker 3 XMLAPI 11

3.2 Abilitazione di XMLAPI in GFI FaxMaker Per abilitare e configurare XMLAPI: 1. Dalla configurazione di GFI FaxMaker fare clic con il pulsante destro del mouse sul nodo Avanzate > Testo API/XMLAPI, quindi selezionare Proprietà. Schermata 3: Abilitazione di XMLAPI 2. Dalla scheda XMLAPI, fare clic su Abilitato per attivare XMLAPI. 3. Fare clic su Aggiungi e selezionare le cartelle in cui archiviare le XMLAPI. Per controllare la presenza di XMLAPI anche nelle sottocartelle, selezionare Includi sottocartelle. 4. Dopo aver elaborato un XMLAPI, GFI FaxMaker crea un file di risposta (estensione *.status). Per impostazione predefinita, GFI FaxMaker archivia i file di risposta nelle cartelle di prelievo. Per archiviare tutti i file di risposta in un unica posizione, selezionare Archivia tutti i file di risposta in una cartella e indicare una posizione. Per ulteriori informazioni, fare riferimento a File di risposta XMLAPI (pagina 20). 5. Fare clic su OK. Passaggio successivo: Iniziare la creazione delle API XML. Per ulteriori informazioni, fare riferimento a Creazione di XMLAPI (pagina 12). 3.3 Creazione di XMLAPI Quando si utilizza XMLAPI, creare un file XML (formato.xml) contenente i parametri del fax/sms da trasmettere. Tutti i parametri XMLAPI devono essere compresi in un contenitore XML <faxmakerdata>. I dati devono quindi essere inclusi in tre contenitori separati, come segue: GFI FaxMaker 3 XMLAPI 12

Tabella 4: Contenitori campo XMLAPI Contenitori XMLAPI <fields> <sender> <recipients> Per questo contenitore devono essere specificate le proprietà di trasmissione fax quali oggetto, file allegato e messaggio. Inserire i dettagli del mittente in questo contenitore. Specificare le informazioni dei destinatari in questo contenitore. NOTA È necessaria anche un intestazione XML. Di solito si presenta nel modo seguente: <?xml version="1.0" encoding="utf-8"?> Per ulteriori informazioni sui campi e parametri XMLAPI, fare riferimento a: Campi e parametri fax Campi e parametri SMS XMLAPI di esempio: XMLAPI fax di esempio: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=xmlapifax XMLAPI SMS di esempio: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=xmlapisms 3.4 Campi e parametri fax Elenco dei campi e parametri supportati in XMLAPI per l invio di fax. Campi dei messaggi Informazioni sul mittente Informazioni sui destinatari del fax Fare riferimento all SMS di esempio XMLAPI: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=xmlapifax 3.4.1 Campi dei messaggi Nel contenitore <fields>, specificare le informazioni seguenti: Tabella 5: Campi e parametri dei messaggi Oggetto Percorso XML \faxmakerdata\fields\subject Specificare l'oggetto del fax. <subject>questo è l oggetto del fax</subject> GFI FaxMaker 3 XMLAPI 13

Pianifica Priorità Codice di addebito massima Percorso XML Percorso XML Percorso XML Percorso XML \faxmakerdata\fields\schedule Specificare la data e l ora di invio del fax nel formato seguente: YYYY-MM-DD-HH:mm:ss Sostituire: AAAA - anno MM - mese DD - giorno hh - ora nel formato 24 ore mm - minuti ss - secondi <schedule>2012-10-10-08:15:00</schedule> \faxmakerdata\fields\priority Impostare la priorità del messaggio. I valori validi sono: low normal high veryhigh <priority>high</priority> \faxmakerdata\fields\billingcode. Obbligatorio quando è abilitato il codice di addebito. Imposta il codice di addebito del mittente del messaggio. <billingcode>25</billingcode> \faxmakerdata\fields\resolution Utilizzare il parametro per specificare la risoluzione del fax. I valori validi sono: Normal (200 * 100 dpi) High (200 * 200 dpi) <resolution>high</resolution> GFI FaxMaker 3 XMLAPI 14

Frontespizio Nota di copertina anteriore Linea fax Intestazione Percorso XML Percorso XML Percorso XML Percorso XML \faxmakerdata\fields\coverpage Per impostazione predefinita, il fax viene inviato utilizzando il frontespizio configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. Digitare il frontespizio da utilizzare scegliendo una delle seguenti opzioni: Nome del frontespizio come configurato in GFI FaxMaker. Il nome file di un frontespizio archiviato nella <cartella di installazione di GFI FaxMaker>\Coverpage. Ad esempio, generic.htm. <coverpage>aziendale</coverpage> \faxmakerdata\fields\frontcovernote Per impostazione predefinita, il fax viene inviato utilizzando la nota di copertina anteriore predefinita configurata in GFI FaxMaker. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. Digitare la nota di copertina anteriore da utilizzare scegliendo una delle seguenti opzioni: Nome della nota di copertina anteriore come configurato in GFI FaxMaker. Il nome file di una nota di copertina anteriore archiviato in <cartella di installazione di GFI FaxMaker>\Coverpage. Ad esempio, MyCovernote.htm. <frontcovernote>intestazione lettera</frontcovernote> \faxmakerdata\fields\faxline Numero Utilizzare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Specificare il numero della linea fax come configurato in Configurazione di GFI FaxMaker. NOTA: Se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea specifica, utilizzare l attributo seguente: demandline= true <faxline demandline="true">3</faxline> \faxmakerdata\fields\faxheader Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax. <faxheader>questa è l intestazione del fax</faxheader> GFI FaxMaker 3 XMLAPI 15

ID univoco API di testo File del corpo del messaggio Percorso XML Percorso XML Percorso XML \faxmakerdata\fields\uid [255 caratteri al massimo] Specificare un identificatore che viene utilizzato per contrassegnare il messaggio. L'univocità dell'identificatore è stabilita dall'autore del messaggio. Il numero massimo di caratteri è 255. <uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> \faxmakerdata\fields\textapi Utilizzato per specificare una linea singola di comandi di API di testo (incluso il prefisso ':: ). Questo campo può essere specificato più volte. <textapi>::billingcode=25,line=3</textapi> \faxmakerdata\fields\bodyfile Percorso completo o nome file NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. Utilizza i contenuti del file come corpo del messaggio nel frontespizio del fax. Indicare il file del corpo nel formato seguente: Percorso completo: Specificare il percorso completo (compreso il nome file) del file del corpo. Il file viene eliminato automaticamente al momento del prelievo. Solo nome file: Se il file del corpo è memorizzato nella cartella frontespizi, inserire solo il nome del file: <cartella di installazione di GFI FaxMaker>\Coverpage. In questo caso, il file del corpo non viene eliminato al momento del prelievo. NOTA: Prima di archiviare i file XMLAPI nella cartella di prelievo, assicurarsi che il file del corpo sia ben archiviato nella posizione corretta. Se il corpo del file non è accessibile da GFI FaxMaker durante il prelievo, il fax dà esito negativo. Utilizzare l attributo tipo per indicare il tipo di file del corpo. Utilizzare uno dei seguenti attributi: type="text/html" - Specificare questo attributo quando il testo del corpo del messaggio è nel formato HTML. type="text/rtf": specificare questo attributo quando il testo del corpo del messaggio è nel formato RTF. Utilizzare i file con corpo del messaggio RTF solo con i frontespizi RTF. type="text/plain" - Specificare questo attributo quando il testo del corpo del messaggio è nel formato testo normale. Se non è specificato alcun attributo del tipo di file, il messaggio viene immesso come testo normale. <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> GFI FaxMaker 3 XMLAPI 16

Allegato Percorso XML \faxmakerdata\fields\attachment Percorso completo o nome file (massimo 60 allegati) NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. Aggiunge i contenuti del file specificato al fax. Indicare il file del corpo nel formato seguente: Percorso completo: Specificare il percorso completo (compreso il nome file) degli allegati. Solo nome file: Se gli allegati sono memorizzati nella stessa cartella di XMLAPI, inserire solo il nome del file. NOTA: Prima di archiviare i file XMLAPI nella cartella di prelievo, assicurarsi che i file allegato siano ben archiviati nella posizione corretta. Se gli allegati non sono accessibili a GFI FaxMaker durante il prelievo, il fax dà esito negativo. NOTA: Gli allegati sono eliminati dopo il prelievo, <attachment>c:\temp\document.doc</attachment> 3.4.2 Campi del mittente Nel contenitore <sender>, indicare le informazioni del mittente come segue: Tabella 6: Campi e parametri del mittente Nome Percorso XML \faxmakerdata\sender\firstname Imposta il nome del mittente. <firstname>john</firstname> Cognome Percorso XML \faxmakerdata\sender\lastname Imposta il cognome del mittente. <lastname>smith</lastname> Azienda Percorso XML \faxmakerdata\sender\company Imposta il nome dell'azienda del mittente. <company>nome azienda</company> Reparto Percorso XML \faxmakerdata\sender\department Imposta il reparto del mittente. <department>vendita</department> GFI FaxMaker 3 XMLAPI 17

Numero telefono Percorso XML \faxmakerdata\sender\voicenumber Imposta il numero di telefono del mittente. <voicenumber>+1(800)1234 5678</voicenumber> Indirizzo di posta elettronica Percorso XML \faxmakerdata\sender\emailaddress Obbligatorio Imposta l'indirizzo di posta elettronica del mittente. <emailaddress>jsmith@mydomain.com</emailaddress> 3.4.3 Campi dei destinatari del fax Nel contenitore <recipient>, specificare le informazioni seguenti. Per i fax, aggiungere un contenitore <fax> e un contenitore <recipient>. Ad esempio: <recipients> <fax> </fax> <recipient> <faxnumber>+1 800 1234 5678</faxnumber> </recipient> </recipients> NOTA È inoltre possibile inviare il fax a più destinatari. Per ulteriori informazioni, fare riferimento a Invio di fax a più destinatari (pagina 19). Inserire altri parametri e campi nel contenitore <recipient> come segue: Tabella 7: Campi e parametri dei destinatari del fax Nome Percorso XML \faxmakerdata\recipients\fax\recipient\firstname Imposta il nome del destinatario. <firstname>joe</firstname> GFI FaxMaker 3 XMLAPI 18

Cognome Percorso XML \faxmakerdata\recipients\fax\recipient\lastname Imposta il cognome del destinatario. <lastname>bloggs</lastname> Azienda Percorso XML \faxmakerdata\recipients\fax\recipient\company Imposta il nome dell'azienda del destinatario. <company>destinatariofax azienda Ltd.</company> Reparto Percorso XML \faxmakerdata\recipients\fax\recipient\department Imposta il reparto del destinatario. <department>marketing</department> Numero fax Percorso XML \faxmakerdata\recipients\fax\recipient\faxnumber Obbligatorio Imposta il numero di fax del destinatario. <faxnumber>+1(800)8765 4321</faxnumber> Numero telefono Percorso XML \faxmakerdata\recipients\fax\recipient\voicenumber Imposta il numero di telefono del destinatario. <voicenumber>+1(800)8765 4444</voicenumber> Indirizzo di posta elettronica Percorso XML \faxmakerdata\recipients\fax\recipient\emailaddress Imposta l'indirizzo di posta elettronica del destinatario. <emailaddress>john@dominiodestinatariofax.com</emailaddress> Invio di fax a più destinatari È possibile inviare il fax a più destinatari. A tale scopo, includere più contenitori <recipient>...</recipient>. Ad esempio: <recipients> GFI FaxMaker 3 XMLAPI 19

<fax> </fax> <recipient> <firstname>bob</firstname> <faxnumber>+1 800 1111 1111</faxnumber> </recipient> <recipient> <firstname>john</firstname> <faxnumber>+1 800 2222 2222</faxnumber> </recipient> </recipients> 3.4.4 File di risposta XMLAPI Dopo aver elaborato un XMLAPI, GFI FaxMaker crea un file di risposta che può essere utilizzato per rivedere la trasmissione fax. Gli strumenti di terze parti possono essere configurati per eseguire il polling della cartella e recuperare automaticamente lo stato dei fax trasmessi. Per impostazione predefinita, GFI FaxMaker archivia i file di risposta nella stessa cartella in cui l XMLAPI è stato originariamente prelevato. In alternativa, GFI FaxMaker può essere configurato per archiviare tutti i file di risposta in una cartella particolare. Per ulteriori informazioni, fare riferimento a Abilitazione di XMLAPI in GFI FaxMaker (pagina 12). Il nome del file di risposta corrisponde al nome di xmlapi, con un estensione *.status. Ad esempio, il file di risposta di XMLAPI fax123.xml è denominato fax123.xml.status. Se esiste già un file di risposta con lo stesso nome, GFI FaxMaker aggiunge al file il messaggio di risposta. NOTA La trasmissione SMS non genera un file di risposta. GFI FaxMaker 3 XMLAPI 20

Schermata 4: Messaggio risposta di esempio XMLAPI Il messaggio di risposta contiene i seguenti contenitori XML: Tabella 8: Contenitori del messaggio di risposta Contenitore <fax>...</fax> <errorcode>...</errorcode> <description>...</description> <uid>...</uid> <faxfile>...</faxfile> <recipient>...</recipient> Contenitore per ciascuna trasmissione fax. Se un file API XML contiene destinatari multipli, viene creato un contenitore <fax> per ciascun destinatario, con tutti i dettagli per quella trasmissione specifica. Restituisce il codice di errore per la trasmissione fax. Una trasmissione riuscita restituisce il codice di errore 0. Contiene il report di trasmissione per le trasmissioni con esito positivo o negativo. Include parametri importanti relativi al fax. Se è stato specificato un ID univoco (uid) in XMLAPI, questo contenitore viene prodotto. Contiene il percorso completo del file immagine del fax. Mostra il numero di fax a cui è stato inviato il fax. GFI FaxMaker 3 XMLAPI 21

3.5 Campi e parametri SMS Elenco dei campi e parametri supportati in XMLAPI per l invio di SMS. Campi dei messaggi Informazioni sul mittente Informazioni sui destinatari dell SMS Fare riferimento all SMS di esempio XMLAPI: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=xmlapisms 3.5.1 Campi dei messaggi Nel contenitore <fields>, specificare le informazioni seguenti: Messaggio SMS Linea SMS Percorso XML Percorso XML \faxmakerdata\fields\bodyfile Percorso completo o nome file Obbligatorio Utilizza i contenuti del file come messaggio SMS. Digitare il percorso completo del file. Specificare il tipo di file: type="text/html": il testo del corpo del messaggio è nel formato HTML. type="text/rtf": il testo del corpo del messaggio è nel formato RTF. type="text/plain": il testo del corpo del messaggio è nel formato testo normale. Se non è specificato alcun attributo del tipo di file, il messaggio viene elaborato come testo normale. <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> \faxmakerdata\fields\gsmline Numero (porta COM) o stringa (nome configurato per la linea GSM) Richiedere l invio di un SMS a una determinata linea GMS. Indicare il nome o il numero della porta COM come configurato in GFI FaxMaker. Utilizzare il parametro demandline per indicare le modalità di invio degli SMS se la linea indicata è occupata o inesistente. Per inviare l SMS unicamente dalla linea GSM specificata, utilizzare demandline= true. Utilizzare demandline= false per inviare l SMS tramite la prima linea GSM disponibile se la linea indicata è occupata o inesistente. <gsmline demandline="true">3</gsmline> o <gsmline demandline="false">mygsmline</gsmline> 3.5.2 Campi del mittente Nel contenitore <sender>, indicare le informazioni del mittente come segue: GFI FaxMaker 3 XMLAPI 22

Tabella 9: Campi e parametri del mittente Nome Percorso XML \faxmakerdata\sender\firstname Imposta il nome del mittente. <firstname>john</firstname> Cognome Percorso XML \faxmakerdata\sender\lastname Imposta il cognome del mittente. <lastname>smith</lastname> Azienda Percorso XML \faxmakerdata\sender\company Imposta il nome dell'azienda del mittente. <company>nome azienda</company> Reparto Percorso XML \faxmakerdata\sender\department Imposta il reparto del mittente. <department>vendita</department> Numero telefono Percorso XML \faxmakerdata\sender\voicenumber Imposta il numero di telefono del mittente. <voicenumber>+1(800)1234 5678</voicenumber> Indirizzo di posta elettronica Percorso XML \faxmakerdata\sender\emailaddress Obbligatorio Imposta l'indirizzo di posta elettronica del mittente. <emailaddress>jsmith@mydomain.com</emailaddress> 3.5.3 Campi dei destinatari dell SMS Nel contenitore <recipient>, specificare le informazioni seguenti. Per gli SMS, aggiungere un contenitore <sms> GFI FaxMaker 3 XMLAPI 23

e un contenitore <recipient>. Ad esempio: <recipients> <sms> <recipient> <smsnumber>+1 800 1234 5678</smsnumber> </recipient> </sms> </recipients> NOTA È inoltre possibile inviare l SMS a più destinatari. Per ulteriori informazioni, fare riferimento a Invio di SMS a destinatari multipli (pagina 25). Inserire altri parametri e campi nel contenitore <recipient> come segue: Tabella 10: Campi e parametri dei destinatari dell SMS Nome Percorso XML \faxmakerdata\recipients\sms\recipient\firstname Imposta il nome del destinatario. <firstname>joe</firstname> Cognome Percorso XML \faxmakerdata\recipients\sms\recipient\lastname Imposta il cognome del destinatario. <lastname>bloggs</lastname> Azienda Percorso XML \faxmakerdata\recipients\sms\recipient\company Imposta il nome dell'azienda del destinatario. <company>destinatariosms azienda Ltd.</company> Reparto Percorso XML \faxmakerdata\recipients\sms\recipient\department Imposta il reparto del destinatario. <department>marketing</department> GFI FaxMaker 3 XMLAPI 24

Numero SMS Percorso XML \faxmakerdata\recipients\sms\recipient\smsnumber Obbligatorio Imposta il numero di SMS del destinatario. <smsnumber>+1(800)8765 4321</smsnumber> Numero telefono Percorso XML \faxmakerdata\recipients\sms\recipient\voicenumber Imposta il numero di telefono del destinatario. <voicenumber>+1(800)8765 4444</voicenumber> Indirizzo di posta elettronica Percorso XML \faxmakerdata\recipients\sms\recipient\emailaddress Imposta l'indirizzo di posta elettronica del destinatario. <emailaddress>john@dominiodestinatariosms.com</emailaddress> Invio di SMS a destinatari multipli È possibile inviare l SMS a più destinatari. A tale scopo, includere più contenitori <recipient>...</recipient>. Ad esempio: <recipients> <sms> </sms> <recipient> <firstname>john</firstname> <smsnumber>+1 800 1111 1111</smsnumber> </recipient> <recipient> <firstname>bob</firstname> <smsnumber>+1 800 2222 2222</smsnumber> </recipient> </recipients> GFI FaxMaker 3 XMLAPI 25

4 API servizio Web API Servizio Web di GFI FaxMaker consente di sviluppare le proprie applicazioni che è possibile collegare per l invio/ricezione di fax tramite GFI FaxMaker. NOTA Questo argomento è destinato agli utenti familiari con Visual Studio, Servizi Web XML e tecnologie SOAP. 4.1 Requisiti e note importanti 26 4.2 Guida introduttiva 26 4.3 Funzioni API 27 4.4 Classi 30 4.5 Enums 33 4.6 Gestione coda API servizio Web 34 4.1 Requisiti e note importanti Per creare l API, utilizzare un ambiente di sviluppo che supporta Servizi Web XML e SOAP. API servizio Web di GFI FaxMaker utilizza la porta 8555 per la comunicazione HTTP tra l applicazione e GFI FaxMaker. Questa porta può essere aperta automaticamente durante l esecuzione della configurazione guidata di GFI FaxMaker. Per ulteriori informazioni, fare riferimento a http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=firewallports Accedere al Servizio Web di GFI FaxMaker tramite Servizi Web XML sulla porta HTTP 8555, tramite l URL: http://<server GFI FaxMaker>:8555/faxmaker/wsapi Sostituire <Server GFI FaxMaker> con il nome o l indirizzo IP del server di GFI FaxMaker. Ad esempio http://myfaxserver.mydomain.local:8555/faxmaker/wsapi. In alternativa, è possibile utilizzare una connessione sicura tramite HTTPS. Per ulteriori informazioni, fare riferimento a http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=wsapihttps Dal nodo Utenti con licenza registrare gli utenti che utilizzeranno API Servizio Web. Utilizzare le credenziali di questo utente nelle chiamate API. I fax ricevuti che vengono inoltrati agli utenti registrati per API Servizio Web vengono salvati nella coda di API Servizio Web e non inoltrati all utente tramite e-mail. Configurare le regole di routing per l inoltro di fax da prelevare da API Servizio Web agli utenti registrati. GFI FaxMaker conserva i fax ricevuti nella coda di API Servizio Web per 30 giorni. I fax scaduti non possono essere recuperati da API Servizio Web. Per ulteriori informazioni, fare riferimento a Gestione coda API servizio Web (pagina 34). 4.2 Guida introduttiva In Visual Studio, creare un applicazione C# Windows o Console e da Esplora soluzioni, aggiungere un riferimento web o servizio (a seconda della versione di Visual Studio). Quando viene richiesto di inserire l URL del servizio, immettare il collegamento WDSL all URL del servizio web di GFI FaxMaker. Questo è composto dall URL del servizio web di GFI FaxMaker, come indicato nella sezione Requisiti di cui GFI FaxMaker 4 API servizio Web 26

sopra, aggiungendo?singlewsdl. Ad esempio, http://mioserverfax.miodominio.com:8555/faxmaker/wsapi?singlewsdl Quando viene richiesto di inserire uno spazio dei nomi o un nome di un riferimento web, digitare FMWSAPI. Dopo aver creato l applicazione, aprire app.config. Trovare l indirizzo http://127.0.0.1:8555/faxmaker/wsapi e modificarlo con il valore dell URL servizio Web di GFI FaxMaker. Ad esempio, http://mioserverfax.miodominio.com:8555/faxmaker/wsapi Salvare le modifiche e procedere a utilizzare le seguenti classi di spazio dei nomi come classi tipiche di C#. 4.3 Funzioni API 4.3.1 SendFax Utilizzare questa funzione per inviare un fax. La funzione restituisce una matrice di FaxJobIDs. Per ogni destinatario indicato, viene creato un FaxJobID. Questo ID consente di monitorare lo stato del fax inviato a quel destinatario specifico. FMResult SendFax ( ); Parametri: FMUser user, UserDetails senderdetails, List<UserDetails> recipients, MessageDetails messagedetails, out FaxJobID[] faxjobids Parametro user senderdetails recipients[] messagedetails Le credenziali dell utente API Web. I dati dell utente. Elenco di destinatari del fax. Il fax da inviare. Valori restituiti: Parametro FMResult Faxjobids Restituisce il risultato della funzione. Una matrice di faxjobid. Per ogni destinatario vi è un id processo. Questo id processo può essere utilizzato successivamente per ottenere lo stato di un fax specifico. 4.3.2 CheckForUnreadFaxes Utilizzare questa funzione per ottenere l elenco di fax nella coda. La coda contiene tutti i fax che non sono stati scaricati GFI FaxMaker 4 API servizio Web 27

in precedenza. Ogni elemento dell elenco contiene solo i dati del fax e non l immagine effettiva. Per scaricare il fax utilizzare GetNextFax(). FMResult CheckForUnreadFaxes ( ); Parametri: FMUser user, out ReceivedFaxDetails[] receivedfaxes Parametro user Le credenziali dell utente API Web. Valori restituiti: Parametro FMResult receivedfaxes Restituisce il risultato della funzione. Una matrice di ReceivedFaxDetails. 4.3.3 GetSendingFaxStatusUpdates Utilizzare questa funzione per ottenere lo stato di un fax precedentemente inviato mediante l API SendFax. FMResult GetSendingFaxStatusUpdates ( FMUser user, long FaxJobID, out FaxSendingStatus FaxStatus ); Parametri: Parametro user FaxJobID Le credenziali dell utente API Web. L identificatore univoco assegnato a ciascun destinatario di un fax in uscita. Valori restituiti: Parametro FMResult FaxStatus Restituisce il risultato della funzione. Restituisce lo stato del fax. GFI FaxMaker 4 API servizio Web 28

4.3.4 GetNextFax Utilizzare questo metodo per ottenere il fax meno recente della coda. La coda contiene tutti i fax che non sono stati scaricati in precedenza. Quando si recupera il fax meno recente, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminare il fax meno recente, consentendo di ottenere il successivo. Se il fax meno recente non viene eliminato, verrà ricevuto nuovamente. FMResult GetNextFax ( ); Parametri: FMUser user, out ReceivedFaxDetails faxdetails, out FileData fax Parametro user Le credenziali dell utente API Web. Valori restituiti: Parametro FMResult faxdetails fax Restituisce il risultato della funzione. ReceivedFaxDetails conserva i dati del fax L'immagine fax. 4.3.5 GetNextFaxByCriteria Utilizzare questo metodo per ottenere il fax meno recente della coda, in base ai criteri indicati. La coda contiene tutti i fax che non sono stati scaricati in precedenza. Quando si recupera il fax meno recente, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminare il fax meno recente, consentendo di ottenere il successivo. Se il fax meno recente non viene eliminato, verrà ricevuto nuovamente. FMResult GetNextFaxByCriteria ( ); FMUser user, SearchCriteria criteria, stringcriteriavalue, out ReceivedFaxDetails faxdetails, out FileData fax GFI FaxMaker 4 API servizio Web 29

Parametri: Parametro user Criteri Criteriavalue Le credenziali dell utente API Web. DTMF o id remoto Il valore dei criteri Valori restituiti: Parametro FMResult faxdetails Fax Restituisce il risultato della funzione. ReceivedFaxDetails conserva i dati del fax FileData contiene i dati immagine fax effettivi. 4.3.6 DeleteFax Utilizzare questa funzione per eliminare un fax specifico. FMResult DeleteFax ( FMUser user, int FaxID ); Parametri: Parametro user FaxID Le credenziali dell utente API Web. L ID del fax da eliminare. Questo valore può essere recuperato dall output di CheckForUnreadFaxes(), GetNextFax () o GetNextFaxByCriteria(). Valori restituiti: Parametro FMResult Restituisce il risultato della funzione. 4.4 Classi 4.4.1 UserDetails Questa classe contiene i dettagli del destinatario/mittente. Tutti i campi sono facoltativi, eccetto la proprietà Faxnumber quando viene utilizzata come destinatario. GFI FaxMaker 4 API servizio Web 30

Membri dati Firstname Nome. Lastname Cognome. Company Nome azienda. Department Nome reparto. numerofax Il numero del fax. Email L indirizzo e-mail. 4.4.2 MessageDetails Un oggetto di questa classe contiene i dettagli di un nuovo fax. Tutti i campi sono facoltativi, eccetto la proprietà BillingCode quando Billing è abilitato. Membri dati Subject L oggetto del fax. Schedule DateTime Una data e ora specifica di invio del fax. Priority FaxPriority Imposta la priorità del fax. BillingCode Indica il codice di fatturazione. Obbligatorio quando è abilitato il codice di addebito. Resolution FaxResolution La risoluzione da utilizzare. Coverpage Per impostazione predefinita, il fax viene inviato utilizzando il frontespizio configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. FrontCoverNote Per impostazione predefinita, il fax viene inviato utilizzando la nota di copertina anteriore predefinita configurata in GFI FaxMaker. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. FaxLine Intero Utilizzare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Specificare il numero della linea fax come configurato in Configurazione di GFI FaxMaker. Demandline Bool Quando si indica una linea fax specifica (attributo FaxLine), se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea particolare, impostare il valore dell attributo su true. header Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax. UniqueID Specifica un identificatore che viene utilizzato per contrassegnare il messaggio. L'univocità dell'identificatore è stabilita dall'autore del messaggio. TextAPI Specifica una singola riga del comando API di testo. Per un elenco dei comandi di API di testo, fare riferimento a Comandi API di testo MessageBodyFile. FileData Un instanza di FileData, contenente un file di testo con il corpo messaggio del fax. Attachments List< FileData> Matrice di allegati. 4.4.3 FMUser Un utente API Web. GFI FaxMaker 4 API servizio Web 31

Membri dati Email L indirizzo di posta elettronica dell utente configurato nel nodo Utenti con licenza di Configurazione di GFI FaxMaker. L utente deve essere un utente registrato API Web. Password In Active Directory, questa è la password dell utente configurato. Negli ambienti SMTP la password è una GUID generata in automatico, disponibile dal nodo Utenti con licenza di Configurazione di GFI FaxMaker per gli utenti API Web registrati. 4.4.4 FaxJobID GFI FaxMaker assegna un identificatore univoco a ciascun destinatario di un fax in uscita. Utilizzare questo identificatore per monitorare lo stato di un fax. Membri dati Recipient Il numero di fax del destinatario. ID L identificatore univoco assegnato da GFI FaxMaker. 4.4.5 ReceivedFaxDetails Un oggetto di questa classe viene ricevuto quando si chiama GetNextFax(). Membri dati FaxUID Identificatore univoco del fax. Utilizzare l identificatore per l eliminazione di un fax. WhenReceived DateTime Data e ora di ricezione del fax. NosPages Numero di pagine ricevute. Resolution FaxResolution La risoluzione del fax ricevuto. RemoteID Il nome del fax del mittente. DTMF_DID Il numero di estensione DTMF/DID della linea di ricezione. 4.4.6 FileData Un oggetto di questa classe contiene i dati effettivi di un file. Membri dati Nome del file Il nome file del file, principalmente utilizzato per determinarne il formato. Data Byte[] I dati del file in una matrice di byte. 4.4.7 FaxSendingStatus Un oggetto di questa classe viene restituito quando si chiama GetSendingFaxStatusUpdates(). Membri dati FaxUID Identificatore univoco del fax. RemoteID Il nome del fax del mittente. GFI FaxMaker 4 API servizio Web 32

Membri dati CurrentTransmissionPage Intero La pagina che è in fase di trasmissione. Dopo aver inviato un fax, questo restituisce il numero totale di pagine trasmesse. TotalPages Intero Il numero totale di pagine che costituiscono il fax. Status SendingStatus Lo stato attuale del fax. 4.5 Enums 4.5.1 FaxPriority Valore None Low Normal High VeryHigh Nessuna priorità specificata. Priorità bassa. Priorità normale. Priorità alta. Priorità molto alta. 4.5.2 FaxResolution Valore NonSet High Normal Non è stata specificata nesuna risoluzione fax personalizzata. Alta risoluzione. Risoluzione normale fax. 4.5.3 SearchCriteria Valore RemoteID DTMF Ricerca i fax per ID chiamante o per nome fax. Cerca i fax per numero di estensione della linea di ricezione. 4.5.4 SendingStatus Valore Preparing ConvertingAttachment Pending Sending Sent Elaborazione e conversione del contenuto in fax. Convertirà l allegato nel formato fax. Il fax è in coda, pronto per essere inviato. Il fax è in trasmissione. Il fax è stato inviato. GFI FaxMaker 4 API servizio Web 33

Valore Failed Cancelled Trasmissione non riuscita. L operazione del fax è stata annullata. 4.5.5 FMResult Valore Success Failure UserNotValid DBError FaxImageNotFound NoSender NoRecipients InvalidFaxDescription Funzione completata con successo. Funzione non riuscita. Dati utente non validi. Errore di scrittura o lettura dal database. L immagine fax richiesta non è stata rilevata. Non è stato specificato nessun mittente o mittente non valido. Non è stato specificato nessun destinatario o destinatario non valido. Uno o più campi obbligatori non compilati. Per aiuto nello sviluppo di applicazioni personalizzate per API Servizi Web di GFI FaxMaker, fare riferimento agli esempi forniti. di Java: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=javawsapi di C#: http://go.gfi.com/?pageid=fm2015help&lang=it#cshid=netwsapi 4.6 Gestione coda API servizio Web Quando un fax viene inoltrato a un utente registrato di API Servizio Web, GFI FaxMaker salva il fax nella coda di API Servizio Web. Utilizzare le varie funzioni documentate in API Servizio Web per recuperare i fax dalla coda. Quando si recupera un fax, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminarlo. 4.6.1 Fax scaduti nella coda I fax ricevuti vengono salvati nella coda di API Servizio Web per 30 giorni. Se superano i 30 giorni, i fax vengono spostati automaticamente dalla coda e non possono essere recuperati dall API Servizio Web. Per impostazione predefinita, i fax scaduti vengono spostati nella seguente cartella: <cartella di installazione di GFI FaxMaker>/WSAPI/Retention/ Per ciascun fax spostato in questa cartella, GFI FaxMaker salva l immagine del fax nel formato.fax (può essere aperto con un visualizzatore immagini) e un file XML contenente i metadati del fax. Per modificare la cartella predefinita: 1. Arrestare tutti i servizi di GFI FaxMaker. 2. Accedere alla cartella di installazione di GFI FaxMaker. 3. Aprire il file ML.Svc.Attendant.exe.config in un editor di testo. GFI FaxMaker 4 API servizio Web 34