Получение списка принятых факсов

Получение списка принятых факсов

Используйте активированную учётную запись API MultiTEL через HTTPS с настроенными для неё учётными данными и ограничениями по IP-адресам. Эта конечная точка возвращает список принятых факсов, принадлежащих аутентифицированной учётной записи. Она не отправляет факс и не скачивает его документ.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Границы дат включаются в диапазон и определяются тем, как сервер API интерпретирует даты, а не запрошенным часовым поясом пользователя. Некорректные строки дат могут быть проигнорированы, а не отклонены; проверяйте их перед отправкой. Если фильтры по датам не заданы, обработчик не ограничивает период по умолчанию. Результаты упорядочены по времени получения, начиная с самых новых. Конечная точка не обеспечивает неизменный снимок данных при переходе между страницами: поступление новых факсов может смещать записи между страницами.

Чтение страницы входящих факсов

Проверяйте результат HTTP и поле status.code в JSON. В других частях API ошибки могут возвращаться в оболочке ошибки JSON, даже если статус HTTP равен 200. Успешный ответ содержит response.faxes и response.pagination. В этом примере используются вымышленные значения.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id — числовой идентификатор записи во входящих факсах. hash — его представление MD5 для устаревшего механизма работы с входящими документами; это не идентификатор задания send_fax и не данные для авторизации. Не используйте его с конечной точкой для исходящих факсов fax_status.

received_timestamp — сохранённая временная метка Unix. received_at — временная метка в формате сервера без смещения часового пояса либо null, если время получения не записано; для отображения времени в своём часовом поясе используйте значение Unix. cost — число в JSON, а не предложение цены или подтверждение отдельного выполненного списания.

status принимает значение success только при сохранённом коде статуса, равном нулю; остальные значения преобразуются в failed. status_text содержит сохранённое сообщение об обработке; если оно отсутствует, используется OK или Failed. emailed сохраняет исходное значение из хранилища, а не преобразует его в логическое. viewed — логическое значение. Не делайте вывод об успешной доставке электронной почты только на основании статуса факса.

Обработка пустых и изменяющихся списков

Для пустого ящика возвращаются пустой массив faxes, total со значением 0 и total_pages со значением 0. Запрос страницы после последней также может вернуть пустой массив. Завершайте перебор согласно полям пагинации, не предполагая, что существует хотя бы одна страница. Курсор и дополнительная сортировка по идентификатору записи не предоставляются. Сохраняйте идентификаторы записей при сверке страниц с пересекающимися записями.

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

Записи во входящих факсах содержат конфиденциальные метаданные телефонных соединений и документов. Ограничьте доступ в своём приложении и избегайте записи полных ответов в журналы. Получение списка не помечает документ как просмотренный. Используйте fax_file для скачивания входящего документа через механизм совместимости; учтите, что при этом существующая запись входящего факса помечается как просмотренная, даже если её файл недоступен. Документы также доступны через раздел входящих факсов в портале. Гарантия хранения файлов не установлена.