Завантаження вхідного або вихідного факсу

Виберіть вхідний або вихідний документ

Ця кінцева точка для сумісності отримує факсовий документ, що належить вашому обліковому запису. Використовуйте активований обліковий запис MultiTEL API через HTTPS із налаштованими для нього обліковими даними та обмеженнями за IP. Вона не надсилає факс і не надсилає його повторно.

Параметри шляху завантаження
Параметр	Обов’язковий	Значення
`type`	Так	Використовуйте inbound або outbound саме в наведеному вигляді.
`id`	Так	Для inbound використовуйте hash, який повертає fax_inbox. Для outbound використовуйте uuid, який повертає fax_outbox.

Ці значення потрібно вказувати в шляху. Маршрут — /v3/fax_file/{type}/{id}, а не fax_download з додатковими сегментами шляху. Хеш вхідного факсу не є числовим ідентифікатором запису й не є ідентифікатором вихідного завдання. Скопіюйте ідентифікатор із відповідного списку вхідних або вихідних факсів; він не замінює автентифікацію.

Завантаження прийнятого факсу

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

Хеш у прикладі відповідає вигаданому вхідному запису 12. Отримайте власне значення з fax_inbox. Завантаження наявного вхідного запису позначає його як переглянутий. Це відбувається до перевірки доступності файлу, тому навіть після помилки недоступності файлу поле viewed може залишитися зі значенням true. Не використовуйте цю кінцеву точку лише для перевірки існування прийнятого факсу, якщо хочете залишити стан його перегляду незмінним.

Обробник віддає перевагу збереженому PDF. Інакше він використовує збережений TIFF і намагається перетворити його на PDF, якщо засіб перетворення доступний. Якщо перетворення недоступне або спричиняє виняток, який обробляється, натомість повертається TIFF. Завжди перевіряйте повернутий Content-Type, а не припускайте, що це PDF.

Завантаження вихідного факсу

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 із fax_outbox. Цей механізм завантаження для сумісності спочатку вибирає збережений двійковий об’єкт PDF, потім двійковий об’єкт TIFF, а далі доступний файл PDF, файл TIFF або початковий вихідний файл. Його порядок вибору відрізняється від порядку, який використовує поточний обробник вихідних факсів fax_download. Для нових інтеграцій, що використовують send_fax, використовуйте цей поточний процес завантаження з його параметром job_id.

Початковий вихідний файл може повертатися як application/octet-stream, а не PDF чи TIFF. Назва файлу вкладення може зберігати початкове розширення. Завантаження вихідного факсу через механізм сумісності не позначає вхідний запис як переглянутий, не змінює стан завдання й не створює передавання.

Обробляйте байти та помилки окремо

У разі успіху повертаються необроблені байти документа із заголовками Content-Type, Content-Disposition із зазначенням вкладення та Content-Length. Це не оболонка JSON із даними в кодуванні Base64. Зберігайте заголовки й байти окремо, як показано, перевіряйте тип відповіді й лише після цього надавайте файлу відповідну назву або обробляйте його. Дозволене розширення вихідного файлу не гарантує, що документ коректний або перетворений.

Код API 400 означає, що відсутнє обов’язкове значення в шляху або значення type некоректне. Код API 404 означає, що запис у межах облікового запису або його файл недоступний. Помилки використовують звичайну оболонку JSON status/response і можуть повертатися з HTTP 200. Перевіряйте Content-Type відповіді та поле status.code у JSON, щоб тіло повідомлення про помилку не відкривалося як документ.

Конфіденційність і доступність

Вміст факсу може містити конфіденційну інформацію. Зберігайте завантажені файли лише там, де до них можуть отримати доступ призначені одержувачі, та уникайте записування всіх байтів документа в журнали. Запис у списку вхідних або вихідних факсів не гарантує, що його файл залишатиметься доступним. Строк зберігання файлів не встановлено, а сумісність із кожним раніше збереженим документом не гарантовано.