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.

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 HTTPHypertext Transfer Protocol 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 Porta API servizio Web.
Accedere al Servizio Web di GFI FaxMaker tramite Servizi Web XML sulla porta HTTP 8555, tramite l’URLUniform Resource Locator è l'indirizzo di una pagina web nel world wide web.:
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 Utilizzo di API servizio Web tramite connessione HTTPS sicura.
Dal nodo Utenti con licenza registrare gli utenti che utilizzeranno API Servizio Web. Utilizzare le credenziali di questo utente nelle chiamate API. Per ulteriori informazioni, fare riferimento a Utenti API servizio Web.
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. Per ulteriori informazioni, fare riferimento a Routing di fax.
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.

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

(

FMUser user,

UserDetails senderdetails,

List<UserDetails> recipients,

MessageDetails messagedetails,

out FaxJobID[] faxjobids

);

Parametri:

Parametro	Descrizione
user	Le credenziali dell’utente API Web.
senderdetails	I dati dell’utente.
recipients[]	Elenco di destinatari del fax.
messagedetails	Il fax da inviare.

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.
Faxjobids	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.

CheckForUnreadFaxes

Utilizzare questa funzione per ottenere l’elenco di fax nella coda. La coda contiene tutti i fax che non sono stati scaricati 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

(

FMUser user,

out ReceivedFaxDetails[] receivedfaxes

);

Parametri:

Parametro	Descrizione
user	Le credenziali dell’utente API Web.

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.
receivedfaxes	Una matrice di `ReceivedFaxDetails`.

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	Descrizione
user	Le credenziali dell’utente API Web.
FaxJobID	L’identificatore univoco assegnato a ciascun destinatario di un fax in uscita.

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.
FaxStatus	Restituisce lo stato del fax.

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

(

FMUser user,

out ReceivedFaxDetails faxdetails,

out FileData fax

);

Parametri:

Parametro	Descrizione
user	Le credenziali dell’utente API Web.

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.
faxdetails	ReceivedFaxDetails conserva i dati del fax
fax	L'immagine fax.

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.

FMResult GetNextFaxByCriteria

(

FMUser user,

SearchCriteria criteria,

stringcriteriavalue,

out ReceivedFaxDetails faxdetails,

out FileData fax

);

Parametri:

Parametro	Descrizione
user	Le credenziali dell’utente API Web.
Criteri	DTMFSegnalazione Dual-tone multi-frequency o id remoto
Criteriavalue	Il valore dei criteri

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.
faxdetails	ReceivedFaxDetails conserva i dati del fax
Fax	FileData contiene i dati immagine fax effettivi.

DeleteFax

Utilizzare questa funzione per eliminare un fax specifico.

FMResult DeleteFax

(

FMUser user,

int FaxID

);

Parametri:

Parametro	Descrizione
user	Le credenziali dell’utente API Web.
FaxID	L’ID del fax da eliminare. Questo valore può essere recuperato dall’output di `CheckForUnreadFaxes()`, `GetNextFax()` o `GetNextFaxByCriteria()`.

Valori restituiti:

Parametro	Descrizione
FMResult	Restituisce il risultato della funzione.

Classi

UserDetails

Questa classe contiene i dettagli del destinatario/mittente.

Tutti i campi sono facoltativi, eccetto la proprietà Faxnumber quando viene utilizzata come destinatario.

Membri dati	Tipo	Descrizione
Firstname	Stringa	Nome.
Lastname	Stringa	Cognome.
Company	Stringa	Nome azienda.
Department	Stringa	Nome reparto.
numerofax	Stringa	Il numero del fax.
Email	Stringa	L’indirizzo e-mail.

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	Tipo	Descrizione
Subject	Stringa	L’oggetto del fax.
Schedule	DateTime	Una data e ora specifica di invio del fax.
Priority	FaxPriority	Imposta la priorità del fax.
BillingCode	Stringa	Indica il codice di fatturazione. Obbligatorio quando è abilitato Billing.
Resolution	FaxResolution	La risoluzione da utilizzare.
Coverpage	Stringa	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	Stringa	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	Stringa	Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax.
UniqueID	Stringa	Specifica un identificatore che viene utilizzato per contrassegnare il messaggio. L'univocità dell'identificatore è stabilita dall'autore del messaggio.
TextAPI	Stringa	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.

