Programiści

GET/v3/fax_inbox

Wyświetlanie odebranych faksów

Odczytuj skrzynkę faksów przychodzących z podziałem na strony, wyszukiwaniem numerów i filtrami daty odbioru.

Na tej stronie
  1. Wyświetlanie odebranych faksów
  2. Odczytywanie strony skrzynki odbiorczej
  3. Obsługa pustych i zmieniających się list
  4. Dostęp do dokumentów i prywatność

Wyświetlanie odebranych faksów

Korzystaj z aktywnego konta API MultiTEL przez HTTPS, używając skonfigurowanych dla niego danych uwierzytelniających i ograniczeń adresów IP. Ten punkt końcowy wyświetla odebrane faksy należące do uwierzytelnionego konta. Nie wysyła faksu ani nie pobiera jego dokumentu.

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
Parametry zapytania o skrzynkę odbiorczą
ParametrWymaganyZnaczenie
pageNieNumer strony, począwszy od 1. Wartość domyślna: 1.
limitNieLiczba rekordów na stronie. Wartość domyślna: 25; maksymalna: 100. Użyj dodatniej liczby całkowitej.
searchNiePrzeszukuje numer nadawcy, numer faksu odbiorcy i identyfikator stacji zdalnej. Spacje na początku i końcu są usuwane. Rozróżnianie wielkości liter zależy od reguł porównywania tekstu w bazie danych.
date_fromNieUwzględnia faksy od początku tego dnia według czasu lokalnego serwera. Użyj formatu YYYY-MM-DD.
date_toNieUwzględnia faksy do końca tego dnia włącznie według czasu lokalnego serwera. Użyj formatu YYYY-MM-DD.

Daty graniczne są uwzględniane i interpretowane zgodnie z zasadami serwera API, a nie według żądanej strefy czasowej użytkownika. Nieprawidłowe ciągi dat mogą zostać zignorowane zamiast odrzucone; sprawdź ich poprawność przed wysłaniem. Bez filtrów dat procedura obsługi nie narzuca domyślnego zakresu dat. Wyniki są uporządkowane według czasu odbioru, od najnowszych. Punkt końcowy nie zapewnia niezmiennego obrazu danych na wszystkich stronach: nowe faksy mogą powodować przesuwanie rekordów między stronami.

Odczytywanie strony skrzynki odbiorczej

Sprawdź wynik HTTP oraz pole status.code w odpowiedzi JSON. Błędy w innych częściach API mogą być zwracane w strukturze błędu JSON, nawet gdy status HTTP wynosi 200. Pomyślna odpowiedź zawiera response.faxes i response.pagination. W tym przykładzie użyto fikcyjnych wartości.

{
  "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 to liczbowy identyfikator rekordu w skrzynce odbiorczej. hash to jego reprezentacja MD5 używana w starszym procesie obsługi dokumentów przychodzących; nie jest identyfikatorem zadania send_fax ani poświadczeniem uprawnień. Nie używaj tej wartości z punktem końcowym fax_status przeznaczonym do faksów wychodzących.

received_timestamp to zapisany znacznik czasu Unix. received_at to znacznik czasu sformatowany przez serwer, bez przesunięcia strefy czasowej, lub null, jeśli nie zapisano czasu odbioru; do wyświetlania czasu we własnej strefie czasowej używaj wartości Unix. cost to liczba w formacie JSON, a nie oferta cenowa ani dowód pobrania osobnej opłaty.

status ma wartość success tylko wtedy, gdy zapisany kod statusu wynosi zero; pozostałe wartości są zamieniane na failed. status_text zawiera zapisany komunikat przetwarzania, a w razie jego braku — OK lub Failed. emailed zachowuje zapisaną wartość zamiast zwracać wartość logiczną. viewed jest wartością logiczną. Nie wnioskuj o pomyślnym dostarczeniu wiadomości e-mail wyłącznie na podstawie statusu faksu.

Obsługa pustych i zmieniających się list

Pusta skrzynka zwraca pustą tablicę faxes, total o wartości 0 i total_pages o wartości 0. Żądanie strony za ostatnią stroną również może zwrócić pustą tablicę. Kończ pobieranie zgodnie z polami podziału na strony, zamiast zakładać istnienie co najmniej jednej strony. Nie jest udostępniany kursor ani dodatkowe sortowanie według identyfikatora rekordu. Zachowuj identyfikatory rekordów podczas uzgadniania danych z nakładających się stron.

Dostęp do dokumentów i prywatność

Wpisy w skrzynce zawierają prywatne metadane telefoniczne i dotyczące dokumentów. Ogranicz dostęp w swojej aplikacji i unikaj zapisywania pełnych odpowiedzi w dziennikach. Wyświetlenie listy nie oznacza dokumentu jako obejrzanego. Użyj fax_file do pobierania dokumentów przychodzących w trybie zgodności. Pamiętaj, że oznacza to istniejący rekord przychodzący jako obejrzany, nawet jeśli jego plik jest niedostępny. Dostęp do dokumentów jest również możliwy przez skrzynkę odbiorczą w portalu. Nie ustalono gwarancji przechowywania plików.