Pengembang

GET/v3/fax_file/{type}/{id}

Unduh faks dari kotak masuk atau kotak keluar

Ambil faks yang diterima menggunakan hash kotak masuknya atau dokumen keluar yang lebih lama menggunakan UUID-nya, lalu tangani format berkas yang dikembalikan.

Di halaman ini
  1. Pilih dokumen masuk atau keluar
  2. Unduh faks yang diterima
  3. Unduh faks keluar
  4. Tangani bita dan kesalahan secara terpisah
  5. Privasi dan ketersediaan

Pilih dokumen masuk atau keluar

Titik akhir kompatibilitas ini mengambil dokumen faks milik akun Anda. Gunakan akun API MultiTEL yang aktif melalui HTTPS dengan kredensial dan pembatasan IP yang telah dikonfigurasi untuk akun tersebut. Titik akhir ini tidak mengirim atau mengirim ulang faks.

Parameter jalur unduhan
ParameterWajibArti
typeYaGunakan inbound atau outbound, persis seperti yang ditampilkan.
idYaUntuk inbound, gunakan hash yang dikembalikan oleh fax_inbox. Untuk outbound, gunakan uuid yang dikembalikan oleh fax_outbox.

Nilai-nilai ini harus ditempatkan di jalur. Rutenya adalah /v3/fax_file/{type}/{id}, bukan fax_download dengan segmen jalur tambahan. Hash faks masuk bukan ID rekaman numerik dan bukan ID pekerjaan keluar. Salin pengenal dari daftar kotak surat yang sesuai; pengenal ini tidak menggantikan autentikasi.

Unduh faks yang diterima

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/c20ad4d76fe97759aa27a0c99bff6710

Hash dalam contoh mewakili rekaman kotak masuk fiktif 12. Dapatkan nilai Anda sendiri dari fax_inbox. Mengunduh rekaman masuk yang sudah ada akan menandainya sebagai telah dilihat. Hal ini terjadi sebelum ketersediaan berkas diperiksa, sehingga kesalahan berkas tidak tersedia tetap dapat membuat viewed bernilai true. Jangan gunakan titik akhir ini hanya untuk memeriksa apakah faks yang diterima ada jika Anda ingin status telah dilihatnya tetap tidak berubah.

Penangan mengutamakan PDF yang tersimpan. Jika tidak ada, penangan menggunakan TIFF yang tersimpan dan mencoba mengonversinya ke PDF apabila alat konversi tersedia. Jika konversi tidak tersedia atau menimbulkan pengecualian yang ditangani, penangan mengembalikan TIFF sebagai gantinya. Selalu periksa Content-Type yang dikembalikan, jangan menganggap formatnya pasti PDF.

Unduh faks keluar

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/0123456789abcdef0123456789abcdef

Gunakan uuid dari fax_outbox. Unduhan kompatibilitas ini mengutamakan blob PDF yang tersimpan, lalu blob TIFF, lalu berkas PDF, berkas TIFF, atau berkas sumber asli yang tersedia. Urutan prioritasnya berbeda dari penangan unduhan keluar saat ini, yaitu fax_download. Untuk integrasi baru yang menggunakan send_fax, gunakan alur kerja unduhan saat ini tersebut dengan parameter job_id-nya.

Berkas sumber asli dapat dikembalikan sebagai application/octet-stream, bukan PDF atau TIFF. Nama berkas lampiran dapat tetap menggunakan ekstensi sumber. Unduhan keluar kompatibilitas ini tidak menandai rekaman kotak masuk sebagai telah dilihat, mengubah status pekerjaan, atau membuat transmisi.

Tangani bita dan kesalahan secara terpisah

Jika berhasil, respons mengembalikan bita mentah dokumen dengan header Content-Type, Content-Disposition yang menyatakan lampiran, dan Content-Length. Respons ini bukan pembungkus JSON berisi data Base64. Simpan header dan bita secara terpisah seperti yang ditunjukkan, periksa jenis respons, dan baru setelah itu beri berkas nama yang sesuai atau proses berkas tersebut. Ekstensi sumber yang diizinkan tidak menjamin bahwa dokumen valid atau telah dikonversi.

Kode API 400 berarti nilai jalur yang wajib tidak ada atau type tidak valid. Kode API 404 berarti rekaman dalam cakupan akun atau berkasnya tidak tersedia. Kesalahan menggunakan pembungkus JSON status/response biasa dan dapat menggunakan HTTP 200. Periksa Content-Type respons dan status.code dalam JSON agar isi respons kesalahan tidak dibuka sebagai dokumen.

Privasi dan ketersediaan

Isi faks dapat memuat informasi sensitif. Simpan berkas yang diunduh hanya di tempat yang dapat diakses oleh penerima yang Anda tuju, dan hindari mencantumkan seluruh bita dokumen dalam log. Adanya rekaman kotak surat tidak menjamin bahwa berkasnya akan tetap tersedia. Belum ada masa penyimpanan berkas atau jaminan kompatibilitas yang ditetapkan untuk setiap dokumen yang tersimpan dari masa lalu.