FMUser

Un utente API Web.

Membri dati	Tipo	Descrizione
Email	Stringa	L’indirizzo di posta elettronica dell’utente configurato in Utenti con licenza. L’utente deve essere un utente registrato API Web.
Password	Stringa	In Active Directory, questa è la password dell’utente configurato. Negli ambienti SMTPSimple Mail Transport Protocol la password è una GUID generata in automatico, disponibile dal nodo Utenti con licenza per gli utenti API Web registrati.

Membri dati

Tipo

Descrizione

Stringa

L’indirizzo di posta elettronica dell’utente configurato in Utenti con licenza. L’utente deve essere un utente registrato API Web.

Password

Stringa

In Active Directory, questa è la password dell’utente configurato.

Negli ambienti SMTPSimple Mail Transport Protocol la password è una GUID generata in automatico, disponibile dal nodo Utenti con licenza per gli utenti API Web registrati.

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	Tipo	Descrizione
Recipient	Stringa	Il numero di fax del destinatario.
ID	Stringa	L’identificatore univoco assegnato da GFI FaxMaker.

ReceivedFaxDetails

Un oggetto di questa classe viene ricevuto quando si chiama GetNextFax().

Membri dati	Tipo	Descrizione
FaxUID	Stringa	Identificatore univoco del fax. Utilizzare l’identificatore per l’eliminazione di un fax.
WhenReceived	DateTime	Data e ora di ricezione del fax.
NosPages	Stringa	Numero di pagine ricevute.
Resolution	FaxResolution	La risoluzione del fax ricevuto.
RemoteID	Stringa	Il nome del fax del mittente.
DTMF_DID	Stringa	Il numero di estensione DTMF/DID della linea di ricezione.

FileData

Un oggetto di questa classe contiene i dati effettivi di un file.

Membri dati	Tipo	Descrizione
Nome del file	Stringa	Il nome file del file, principalmente utilizzato per determinarne il formato.
Data	Byte[]	I dati del file in una matrice di byte.

FaxSendingStatus

Un oggetto di questa classe viene restituito quando si chiama GetSendingFaxStatusUpdates().

Membri dati	Tipo	Descrizione
FaxUID	Stringa	Identificatore univoco del fax.
RemoteID	Stringa	Il nome del fax del mittente.
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.

Enums

FaxPriority

Valore	Descrizione
None	Nessuna priorità specificata.
Low	Priorità bassa.
Normal	Priorità normale.
High	Priorità alta.
VeryHigh	Priorità molto alta.

FaxResolution

Valore	Descrizione
NonSet	Non è stata specificata nesuna risoluzione fax personalizzata.
High	Alta risoluzione.
Normal	Risoluzione normale fax.

SearchCriteria

Valore	Descrizione
RemoteID	Ricerca i fax per ID chiamante o per nome fax.
DTMF	Cerca i fax per numero di estensione della linea di ricezione.

SendingStatus

Valore	Descrizione
Preparing	Elaborazione e conversione del contenuto in fax.
ConvertingAttachment	Convertirà l’allegato nel formato fax.
Pending	Il fax è in coda, pronto per essere inviato.
Sending	Il fax è in trasmissione.
Sent	Il fax è stato inviato.
Failed	Trasmissione non riuscita.
Cancelled	L’operazione del fax è stata annullata.

FMResult

Valore	Descrizione
Success	Funzione completata con successo.
Failure	Funzione non riuscita.
UserNotValid	Dati utente non validi.
DBError	Errore di scrittura o lettura dal database.
FaxImageNotFound	L’immagine fax richiesta non è stata rilevata.
NoSender	Non è stato specificato nessun mittente o mittente non valido.
NoRecipients	Non è stato specificato nessun destinatario o destinatario non valido.
InvalidFaxDescription	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.

Provalo subito gratuitamente›

Argomenti correlati

GFI FaxMaker Guida di 19.2

Home

Liberatoria

Versione di prova gratuita›

API servizio Web

Parametri:

Valori restituiti:

Parametri:

Valori restituiti:

Parametri:

Valori restituiti:

Parametri:

Valori restituiti:

Parametri:

Valori restituiti:

Parametri:

Valori restituiti:

Argomenti correlati

GFI FaxMaker Guida di 19.2

Copyright © GFI Software 2018

Feedback

Condividi