Alegeți un document de intrare sau de ieșire
Acest punct de acces pentru compatibilitate preia un document fax care aparține contului dumneavoastră. Folosiți un cont MultiTEL API activat, prin HTTPS, cu datele de autentificare și restricțiile IP configurate pentru acesta. Acest punct de acces nu trimite și nu retrimite faxuri.
| Parametru | Obligatoriu | Semnificație |
|---|---|---|
type | Da | Folosiți inbound sau outbound, exact în forma indicată. |
id | Da | Pentru inbound, folosiți valoarea hash returnată de fax_inbox. Pentru outbound, folosiți valoarea uuid returnată de fax_outbox. |
Aceste valori trebuie incluse în cale. Ruta este /v3/fax_file/{type}/{id}, nu fax_download cu segmente suplimentare în cale. Hash-ul pentru faxul de intrare nu este identificatorul numeric al înregistrării și nici identificatorul unei sarcini de trimitere. Copiați identificatorul din lista căsuței corespunzătoare; acesta nu înlocuiește autentificarea.
Descărcați un fax primit
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/c20ad4d76fe97759aa27a0c99bff6710Hash-ul din exemplu reprezintă înregistrarea fictivă 12 din căsuța de primire. Obțineți propria valoare din fax_inbox. Descărcarea unei înregistrări de intrare existente o marchează ca vizualizată. Acest lucru se întâmplă înainte de verificarea disponibilității fișierului, astfel încât, chiar dacă apare o eroare de fișier indisponibil, viewed poate rămâne setat la true. Nu folosiți acest punct de acces doar pentru a verifica dacă există un fax primit dacă doriți ca starea sa de vizualizare să rămână neschimbată.
Rutina de procesare acordă prioritate unui fișier PDF stocat. În caz contrar, folosește fișierul TIFF stocat și încearcă să îl convertească în PDF atunci când convertorul este disponibil. Dacă conversia nu este disponibilă sau generează o excepție tratată, returnează în schimb fișierul TIFF. Verificați întotdeauna antetul Content-Type returnat, în loc să presupuneți că formatul este PDF.
Descărcați un fax de ieșire
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/0123456789abcdef0123456789abcdefFolosiți valoarea uuid din fax_outbox. Această descărcare pentru compatibilitate acordă prioritate unui obiect binar PDF stocat, apoi unui obiect binar TIFF, apoi unui fișier PDF, unui fișier TIFF sau fișierului sursă original, dacă este disponibil. Ordinea de prioritate diferă de cea a rutinei actuale pentru faxurile de ieșire fax_download. Pentru integrările noi care folosesc send_fax, folosiți acel flux actual de descărcare cu parametrul său job_id.
Un fișier sursă original poate fi returnat ca application/octet-stream, în loc de PDF sau TIFF. Numele fișierului atașat poate păstra extensia sursei. Descărcarea pentru compatibilitate a faxurilor de ieșire nu marchează nicio înregistrare din căsuța de primire ca vizualizată, nu modifică starea sarcinii și nu creează o transmisie.
Gestionați separat octeții și erorile
În caz de succes, sunt returnați octeții neprelucrați ai documentului, împreună cu antetele Content-Type, Content-Disposition pentru atașament și Content-Length. Răspunsul nu este o structură JSON care încapsulează date în Base64. Salvați separat antetele și octeții, conform exemplului, verificați tipul răspunsului și abia apoi atribuiți fișierului un nume adecvat sau procesați-l. O extensie sursă permisă nu garantează că documentul este valid sau convertit.
Codul API 400 înseamnă că lipsește o valoare obligatorie din cale sau că type nu este valid. Codul API 404 înseamnă că înregistrarea din contul respectiv sau fișierul acesteia nu este disponibil. Erorile folosesc structura obișnuită JSON cu status/response și pot folosi HTTP 200. Verificați antetul Content-Type al răspunsului și valoarea status.code din JSON, pentru a nu deschide corpul unui răspuns de eroare ca document.
Confidențialitate și disponibilitate
Conținutul faxurilor poate include informații sensibile. Stocați fișierele descărcate doar în locuri accesibile destinatarilor vizați și evitați includerea tuturor octeților documentului în jurnale. O înregistrare în căsuța de fax nu garantează că fișierul acesteia va rămâne disponibil. Nu a fost stabilită nicio perioadă de păstrare a fișierelor și nicio garanție de compatibilitate pentru toate documentele stocate în trecut.