Faks gönderme | MultiTEL

Göndermeden önce

Gönderen numarası olarak göstermeye yetkili olduğunuz bir numara kullanın ve faksınızı bekleyen bir alıcıya gönderin. Bu istek, ücretlendirilebilecek gerçek bir iletim oluşturur. Sayfa algılamanın mümkün olduğunca öngörülebilir olması için hazırlanmış bir PDF veya TIFF belgesi kullanın. Kuyruğa alındığını belirten yanıt, isteğin kabul edildiğini doğrular; teslim edildiğini doğrulamaz.

Etkinleştirilmiş bir MultiTEL API hesabı kullanın. Parolalı bir hesap için HTTP Basic kimlik bilgilerini, belirteç kullanan bir hesap için ise Bearer belirtecini gönderin. Hesap izinleri ve IP kısıtlamaları geçerliliğini korur. Dahili arka plan işleyicisinin kimlik bilgilerini kullanmayın.

Belgeyi yükleme

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

İstek alanları
Alan	Zorunlu	Anlamı
`from_number`	Evet	Kullanmaya yetkili olduğunuz gönderen numarası. + işareti ve ülke koduyla başlayan uluslararası biçimi kullanın.
`to_number`	Evet	Uluslararası biçimde alıcının faks numarası.
`fax_file`	Çok parçalı isteklerde evet	Yüklenen belge. Çok parçalı isteğin Content-Type başlığını ve parça sınırını curl aracının ayarlamasına izin verin.
`webhook_url`	Hayır	İsteğe bağlı HTTP veya HTTPS geri çağrı URL adresi; HTTPS tercih edilir. Geri çağrının veri içeriği ve teslim garantileri hâlâ incelenmektedir: belgelenen durum takibi iş akışı için fax_status uç noktasını düzenli aralıklarla sorgulayın.

JSON biçimindeki istekler de şu başlıkla kabul edilir: Content-Type: application/json, aynı numara alanları ve isteğe bağlı webhook_url alanının yanı sıra şu alanlar kullanılır: file_name ve file_b64. file_b64, belgenin baytlarını Base64 kurallarına tam uygun biçimde kodlanmış olarak, data: öneki olmadan içerir. Geçerli bir çok parçalı fax_file alanı önceliklidir. Bu, URL üzerinden dosya getiren bir API değildir.

Belge ve gönderim sınırları

Uygulama, pdf, tif, tiff, jpg, jpeg, png, doc, docx veya txt uzantılı belgelerde, kodu çözüldükten sonra en fazla 15,728,640 bayt (15 MiB) belge verisi kabul eder. Bir uzantıya izin verilmesi, hizmetin sayfaları sayabileceğini veya dönüştürebileceğini garanti etmez. Altyapının istek sınırları daha düşük olabilir ve Base64 istek boyutunu artırır.

Mevcut uygulama, hesap başına aynı alıcıya yönelik kuyrukta bekleyen veya gönderilmekte olan bir işe, önceki bir saat içinde bu alıcıya en fazla beş gönderime ve önceki bir saat içinde toplam en fazla 50 gönderime izin verir. İstek sıklığı sınırına ilişkin yanıtta API kodu 429 kullanılır. Yeniden denemeden önce bekleyin; sınırları aşmaya çalışmayın.

İş kimliğini saklayın

Hem HTTP sonucunu hem de JSON yanıtındaki status.code alanını okuyun. JSON hata yanıtları HTTP 200 ile gelebilir. Başarılı bir JSON yanıtında status ve response alanları bulunur; örneklerde hayalî veriler kullanılmıştır.

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

Şu uç noktayı düzenli aralıklarla sorgulayın: fax_status (response.job_id değerini kullanarak). Gönderim yanıtı kaybolursa yeniden göndermeden önce portalın giden kutusunu kontrol edin: tekrarlanan istekler ayrı iletimler oluşturabilir. Bu istek işleyicisi, istemciye yönelik bir idempotans parametresi sunmaz.

Hatalar ve bakiye kontrolleri

API kodları arasında eksik alanlar, geçersiz geri çağrı URL adresi, reddedilen belge veya sayfa algılama hatası için 400; eksik kimlik doğrulaması için 401; tahmini faks maliyeti ile kuyrukta bekleyen veya gönderilmekte olan işlerin tahmini maliyetleri toplamı kullanılabilir hesap bakiyesini aştığında 402; istek sıklığı sınırları için 429; iletime hazırlama hatası için ise 500 bulunur. Kesin nedeni öğrenmek için status.msg alanını okuyun.

Kuyruk, iletimden önce tahmini bir maliyet kaydeder. İsteğin kabul edilmesini, bakiye kontrolünü veya bu tahmini, ücretin tahsil edildiğinin onayı olarak yorumlamayın. Nihai faturalandırma ve geri çağrı ayrıntılarının hâlâ doğrulanması gerekmektedir.