Campi e parametri fax
Elenco dei campi e parametri supportati in XMLAPI per l’invio di fax.
Fare riferimento a fax di esempio XMLAPI.
Campi dei messaggi
Nel contenitore <fields>
, specificare le informazioni seguenti:
Oggetto | Percorso XML |
\faxmakerdata\fields\subject |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Specificare l'oggetto del fax. | |
Esempio |
<subject>Questo è l’oggetto del fax</subject> |
|
Pianifica | Percorso XML | \faxmakerdata\fields\schedule |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli |
Specificare la data e l’ora di invio del fax nel formato seguente: YYYY-MM-DD-HH:mm:ss Sostituire:
|
|
Esempio |
<schedule>2018-10-10-08:15:00</schedule> |
|
Priorità | Percorso XML | \faxmakerdata\fields\priority |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli |
Impostare la priorità del messaggio. I valori validi sono:
|
|
Esempio |
<priority>high</priority> |
|
Codice di addebito | Percorso XML | \faxmakerdata\fields\billingcode |
Tipo | Stringa | |
Disposizione | Facoltativo. Obbligatorio quando è abilitato Fatturazione. | |
Dettagli | Imposta il codice di addebito del mittente del messaggio. | |
Esempio |
<billingcode>25</billingcode> |
|
massima | Percorso XML | \faxmakerdata\fields\resolution |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli |
Utilizzare il parametro per specificare la risoluzione del fax. I valori validi sono:
|
|
Esempio |
<resolution>high</resolution> |
|
FrontespizioPagina contenente informazioni che viene allegata e inviata come prima pagina del fax. La pagina può essere personalizzata e contenere il logo e i colori dell’azienda, le informazioni su mittente e destinatario, i dettagli del fax e altro ancora. | Percorso XML | \faxmakerdata\fields\coverpage |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli |
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:
|
|
Esempio |
<coverpage>aziendale</coverpage> |
|
Nota di copertina anteriore | Percorso XML | \faxmakerdata\fields\frontcovernote |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli |
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:
|
|
Esempio |
<frontcovernote>intestazione lettera</frontcovernote> |
|
Linea faxUna linea telefonica fisica o basata su software (FoIP), collegata a una periferica fax, ad esempio un modem o una scheda ISDN/fax. | Percorso XML | \faxmakerdata\fields\faxline |
Tipo | Numero | |
Disposizione | Facoltativo | |
Dettagli |
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:
|
|
Esempio |
<faxline demandline="true">3</faxline> |
|
Intestazione | Percorso XML | \faxmakerdata\fields\faxheader |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax. | |
Esempio |
<faxheader>Questa è l’intestazione del fax</faxheader> |
|
ID univoco | Percorso XML | \faxmakerdata\fields\uid |
Tipo | Stringa [255 caratteri al massimo] | |
Disposizione | Facoltativo | |
Dettagli | 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. | |
Esempio |
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> |
|
API di testo | Percorso XML | \faxmakerdata\fields\textapi |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Utilizzato per specificare una linea singola di comandi di API di testo (incluso il prefisso '::‘). Questo campo può essere specificato più volte. | |
Esempio |
<textapi>::billingcode=25,line=3</textapi> |
|
File del corpo del messaggio | Percorso XML | \faxmakerdata\fields\bodyfile |
Tipo | Percorso completo o nome file | |
Disposizione |
Facoltativo NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. |
|
Dettagli |
Utilizza i contenuti del file come corpo del messaggio nel frontespizio del fax. Indicare il file del corpo nel formato seguente:
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:
Se non è specificato alcun attributo del tipo di file, il messaggio viene immesso come testo normale. |
|
Esempio |
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> |
|
Allegato | Percorso XML | \faxmakerdata\fields\attachment |
Tipo | Percorso completo o nome file | |
Disposizione |
Facoltativo (massimo 60 allegati) NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. |
|
Dettagli |
Aggiunge i contenuti del file specificato al fax. Indicare il file del corpo nel formato seguente:
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, |
|
Esempio |
<attachment>c:\temp\document.doc</attachment> |
Campi del mittente
Nel contenitore <sender>
, indicare le informazioni del mittente come segue:
Nome | Percorso XML | \faxmakerdata\sender\firstname |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il nome del mittente. | |
Esempio |
<firstname>John</firstname> |
|
Cognome | Percorso XML | \faxmakerdata\sender\lastname |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il cognome del mittente. | |
Esempio |
<lastname>Smith</lastname> |
|
Azienda | Percorso XML | \faxmakerdata\sender\company |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il nome dell'azienda del mittente. | |
Esempio |
<company>Nome azienda</company> |
|
Reparto | Percorso XML | \faxmakerdata\sender\department |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il reparto del mittente. | |
Esempio |
<department>Vendita</department> |
|
Numero telefono | Percorso XML | \faxmakerdata\sender\voicenumber |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il numero di telefono del mittente. | |
Esempio |
<voicenumber>+1(800)1234 5678</voicenumber> |
|
Indirizzo di posta elettronica | Percorso XML | \faxmakerdata\sender\emailaddress |
Tipo | Stringa | |
Disposizione | Obbligatorio | |
Dettagli | Imposta l'indirizzo di posta elettronica del mittente. | |
Esempio |
<emailaddress>jsmith@mydomain.com</emailaddress> |
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>
<recipient>
<faxnumber>+1 800 1234 5678</faxnumber>
</recipient>
</fax>
</recipients>
NOTA
È inoltre possibile inviare il fax a più destinatari. Per ulteriori informazioni, fare riferimento a Invio di fax a più destinatari.
Inserire altri parametri e campi nel contenitore <recipient> come segue:
Nome | Percorso XML | \faxmakerdata\recipients\fax\recipient\firstname |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il nome del destinatario. | |
Esempio |
<firstname>Joe</firstname> |
|
Cognome | Percorso XML | \faxmakerdata\recipients\fax\recipient\lastname |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il cognome del destinatario. | |
Esempio |
<lastname>Bloggs</lastname> |
|
Azienda | Percorso XML | \faxmakerdata\recipients\fax\recipient\company |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il nome dell'azienda del destinatario. | |
Esempio |
<company>Destinatariofax azienda Ltd.</company> |
|
Reparto | Percorso XML | \faxmakerdata\recipients\fax\recipient\department |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il reparto del destinatario. | |
Esempio |
<department>Marketing</department> |
|
Numero fax | Percorso XML | \faxmakerdata\recipients\fax\recipient\faxnumber |
Tipo | Stringa | |
Disposizione | Obbligatorio | |
Dettagli | Imposta il numero di fax del destinatario. | |
Esempio |
<faxnumber>+1(800)8765 4321</faxnumber> |
|
Numero telefono | Percorso XML | \faxmakerdata\recipients\fax\recipient\voicenumber |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta il numero di telefono del destinatario. | |
Esempio |
<voicenumber>+1(800)8765 4444</voicenumber> |
|
Indirizzo di posta elettronica | Percorso XML | \faxmakerdata\recipients\fax\recipient\emailaddress |
Tipo | Stringa | |
Disposizione | Facoltativo | |
Dettagli | Imposta l'indirizzo di posta elettronica del destinatario. | |
Esempio |
<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>
<fax>
<recipient>
<firstname>Bob</firstname>
<faxnumber>+1 800 1111 1111</faxnumber>
</recipient>
<recipient>
<firstname>John</firstname>
<faxnumber>+1 800 2222 2222</faxnumber>
</recipient>
</fax>
</recipients>