Розробникам

GET/v3/fax_outbox

Список завдань надсилання факсів

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

На цій сторінці
  1. Список завдань надсилання факсів
  2. Перегляд записів завдань
  3. Безпечне узгодження сторінок списку
  4. Конфіденційність і повторні спроби

Список завдань надсилання факсів

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

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode search=0123456789abcdef0123456789abcdef \
  https://api.multitel.net/v3/fax_outbox
Параметри запиту списку вихідних факсів
ПараметрОбов’язковийЗначення
pageНіНомер сторінки, починаючи з 1. Типове значення: 1.
limitНіКількість записів на сторінці. Типове значення: 25; максимальне: 100. Використовуйте додатне ціле число.
searchНіПошук виконується за номером відправника, номером одержувача та UUID завдання. Пробіли на початку та в кінці видаляються. Пошук у тексті стану або результату не виконується.

Цей обробник не підтримує фільтри date_from та date_to. У папці вихідних факсів порталу є додаткові фільтри, які не слід переносити до цього запиту API. Результати впорядковано за часом створення, від найновіших, без додаткового сортування за ідентифікатором і без курсора знімка даних.

Перегляд записів завдань

Перевіряйте як результат HTTP, так і поле status.code у JSON. Успішна відповідь містить response.faxes та response.pagination; у прикладі використано вигадані дані. Для порожньої папки факсів повертається порожній масив faxes зі значеннями total 0 та total_pages 0.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 13,
      "uuid": "0123456789abcdef0123456789abcdef",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "status": "queued",
      "pages_requested": 3,
      "pages_sent": 0,
      "cost": "0.07500",
      "result_text": "",
      "created_at": "2026-10-01 12:00:00",
      "sent_at": null,
      "updated_at": "2026-10-01 12:00:00"
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id — числовий ідентифікатор запису. uuid — видимий ідентифікатор завдання; для нових запитів на надсилання використовуйте ідентифікатор завдання, який повертає send_fax, і зберігайте його для періодичного опитування стану. Список може містити старіші записи, тому не вважайте, що кожен рядок створено через ту саму кінцеву точку подання запитів на надсилання.

status та result_text містять зафіксований стан обробки та повідомлення. У цьому списку вони не нормалізуються до повного переліку значень стану доставки. Стан «у черзі» означає перебування в черзі, а не доставку. Якщо документи критично важливі, підтвердьте отримання з одержувачем, перш ніж вважати факс доставленим або подавати його повторно.

pages_requested та pages_sent — числові лічильники. cost зберігає записане значення, а за його відсутності використовується рядок 0.00; не вважайте, що тип цього поля в JSON збігається з типом вартості вхідного факсу. Запис у черзі вже може містити попередню оцінку вартості. Ані це значення, ані наявність запису в списку не визначають остаточної суми до сплати.

created_at, sent_at та updated_at — збережені значення у форматі сервера без зміщення часового поясу; sent_at може мати значення null. Список не містить поля стану вебхука, яке повертає окрема кінцева точка перевірки стану.

Безпечне узгодження сторінок списку

Орієнтуйтеся на pagination.page, limit, total та total_pages. Сторінки з номерами, більшими за номер останньої сторінки, можуть бути порожніми. Під час перегляду нові завдання можуть спричиняти переміщення записів між сторінками. Зберігайте ідентифікатори завдань, коли об’єднуєте сторінки; ця кінцева точка не гарантує незмінного знімка даних.

Конфіденційність і повторні спроби

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