Списък на получените факсове

Списък на получените факсове

Използвайте активиран акаунт за 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

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

Прочетете страницата на входящата поща

Прочетете резултата от HTTP и, в отговора във формат JSON, полето status.code. Грешките в други части на 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 за изтегляне на входящи документи с цел съвместимост, като имате предвид, че това отбелязва съществуващия входящ запис като прегледан дори ако файлът му е недостъпен. Достъп до документите е възможен и чрез входящата поща в портала. Не е установена гаранция за съхранение на файловете.