Скачивание входящего или исходящего факса

Выберите входящий или исходящий документ

Эта конечная точка совместимости получает факсимильный документ, принадлежащий вашей учётной записи. Используйте активированную учётную запись 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. Это не оболочка с данными в кодировке Base64 в формате JSON. Сохраните заголовки и байты отдельно, как показано в примере, проверьте тип ответа и только затем присвойте файлу подходящее имя или обработайте его. Допустимое расширение исходного файла не гарантирует, что документ корректен или был преобразован.

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

Конфиденциальность и доступность

Содержимое факса может включать конфиденциальную информацию. Храните скачанные файлы только там, где к ним имеют доступ лишь предполагаемые получатели, и не записывайте полное байтовое содержимое документов в журналы. Наличие записи в списке факсов не гарантирует, что её файл останется доступным. Срок хранения файлов и гарантия совместимости для каждого ранее сохранённого документа не установлены.