Come posso inviare un fax utilizzando l'API?

Aggiornato 11 settembre 2026 17:05

Chi può utilizzare questa funzionalità?

Disponibile con il piano Enterprise.

Tutti i membri.

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 eseguito correttamente l'accesso all'API. Per ulteriori istruzioni, consulta la nostra guida qui.

Passo 1: Carica i file da inviare via fax

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 tua 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 user ID per rappresentare l'identificativo univoco dell'utente attualmente connesso:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

Una volta caricato correttamente il file, riceverai un percorso che porta alla posizione temporanea del file su Fax.Plus.

Passo 2: Invia un fax tramite API

Una volta completati i caricamenti, puoi iniziare a preparare il tuo fax per l'invio. Per iniziare il processo, esegui una richiesta HTTP POST al seguente URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

Assicurati di includere le seguenti intestazioni nella tua richiesta:

- Authorization:
```
Bearer [access token]
```
- x-fax-clientid:
```
[client ID]
```

Per il corpo della richiesta:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

Una volta programmato correttamente il fax, ti verrà fornito un Outbox ID. Questo ID può essere utilizzato per apportare modifiche o eliminare il fax prima che venga effettivamente inviato.

Nota: con la nostra API, i fax sono associati a più ID. Questo design esiste perché la trasmissione del fax opera in modo asincrono. In particolare, un fax in uscita sarà identificato da due ID distinti: l'Outbox ID, che svolge la sua funzione fino all'invio riuscito del fax, e il Fax ID, che diventa l'identificativo definitivo del fax una volta trasmesso con successo.

Passo 3: Usa i webhook per verificare lo stato del fax inviato

Dopo aver programmato il fax, puoi monitorare il suo stato controllando l'elenco dei fax situato nella posta in uscita o nella categoria inviati.

In alternativa, hai la possibilità di configurare un server HTTP e utilizzare un webhook. Questo attiverà l'invio di un messaggio HTTP quando il fax viene inviato con successo o in caso di errore nell'invio.

Segui questi passaggi per configurare il Webhook:

Accedi al tuo account Fax.Plus e vai alla sezione Impostazioni sulla tua Dashboard.
Nella scheda Integrazioni, trova il riquadro per WebHooks.
Trova Fax in arrivo e Fax in arrivo. Clicca su Gestisci per modificare il Webhook.

Una volta 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 ti fornirà l'orario di trasmissione, indicherà l'esito positivo della trasmissione del fax (tramite il campo "status") e ti fornirà l'ID univoco del fax. Questo ID del fax può essere utilizzato per recuperare il file del fax o per ottenere un rapporto di conferma del fax.

Need Support?