Gelen veya giden kutusundaki bir faksı indirme

Gelen veya giden bir belge seçin

Bu uyumluluk uç noktası, hesabınıza ait bir faks belgesini alır. Etkinleştirilmiş bir MultiTEL API hesabını, yapılandırılmış kimlik bilgileri ve IP kısıtlamalarıyla HTTPS üzerinden kullanın. Bu uç nokta faks göndermez veya yeniden göndermez.

Bu değerler yolda yer almalıdır. Kullanılacak yol şudur: /v3/fax_file/{type}/{id}; ek yol parçaları eklenmiş fax_download kullanılmaz. Gelen faksın özet değeri, sayısal kayıt kimliği değildir ve bir giden faks işinin kimliği de değildir. Tanımlayıcıyı ilgili posta kutusu listesinden kopyalayın; bu değer kimlik doğrulamanın yerini almaz.

Alınan bir faksı indirme

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

Örnekteki özet değeri, gelen kutusundaki kurgusal 12 numaralı kaydı temsil eder. Kendi değerinizi şu kaynaktan alın: fax_inbox. Mevcut bir gelen kaydını indirmek, kaydı görüntülenmiş olarak işaretler. Bu işlem dosyanın kullanılabilirliği kontrol edilmeden önce gerçekleşir; bu nedenle dosyanın kullanılamadığını bildiren bir hata oluşsa bile viewed değeri true olarak kalabilir. Alınan bir faksın görüntülenme durumunun değişmeden kalmasını istiyorsanız bu uç noktayı yalnızca faksın var olup olmadığını kontrol etmek için kullanmayın.

İşleyici, depolanmış bir PDF dosyasını tercih eder. Aksi durumda depolanmış TIFF dosyasını kullanır ve dönüştürücü kullanılabiliyorsa PDF biçimine dönüştürmeyi dener. Dönüştürme kullanılamıyorsa veya yakalanıp işlenen bir istisnaya yol açarsa bunun yerine TIFF dosyasını döndürür. Biçimin PDF olduğunu varsaymak yerine her zaman döndürülen Content-Type başlığını inceleyin.

Giden bir faksı indirme

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

uuid değerini şu kaynaktan alarak kullanın: fax_outbox. Bu uyumluluk indirmesi, önce depolanmış bir PDF ikili veri nesnesini, ardından bir TIFF ikili veri nesnesini, daha sonra kullanılabilir bir PDF dosyasını, TIFF dosyasını veya özgün kaynak dosyayı tercih eder. Bu tercih sırası, giden fakslar için kullanılan mevcut fax_download işleyicisinin tercih sırasından farklıdır. Şunu kullanan yeni entegrasyonlar için: send_fax, söz konusu mevcut indirme iş akışını job_id parametresiyle kullanın.

Özgün kaynak dosya, PDF veya TIFF yerine application/octet-stream olarak döndürülebilir. Ek dosyasının adı, kaynak dosyanın uzantısını koruyabilir. Giden fakslar için uyumluluk indirmesi, gelen kutusundaki bir kaydı görüntülenmiş olarak işaretlemez, iş durumunu değiştirmez veya bir iletim oluşturmaz.

Baytları ve hataları ayrı ayrı işleyin

Başarılı yanıt, Content-Type, eki belirten Content-Disposition ve Content-Length başlıklarıyla birlikte belgenin ham baytlarını döndürür. Bu, Base64 kodlamalı bir JSON zarfı değildir. Başlıkları ve baytları gösterildiği gibi ayrı ayrı kaydedin, yanıt türünü inceleyin ve ancak bundan sonra dosyaya uygun bir ad verin veya dosyayı işleyin. Kaynak dosya uzantısına izin verilmesi, belgenin geçerli ya da dönüştürülmüş olduğunu garanti etmez.

API kodu 400, zorunlu bir yol değerinin eksik olduğu veya type değerinin geçersiz olduğu anlamına gelir. API kodu 404, hesap kapsamındaki kaydın veya bu kaydın dosyasının kullanılamadığı anlamına gelir. Hatalar normal JSON status/response zarfını kullanır ve HTTP 200 durum koduyla döndürülebilir. Hata gövdesinin belge olarak açılmasını önlemek için yanıtın Content-Type başlığını ve JSON içindeki status.code değerini kontrol edin.

Gizlilik ve kullanılabilirlik

Faks içeriği hassas bilgiler içerebilir. İndirilen dosyaları yalnızca hedeflediğiniz alıcıların erişebileceği yerlerde saklayın ve belgenin tüm baytlarını günlüklere eklemekten kaçının. Bir posta kutusu kaydının bulunması, dosyasının kullanılabilir kalacağını garanti etmez. Dosyalar için bir saklama süresi belirlenmemiştir ve geçmişte depolanmış tüm belgeleri kapsayan bir uyumluluk garantisi verilmemiştir.