MultiTEL
Разработчикам

GET/v3/fax_download?job_id={job_id}

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

Получите доступный документ для одного из ваших заданий на отправку факса.

На этой странице
  1. Запрос документа
  2. Обработка файла или ошибки в формате JSON
  3. Доступность и конфиденциальность

Запрос документа

Используйте активированную учётную запись MultiTEL API. Для учётной записи с паролем передайте учётные данные HTTP Basic, а для учётной записи с токеном — токен Bearer. Права доступа учётной записи и ограничения по IP-адресам по-прежнему действуют. Не используйте внутренние учётные данные фонового обработчика.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

Используйте тот же обязательный шестнадцатеричный job_id длиной 32 символа, что и для fax_status. Клиентский запрос доступен только владельцу, прошедшему аутентификацию. В этом примере заголовки и байты ответа сохраняются отдельно, чтобы ошибку API не принять за файл PDF.

Обработка файла или ошибки в формате JSON

При успехе возвращаются необработанные байты документа с заголовками Content-Type и Content-Disposition, обозначающими вложение, а не оболочка JSON. Проверьте эти заголовки, прежде чем присваивать сохранённому файлу имя, открывать или обрабатывать его. В зависимости от доступного документа ответ может содержать файл в формате PDF, TIFF или в исходном формате загруженного файла. Для задания в очереди до преобразования может возвращаться исходный файл.

При ошибке возвращается обычная оболочка JSON со структурой status/response. Код API 400 означает, что job_id отсутствует или имеет неверный формат; 401 означает отсутствие аутентификации; 404 означает, что задание или его файл недоступны для этой учётной записи. Проверяйте Content-Type и status.code, даже если статус HTTP равен 200.

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

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