Cara menyiapkan Dropbox Fax API

Diperbarui Sep 22, 2025

Cara menyiapkan Dropbox Fax API menggunakan endpoint v1

Untuk mulai menggunakan endpoint v1:

Kirim email ke support@hellosign.com yang berisi alamat email yang ingin Anda gunakan untuk akun Dropbox Fax Anda. Anda akan mendapatkan tanggapan setelah Akses Dropbox Fax API Anda diaktifkan. Ketahui selanjutnya tentang harga Dropbox Fax API
Masuk ke akun Dropbox Sign Anda.Catat GUID Akun Anda karena Anda akan membutuhkannya untuk sebagian besar permintaan API (atau endpoint).
Buat permintaan API pertama Anda dan dapatkan info konfigurasi akun Anda:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"

Contohnya:

curl -u "myemail@hellofax.com:fakepassword" 
        "https://api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"

Contoh lain (ingatlah untuk melakukan URL encode):

curl "https://myemail%40hellofax.com:fakepassword%40api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"

Respons akan menjadi representasi JSON dari pengaturan akun Anda.

Untuk menambahkan kembali URL panggilan balik untuk faks masuk dan keluar Anda dengan POST:

curl -u"[your username]:[your password]" \
     -d "DefaultInboundFaxCallbackUrl=https://www.example.com/inboundFax" \
     -d "DefaultOutboundFaxCallbackUrl=https://www.example.com/outboundFax" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"

Catatan: Faks yang masuk akan DI-POST ke URL panggilan balik Anda, jadi Anda tidak perlu mengambilnya secara terpisah.

Untuk meninjau saluran faks yang tersedia:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"

Respons akan mencakup FaxLine yang Anda pilih ketika mendaftar langganan premium.

Untuk membeli nomor faks, kami perlu memeriksa kode area negara bagian yang tersedia (tidak semua kode area tersedia) dengan GET:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/AreaCodes?StateCode=CA"

Beli nomor faks dari salah satu kode area yang tersedia di langkah 6:

curl -u "[your username]:[your password]" \
     -d "AreaCode=[area code from step 7]" \ 
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"

Untuk mengirim faks:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]" \ 
     -F "file=@myfile.pdf"

Ini memulai proses pengiriman faks. Menerima respons HTTP 200 tidak menjamin faks akan terkirim, kesalahan konversi file dapat terjadi. Namun, setelah StatusCode faks menjadi E (berarti Error/Kesalahan) atau S(berarti Success/Berhasil), Anda akan menerima POST ke URL panggilan balik yang Anda berikan pada langkah 4. Ketahui selanjutnya tentang event panggilan balik.

Kemungkinan nilai StatusCode:

T = Mentransmisikan (Transmitting)/mengirim.
P = Tertunda (Pending)/mengonversi.
S = Berhasil dikirim (Successfully sent).
E = Kesalahan (Error). Gagal mengonversi atau mengirim lengkap.
H = Tertahan (On hold). Kesalahan ini terjadi jika Anda memiliki akun yang belum dikonfirmasi atau jika Anda keluar dari halaman faks tanpa langganan bulanan.

Kemungkinan nilai ErrorCode (hanya referensi ketika StatusCode diatur ke E):

B = Menerima sinyal sibuk (busy signal).
N = Tidak ada jawaban (No answer).
A = Nomor yang tidak dialokasikan (Unallocated number, biasanya berarti telah terputus).
D = Saluran terputus atau tidak dapat dijangkau (disconnected or unreachable).
L = Nomor ini ada di daftar yang ditolak (seharusnya tidak terjadi untuk nomor AS mana pun).
U = Kesalahan tidak diketahui (Unknown error). Ini biasanya terjadi ketika seseorang menjawab saluran atau kesalahan terjadi selama transmisi faks.

Catatan:

Jika Anda mengirim faks dan mesin faks penerima mendukung identifikasi pelanggan (CSID), ID pemanggil akan menampilkan nomor faks utama Anda, atau nomor faks yang Anda tentukan dalam parameter "From". Nomor faks utama Anda akan muncul di faks itu sendiri. Jika Anda memiliki beberapa saluran Dropbox Fax , Anda bisa memilih saluran yang akan digunakan sebagai mesin faks pengirim dengan menyertakan parameter "From" dalam URL:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]&From=[your fax line phone number]" \
     -F file=@myfile.pdf`

