Scegliere un documento in entrata o in uscita
Questo endpoint di compatibilità recupera un documento fax appartenente al tuo account. Usa un account API MultiTEL abilitato tramite HTTPS, con le credenziali e le restrizioni IP configurate per tale account. Non invia né reinvia fax.
| Parametro | Obbligatorio | Significato |
|---|---|---|
type | Sì | Usa inbound oppure outbound, esattamente come indicato. |
id | Sì | Per inbound, usa il valore hash restituito da fax_inbox. Per outbound, usa il valore uuid restituito da fax_outbox. |
Questi valori vanno inseriti nel percorso. La rotta è /v3/fax_file/{type}/{id}, non fax_download con segmenti di percorso aggiuntivi. L'hash del fax in entrata non è l'ID numerico del record né l'ID di un'attività in uscita. Copia l'identificatore dall'elenco della casella di posta appropriata; non sostituisce l'autenticazione.
Scaricare un fax ricevuto
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710L'hash di esempio rappresenta il record fittizio 12 della posta in arrivo. Ottieni il valore relativo al tuo record da fax_inbox. Il download di un record in entrata esistente lo contrassegna come visualizzato. Questo avviene prima della verifica della disponibilità del file, quindi un errore di file non disponibile può comunque lasciare viewed impostato su true. Non usare questo endpoint solo per verificare se esiste un fax ricevuto se vuoi che il suo stato di visualizzazione rimanga invariato.
Il gestore dà la precedenza a un file PDF memorizzato. In caso contrario usa il file TIFF memorizzato e tenta la conversione in PDF quando il convertitore è disponibile. Se la conversione non è disponibile o genera un'eccezione gestita, restituisce invece il file TIFF. Controlla sempre il valore Content-Type restituito, senza presumere che il formato sia PDF.
Scaricare un fax in uscita
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdefUsa il valore uuid ottenuto da fax_outbox. Questo download di compatibilità dà la precedenza a un oggetto binario PDF memorizzato, poi a un oggetto binario TIFF, quindi a un file PDF, a un file TIFF o al file sorgente originale disponibile. Il suo ordine di preferenza è diverso da quello dell'attuale gestore dei fax in uscita fax_download. Per le nuove integrazioni che usano send_fax, usa quel flusso di download attuale con il relativo parametro job_id.
Un file sorgente originale può essere restituito come application/octet-stream anziché come PDF o TIFF. Il nome del file allegato può mantenere l'estensione del file sorgente. Il download di compatibilità per i fax in uscita non contrassegna come visualizzato un record della posta in arrivo, non modifica lo stato dell'attività e non crea una trasmissione.
Gestire separatamente byte ed errori
In caso di successo vengono restituiti i byte grezzi del documento con le intestazioni Content-Type, Content-Disposition per l'allegato e Content-Length. Non si tratta di una struttura JSON contenente dati in Base64. Salva separatamente intestazioni e byte come mostrato, controlla il tipo di risposta e solo dopo assegna al file un nome appropriato o elaboralo. Un'estensione sorgente consentita non garantisce che il documento sia valido o sia stato convertito.
Il codice API 400 indica che manca un valore obbligatorio nel percorso oppure che type non è valido. Il codice API 404 indica che il record relativo all'account o il suo file non è disponibile. Gli errori usano la normale struttura JSON status/response e possono usare HTTP 200. Controlla il valore Content-Type della risposta e il campo status.code del contenuto JSON, per evitare che il corpo di un errore venga aperto come documento.
Riservatezza e disponibilità
Il contenuto dei fax può includere informazioni sensibili. Conserva i file scaricati solo in posizioni accessibili ai destinatari previsti ed evita di includere nei log tutti i byte dei documenti. La presenza di un record nella casella di posta non garantisce che il relativo file rimanga disponibile. Non è stato stabilito alcun periodo di conservazione dei file né alcuna garanzia di compatibilità per tutti i documenti storici memorizzati.