API PBX yang dihosting: catatan faks dan pengiriman

Gunakan HTTPS dan autentikasi HTTP Basic dengan kredensial API yang disetujui. Simpan kredensial di server aplikasi Anda. Endpoint PBX terhosting ini menggunakan /hpbx/ pada api.multitel.net; jangan menyisipkan /v3. Periksa hasil HTTP maupun status hasil operasi pada tingkat aplikasi dalam respons JSON.

Baca catatan faks

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

Ganti kode penagihan dengan kode PBX Anda. Catatan yang dikembalikan mencakup waktu faks, arah, sumber, tujuan, status pengiriman, percobaan, kesalahan, dan jumlah halaman. Pengiriman masih bisa berstatus tertunda ketika permintaan kirim telah diterima.

Mengirim parameter

Endpoint pengiriman adalah POST /hpbx/fax/send/{billing_code}. Pengiriman benar-benar menjalankan tindakan tersebut. Siapkan file dan tujuan yang diizinkan untuk akun sebelum mengirim; jangan mengulang pengiriman secara membabi buta jika hasil pengiriman sebelumnya belum pasti.

BidangArti
numberNomor faks tujuan.
cidnumCaller ID pengirim yang disetujui.
scheduleWaktu pengiriman terjadwal, jika digunakan.
faxquality / pagesize / pagerotateOpsi kualitas, ukuran kertas, dan rotasi yang didukung.
statusemailAlamat yang diizinkan untuk pemberitahuan pengiriman.
deleteaftersendMenentukan apakah file unggahan yang tersimpan harus dihapus setelah dikirim.
filenameReferensi dokumen yang diharapkan oleh alur kerja faks ini; bukan jalur file lokal sembarang.

Lacak penyelesaian

Setelah mengajukan pengiriman, periksa status, jumlah percobaan, dan kesalahan pada catatan faks. Pastikan faks benar-benar terkirim; jangan menganggap diterimanya permintaan oleh sistem sebagai bukti faks telah terkirim. Referensi faks portal menjelaskan alur unggah dan kirim saat ini; jalur dan autentikasinya terpisah dari endpoint di atas.

Cari dokumentasi