Per inviare un fax utilizzando l'API, è necessario prima caricare i file richiesti, seguita dalla preparazione di tali file per faxare e programmare la loro trasmissione.
Una volta che il fax è programmato, è possibile implementare un server HTTP e sfruttare un meccanismo webhook. Questo approccio garantisce che un messaggio HTTP venga inviato sia in caso di trasmissione di fax che in caso di guasto della trasmissione.
Nota: Assicurati di aver completato il processo di autenticazione iniziale e di aver effettuato con successo l'accesso all'API. Per ulteriori istruzioni, consultare la nostra guida qui.
Per caricare un file, avviare una richiesta HTTP POST al seguente URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' o 'tiff']
Assicurati di includere le seguenti intestazioni nella tua richiesta:
-
- Tipo Di Contenuto:
multipart/form-data
- Tipo Di Contenuto:
-
- Autorizzazione:
Portatore [token di accesso]
- Autorizzazione:
-
- x-fax-clientid:
[ID cliente]
- x-fax-clientid:
Per il corpo:
{
"fax_file": [file]
}
Nell'esempio seguente, "self" viene utilizzato come ID utente per rappresentare l'identificazione univoca dell'utente attualmente registrato:
Una volta che il file è stato caricato con successo, riceverai un percorso che porta alla posizione temporanea del file su Fax.Plus.
Una volta completati i caricamenti, puoi iniziare a preparare il tuo fax per l'invio di. Per avviare il processo, eseguire una richiesta HTTP POST al seguente URL:
https://restapi.fax. lus/v3/accounts/[user ID]/outbox
Assicurati di includere le seguenti intestazioni nella tua richiesta:
-
- Autorizzazione:
Portatore [token di accesso]
- x-fax-clientid:
[ID cliente]
- Autorizzazione:
Per l’organismo richiedente:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Una volta completato il programma del fax, ti verrà fornito un ID Posta in uscita. Questo ID può essere utilizzato per apportare modifiche o eliminare il fax prima che venga effettivamente inviato.
Nota: I fax sono associati a più ID con la nostra API. Questo disegno è in atto perché la trasmissione di fax funziona in modo asincrono. In particolare, un fax in uscita sarà identificato da due identificativi distinti: ID in uscita, che serve al suo scopo fino a quando il fax non viene inviato con successo, e ID di fax, che diventa l'identificatore definitivo del fax una volta che è stato trasmesso.
Dopo aver programmato il fax, è possibile monitorare il suo stato esaminando l'elenco dei fax situati nella casella o la categoria inviata.
In alternativa, hai la possibilità di stabilire un server HTTP e utilizzare un webhook. Questo attiverà un messaggio HTTP da inviare quando il fax viene inviato con successo o se c'è un errore nell'invio.
Segui questi passaggi per configurare il Webhook:
- Accedi al tuo account Fax.Plus e vai alla sezione Profilosulla tua Dashboard.
- Sotto la scheda Integrazioni, trova la casella per i Web Hook.
- Trova fax in arrivo e fax in arrivo. Clicca su Gestisci per modificare il Webhook.
Una volta configurato il Webhook, riceverai la seguente notifica una volta che un fax in uscita sarà stato elaborato:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.esempio. om/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxx",
"costo": 1,
"status": "successo"
}
}
Questo messaggio ti fornirà il tempo di trasmissione, indicare il successo della trasmissione via fax (attraverso il campo "status"), e fornirvi l'ID unico del fax. Questo ID fax può essere utilizzato per recuperare il file fax o ottenere un rapporto di conferma fax.