Cara menyediakan API Dropbox Fax

Dikemas kini Oct 17, 2025

Cara menyediakan Dropbox Fax API menggunakan titik akhir v1

Untuk bermula menggunakan titik akhir v1:

Hantar e-mel ke support@hellosign.com yang mengandungi alamat e-mel yang anda ingin gunakan untuk akaun Dropbox Fax anda. Anda akan mendapat jawapan setelah Akses Dropbox Fax API anda dibolehkan. Ketahui lagi tentang harga Dropbox Fax API.
Log masuk ke akaun Dropbox Fax anda. Perhatikan GUID Akaun anda kerana anda memerlukan ini untuk kebanyakan permintaan API (atau titik akhir).
Buat permintaan API pertama anda dan dapatkan maklumat konfigurasi akaun anda:

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

Contohnya ialah:

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

Satu lagi contoh (ingat untuk mengekod URL):

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

Jawapannya akan menjadi perwakilan JSON bagi tetapan akaun anda.

Untuk menambah URL panggil balik untuk faks masuk dan keluar anda sekali lagi 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]"

Nota: Faks masuk akan POST ke URL panggil balik anda supaya anda tidak perlu mengambilnya secara berasingan.

Untuk menyemak talian faks yang tersedia:

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

Jawapannya akan merangkumi FaxLine yang anda pilih apabila anda mendaftar untuk langganan premium.

Untuk membeli nombor faks, kami perlu menyemak kod kawasan negeri yang tersedia (bukan semua kod kawasan tersedia) dengan GET:

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

Beli nombor faks daripada salah satu kod kawasan yang tersedia dalam 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 menghantar 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 memulakan proses penghantaran faks. Menerima respons HTTP 200 tidak menjamin faks akan diteruskan, ralat penukaran fail mungkin berlaku. Walau bagaimanapun, setelah Kod Status faks menjadi E (untuk Ralat) atau S (untuk Kejayaan), anda akan menerima POST ke URL panggil balik yang anda berikan dalam langkah 4. Ketahui lebih lanjut tentang acara panggil balik.

Nilai Kod Status yang mungkin:

T = Memindah/menghantar.
P = Belum selesai/menukar.
S = Berjaya dihantar.
E = Ralat. Gagal menukar atau menghantar sepenuhnya.
H = Ditangguhkan. Ralat ini berlaku jika anda mempunyai akaun yang belum disahkan atau jika anda kehabisan halaman faks tanpa langganan bulanan.

Nilai ErrorCode yang mungkin (rujukan hanya apabila StatusCode ditetapkan kepada E):

B = Menerima isyarat sibuk.
N = Tiada jawapan.
A = Nombor yang tidak diperuntukkan (biasanya bermaksud ia telah diputuskan sambungannya).
D = Talian terputus atau tidak boleh dicapai.
L = Nombor ini berada dalam senarai dinafikan (tidak sepatutnya berlaku untuk mana-mana nombor AS).
U = Ralat tidak diketahui. Ini biasanya berlaku apabila seseorang mengambil talian atau ralat berlaku semasa penghantaran faks.

Perhatian:

Jika anda menghantar faks dan mesin faks penerima menyokong pengenalan pelanggan (CSID), ID pemanggil akan memaparkan nombor faks utama anda, atau nombor faks yang anda nyatakan dalam parameter "Daripada". Nombor faks utama anda akan muncul pada faks itu sendiri. Jika anda mempunyai berbilang talian Dropbox Fax, anda boleh memilih yang mana satu untuk digunakan sebagai mesin faks penghantaran dengan memasukkan parameter "Daripada" 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 "Daripada", lihat medan "Nombor" yang dikembalikan dengan memanggil /FaxLines (lihat langkah 5 di atas).

Anda boleh memuat naik berbilang fail dan menghantar berbilang faks dalam satu panggilan - hanya buat tatasusunan parameter "fail" dan/atau "Kepada":

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 boleh menambah halaman muka depan yang dijana oleh Dropbox Fax dengan menentukan satu atau beberapa parameter berikut: CoverPageTo, CoverPageFrom, dan CoverPageMessage.
Faks yang dihantar oleh API tidak disimpan di pelayan kami setelah faks berjaya dihantar - faks tersebut dibuang. Oleh itu, anda tidak boleh melihatnya dalam UI. Walau bagaimanapun, faks masuk yang berjaya DIHANTAR ke panggilan balik anda disimpan di pelayan kami dan tersedia untuk dilihat dalam skrin "dokumen" anda.
Terdapat had 200 faks yang belum selesai setiap hari. Jika anda mencapai had ini, anda akan menghadapi ralat 429:

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

Bagaimana untuk menyemak status faks?

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

Anda boleh mencari GUID Penghantaran dalam respons JSON yang dikembalikan daripada panggilan API dalam langkah 8. Selain itu, anda boleh menyemak status semua Penghantaran anda dengan mengabaikan GUID Penghantaran:

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

Hasil carian ini dipaparkan dalam bentuk halaman. Anda boleh mendapatkan halaman yang berbeza dengan menentukan parameter URL Page dan PageSize. Rujuk elemen respons FirstPageUri, NextPageUri, PreviousPageUri, dan LastPageUri mengenai cara penghalaman berfungsi.

Perhatian:

Untuk faks yang dihantar melalui API, anda tidak akan menerima e-mel pengesahan.
Untuk faks yang diterima, anda mungkin menerima e-mel pemberitahuan berdasarkan tetapan pemberitahuan anda.

Setelah kod status faks ditetapkan kepada S atau E, sahkan bahawa URL panggil balik faks keluar anda telah dicetuskan. Ia sepatutnya menerima POST dengan parameter yang dipanggil "json" yang mengandungi semua yang anda akan dapat dalam respons kepada panggilan (lihat langkah 1).

Jika panggilan balik POST yang berjaya dihalang oleh isu pelayan atau rangkaian, Dropbox akan mencuba sekali lagi pada selang masa ini:

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

Pada setiap selang, Dropbox boleh mencuba POST beberapa kali jika 200 kod respons tidak diterima.

Jika anda menghantar faks ke nombor Dropbox Fax anda sendiri (berguna untuk percubaan), sila sahkan bahawa URL panggil balik faks masuk anda juga dicetuskan.
Senaraikan FaxLines yang telah anda beli:

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

Untuk menghapuskan FaxLine, buat panggilan HAPUS ke Uri FaxLine tersebut (dinyatakan dalam jawapan kepada langkah sebelumnya):

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

Jika operasi berjaya, anda akan menerima 200 jawapan.

Nota: Terdapat isu yang diketahui di mana JSON dalam panggil balik mengandungi "Transaksi" dan bukannya "Penghantaran". Ini adalah kesilapan ejaan yang akan diperbetulkan dalam versi API seterusnya.

Adakah artikel ini berguna?

Ya, terima kasih!

Tidak juga