Per inviare un fax utilizzando l'API, devi prima caricare i file richiesti, quindi prepararli per l'invio via fax e programmarne la trasmissione.
Una volta programmato il fax, puoi implementare un server HTTP e sfruttare un meccanismo di webhook. Questo approccio garantisce che venga inviato un messaggio HTTP sia in caso di trasmissione riuscita del fax sia in caso di errore di trasmissione.
Nota: assicurati di aver completato il processo di autenticazione iniziale e di aver effettuato correttamente l'accesso all'API. Per ulteriori istruzioni, consulta la nostra guida qui.
Per caricare un file, avvia una richiesta HTTP POST al seguente URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
Assicurati di includere le seguenti intestazioni nella richiesta:
-
Content-Type:
multipart/form-data
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
Per il corpo della richiesta:
{
"fax_file": [file]
}
Nell'esempio seguente, "self" viene utilizzato come ID utente per rappresentare l'identificativo univoco dell'utente attualmente connesso:
Una volta caricato correttamente il file, riceverai un percorso che indica la posizione temporanea del file su Fax.Plus.
Una volta completati i caricamenti, puoi iniziare a preparare il fax per l'invio. Per avviare la procedura, esegui una richiesta HTTP POST al seguente URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Assicurati di includere le seguenti intestazioni nella richiesta:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
Per il corpo della richiesta:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Dopo la corretta pianificazione del fax, riceverai un Outbox ID. Questo ID può essere utilizzato per modificare o eliminare il fax prima che venga effettivamente inviato.
Nota: con la nostra API i fax sono associati a più ID. Questa scelta di progettazione dipende dal fatto che la trasmissione dei fax avviene in modo asincrono. In particolare, un fax in uscita viene identificato da due ID distinti: l'Outbox ID, valido fino al corretto invio del fax, e il Fax ID, che diventa l'identificativo definitivo del fax una volta trasmesso con successo.
Dopo aver pianificato il fax, puoi monitorarne lo stato consultando l'elenco dei fax presenti nella posta in uscita o nella categoria Inviati.
In alternativa, puoi configurare un server HTTP e utilizzare un webhook. In questo modo verrà inviato un messaggio HTTP quando il fax è stato inviato correttamente o se l'invio non è riuscito.
Segui questi passaggi per configurare il webhook:
- Accedi al tuo account Fax.Plus e vai alla sezione Impostazioni della dashboard.
- Nella scheda Integrazioni, trova il riquadro dei WebHook.
- Trova Fax in arrivo e Fax in arrivo. Fai clic su Gestisci per modificare il webhook.
Dopo aver configurato il webhook, riceverai la seguente notifica quando un fax in uscita è stato elaborato:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}Questo messaggio indica l'orario di trasmissione, l'esito della trasmissione del fax (tramite il campo "status") e fornisce l'ID univoco del fax. Questo Fax ID può essere utilizzato per recuperare il file del fax o ottenere un rapporto di conferma del fax.