Розробникам

GET/v3/fax_inbox

Список отриманих факсів

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

На цій сторінці
  1. Список отриманих факсів
  2. Прочитайте сторінку скриньки вхідних факсів
  3. Обробляйте порожні списки та списки, що змінюються
  4. Доступ до документів і конфіденційність

Список отриманих факсів

Використовуйте активований обліковий запис MultiTEL API через 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
Параметри запиту до скриньки вхідних факсів
ПараметрОбов’язковийЗначення
pageНіНомер сторінки, починаючи з 1. Типове значення: 1.
limitНіКількість записів на сторінці. Типове значення: 25; максимальне: 100. Використовуйте додатне ціле число.
searchНіВиконує пошук за номером відправника, номером факсу одержувача та ідентифікатором віддаленої станції. Пробіли на початку та в кінці видаляються. Чутливість до регістру залежить від правил порівняння тексту в базі даних.
date_fromНіВключити факси від початку цього дня за місцевим часом сервера. Використовуйте формат YYYY-MM-DD.
date_toНіВключити факси до кінця цього дня включно за місцевим часом сервера. Використовуйте формат YYYY-MM-DD.

Межі дат включаються в діапазон та тлумачаться за правилами сервера 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 для завантаження вхідного документа в режимі сумісності; врахуйте, що ця функція позначає наявний запис вхідного факсу як переглянутий, навіть якщо його файл недоступний. Доступ до документів також можливий через скриньку вхідних факсів на порталі. Гарантії зберігання файлів не встановлено.