Pengembang

GET/v3/fax_inbox

Tampilkan daftar faks yang diterima

Baca kotak masuk faks Anda dengan pembagian halaman, pencarian nomor, dan filter tanggal penerimaan.

Di halaman ini
  1. Tampilkan daftar faks yang diterima
  2. Baca halaman kotak masuk
  3. Tangani daftar kosong dan daftar yang berubah
  4. Akses dokumen dan privasi

Tampilkan daftar faks yang diterima

Gunakan akun API MultiTEL yang aktif melalui HTTPS dengan kredensial dan pembatasan IP yang telah dikonfigurasi untuk akun tersebut. Endpoint ini menampilkan daftar faks yang diterima oleh akun yang terautentikasi. Endpoint ini tidak mengirim faks atau mengunduh dokumennya.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox
Parameter kueri kotak masuk
ParameterWajib diisiArti
pageTidakNomor halaman, dimulai dari 1. Nilai bawaan: 1.
limitTidakJumlah rekaman per halaman. Nilai bawaan: 25; maksimum: 100. Gunakan bilangan bulat positif.
searchTidakMencari nomor pengirim, nomor faks penerima, dan pengenal stasiun jarak jauh. Spasi di awal dan akhir dihapus. Pembedaan huruf besar dan kecil bergantung pada aturan kolasi basis data.
date_fromTidakSertakan faks mulai dari awal hari ini menurut waktu lokal server. Gunakan YYYY-MM-DD.
date_toTidakSertakan faks hingga akhir hari ini menurut waktu lokal server. Gunakan YYYY-MM-DD.

Kedua batas tanggal ikut disertakan dan menggunakan penafsiran tanggal oleh server API, bukan zona waktu pengguna yang diminta. String tanggal yang tidak valid mungkin diabaikan alih-alih ditolak; validasi sebelum mengirimnya. Tanpa filter tanggal, penangan permintaan tidak menetapkan rentang tanggal bawaan. Hasil diurutkan berdasarkan waktu penerimaan, dengan yang terbaru terlebih dahulu. Endpoint ini tidak menyediakan cuplikan keadaan yang tetap di seluruh halaman: faks yang baru masuk dapat menggeser rekaman antarhalaman.

Baca halaman kotak masuk

Baca hasil HTTP dan status.code dalam JSON. Kegagalan di bagian lain API dapat menggunakan pembungkus galat JSON meskipun status HTTP adalah 200. Respons yang berhasil berisi response.faxes dan response.pagination. Contoh ini menggunakan nilai fiktif.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id adalah pengenal numerik rekaman kotak masuk. hash adalah representasi MD5 dari pengenal tersebut untuk alur kerja dokumen masuk versi lama; nilai ini bukan pengenal pekerjaan send_fax atau kredensial otorisasi. Jangan gunakan nilai ini dengan endpoint faks keluar fax_status.

received_timestamp adalah stempel waktu Unix yang tersimpan. received_at adalah stempel waktu yang diformat oleh server tanpa offset zona waktu, atau null jika waktu penerimaan tidak tercatat; gunakan nilai Unix saat menampilkan waktu dalam zona waktu Anda sendiri. cost adalah angka JSON, bukan penawaran harga atau bukti bahwa biaya terpisah telah selesai ditagihkan.

status bernilai success hanya jika kode status yang tersimpan adalah nol; nilai lainnya menjadi failed. status_text memuat pesan pemrosesan yang tersimpan, dengan OK atau Failed sebagai nilai pengganti jika pesan tidak tersedia. emailed mempertahankan nilai yang tersimpan, bukan mengubahnya menjadi nilai boolean. viewed adalah nilai boolean. Jangan menyimpulkan bahwa email berhasil terkirim hanya berdasarkan status faks.

Tangani daftar kosong dan daftar yang berubah

Kotak masuk yang kosong mengembalikan larik faxes kosong, total 0, dan total_pages 0. Halaman setelah halaman terakhir juga dapat mengembalikan larik kosong. Hentikan pengambilan berdasarkan kolom pembagian halaman, alih-alih menganggap selalu ada setidaknya satu halaman. Tidak tersedia kursor atau pengurutan sekunder berdasarkan pengenal rekaman. Simpan pengenal rekaman saat mencocokkan halaman yang memuat rekaman yang sama.

Akses dokumen dan privasi

Entri kotak masuk memuat metadata telepon dan dokumen yang bersifat pribadi. Batasi akses dalam aplikasi Anda dan hindari mencatat respons lengkap ke log. Menampilkan daftar tidak menandai dokumen sebagai sudah dilihat. Gunakan fax_file untuk mengunduh dokumen masuk melalui mekanisme kompatibilitas; perhatikan bahwa mekanisme ini menandai rekaman masuk yang sudah ada sebagai sudah dilihat meskipun berkasnya tidak tersedia. Kotak masuk portal juga dapat digunakan untuk mengakses dokumen. Belum ada jaminan mengenai retensi berkas.