Kirim faks | MultiTEL

Sebelum mengirim

Gunakan nomor pengirim yang berhak Anda tampilkan dan kirimkan kepada penerima yang menantikan faks Anda. Permintaan ini membuat transmisi nyata yang mungkin dikenai biaya. Gunakan dokumen PDF atau TIFF yang sudah disiapkan agar hasil pendeteksian halaman paling dapat diprediksi. Respons bahwa faks masuk antrean mengonfirmasi penerimaan permintaan, bukan keberhasilan pengantaran.

Gunakan akun API MultiTEL yang aktif. Kirim kredensial HTTP Basic untuk akun berbasis kata sandi, atau token Bearer untuk akun berbasis token. Izin akun dan pembatasan IP tetap berlaku. Jangan gunakan kredensial proses pekerja internal.

Unggah dokumen

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

Kolom permintaan
Kolom	Wajib	Keterangan
`from_number`	Ya	Nomor pengirim yang berhak Anda gunakan. Gunakan format internasional yang diawali dengan + dan kode negara.
`to_number`	Ya	Nomor faks tujuan dalam format internasional.
`fax_file`	Ya, untuk permintaan multibagian	Dokumen yang diunggah. Biarkan curl menetapkan Content-Type dan batas pemisah untuk permintaan multibagian.
`webhook_url`	Tidak	URL panggilan balik HTTP atau HTTPS yang opsional; HTTPS lebih disarankan. Isi data panggilan balik dan jaminan pengantarannya masih ditinjau: periksa fax_status secara berkala untuk mengikuti alur pemeriksaan status yang didokumentasikan.

JSON juga diterima dengan Content-Type: application/json, kolom nomor yang sama dan webhook_url yang opsional, serta file_name dan file_b64. file_b64 berisi bita dokumen dalam format Base64 yang ketat, tanpa awalan data:. fax_file multibagian yang valid diutamakan. Ini bukan API untuk mengambil berkas dari URL berkas.

Batas dokumen dan pengajuan

Aplikasi menerima paling banyak 15,728,640 bita dokumen setelah didekode (15 MiB), dengan ekstensi pdf, tif, tiff, jpg, jpeg, png, doc, docx, atau txt. Ekstensi yang diizinkan tidak menjamin layanan dapat menghitung atau mengonversi halaman. Batas permintaan pada infrastruktur mungkin lebih rendah, dan Base64 memperbesar ukuran permintaan.

Untuk setiap akun, aplikasi saat ini mengizinkan satu tugas yang mengantre atau sedang dikirim ke tujuan yang sama, paling banyak lima pengajuan ke tujuan tersebut dalam satu jam terakhir, dan paling banyak 50 pengajuan secara keseluruhan dalam satu jam terakhir. Respons pembatasan laju menggunakan kode API 429. Tunggu sebelum mencoba lagi; jangan mencoba mengakali batas tersebut.

Simpan ID tugas

Baca hasil HTTP serta status.code dalam JSON. Kegagalan JSON dapat diterima dengan HTTP 200. Respons JSON yang berhasil memiliki status dan response; contoh menggunakan data fiktif.

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

Periksa secara berkala fax_status menggunakan response.job_id. Jika respons pengiriman hilang, periksa kotak keluar portal sebelum mengirim lagi: permintaan berulang dapat membuat transmisi terpisah. Penangan ini tidak menyediakan parameter idempotensi untuk klien.

Kesalahan dan pemeriksaan saldo

Kode API mencakup 400 untuk kolom yang tidak diisi, URL panggilan balik yang tidak valid, dokumen yang ditolak, atau kegagalan pendeteksian halaman; 401 jika autentikasi tidak disertakan; 402 ketika perkiraan biaya faks ditambah perkiraan biaya tugas yang mengantre atau sedang dikirim melebihi saldo akun yang tersedia; 429 untuk pembatasan laju; dan 500 untuk kegagalan pada tahap penyiapan. Baca status.msg untuk mengetahui alasan spesifiknya.

Antrean mencatat perkiraan biaya sebelum transmisi. Jangan menganggap penerimaan permintaan, pemeriksaan saldo, atau perkiraan ini sebagai konfirmasi bahwa pembebanan biaya telah selesai. Rincian penagihan akhir dan panggilan balik masih harus diverifikasi.