Untuk format nilai "From", lihat bidang "Number" yang dikembalikan dengan memanggil /FaxLines (lihat langkah 5 di atas).

Anda bisa mengunggah beberapa file dan mengirim beberapa faks dalam satu panggilan—cukup buat array parameter "file" dan/atau "To":

curl -u "[your username]:[your password]" \
     -F file[]="@1.pdf" -F file[]="@2.txt" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[phone number in all digits]"

atau

curl -X POST https://[your username]:[your password]@api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions -F 'file[0]=@file1.pdf' \
     -F 'file[1]=@file2.pdf' \
     -F 'To[0]=[destination fax number 0]' \
     -F 'To[1]=[destination fax number 1]'

Anda bisa menambahkan halaman sampul buatan Dropbox Fax dengan menentukan satu atau beberapa parameter berikut: CoverPageTo, CoverPageFrom, dan CoverPageMessage.
Faks yang dikirim oleh API tidak disimpan di server kami setelah faks berhasil dikirim—faks akan dihapus. Oleh karena itu, Anda tidak dapat melihatnya di UI. Namun, faks masuk yang berhasil di-POST ke panggilan balik Anda akan disimpan di server kami dan tersedia untuk dilihat di layar "dokumen" Anda.
Ada batas 200 faksimile yang tertunda per hari. Jika mencapai batas ini, Anda akan mendapati kesalahan 429:

Error sending fax. Status: 429; Message: Please wait. You already have at least 200 transmissions that are currently pending or transmitting.

Bagaimana cara memeriksa status faks?

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions/[Transmission GUID]"

Anda bisa menemukan GUID Transmisi dalam respons JSON yang dikembalikan dari panggilan API di langkah 8. Selain itu, Anda bisa memeriksa status semua Transmisi Anda dengan menghilangkan GUID Transmisi:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions"

Hasil akan terbagi dalam halaman. Anda bisa mendapatkan halaman yang berbeda dengan menentukan parameter URL Page dan PageSize. Lihat elemen respons FirstPageUri, NextPageUri, PreviousPageUri, dan LastPageUri tentang cara kerja pembagian halaman.

Catatan:

Untuk faks yang dikirim melalui API, Anda tidak akan menerima konfirmasi email.
Untuk faks yang diterima, Anda mungkin menerima email notifikasi berdasarkan pengaturan notifikasi Anda.

Setelah kode status faks diatur ke S atau E, verifikasikan bahwa URL panggilan balik faks keluar Anda sudah dipicu. Ini akan menghasilkan POST dengan parameter yang disebut "json", yang berisi semua yang akan Anda dapatkan sebagai respons atas panggilan (lihat langkah 1).

Jika panggilan kembali POST yang berhasil dicegah oleh masalah server atau jaringan, Dropbox akan mencoba lagi pada interval berikut:

15 menit
45 menit
1 jam 30 menit
2 jam 45 menit
4 jam
8 jam 15 menit
16 jam 30 menit

Pada setiap interval, Dropbox dapat mencoba POST beberapa kali jika kode respons 200 tidak diterima.

Jika Anda mengirim faks ke nomor Dropbox Fax milik Anda (berguna untuk pengujian), verifikasi bahwa URL panggilan balik faks masuk Anda juga sudah dipicu.
Cantumkan FaxLines yang telah Anda beli:

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines"

Untuk menghapus FaxLine, buat panggilan DELETE ke Uri FaxLine tersebut (ditentukan dalam respons untuk langkah sebelumnya):

curl -u "[your username]:[your password]" 
     -X DELETE "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines/2132935579"

Jika operasi berhasil, Anda akan menerima kode respons 200.

Catatan: Ada masalah umum yang menunjukkan bahwa JSON dalam panggilan balik berisi "Transaction" alih-alih "Transmission". Ini adalah kesalahan ketik yang akan diperbaiki di versi API berikutnya.

Apakah artikel ini membantu?

Ya, terima kasih!

Tidak terlalu