Lista mottagna fax
Använd ett aktiverat MultiTEL-konto för API via HTTPS med kontots konfigurerade autentiseringsuppgifter och IP-begränsningar. Den här slutpunkten listar mottagna fax som tillhör det autentiserade kontot. Den skickar inget fax och laddar inte ned dess dokument.
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| Parameter | Obligatorisk | Betydelse |
|---|---|---|
page | Nej | Sidnummer, med början på 1. Standardvärde: 1. |
limit | Nej | Poster per sida. Standardvärde: 25; högsta värde: 100. Använd ett positivt heltal. |
search | Nej | Söker i avsändarnumret, det mottagande faxnumret och fjärrstationens identifierare. Inledande och avslutande blanksteg tas bort. Om sökningen skiljer på stora och små bokstäver beror på databasens kollation. |
date_from | Nej | Ta med fax från början av denna dag enligt serverns lokala tid. Använd YYYY-MM-DD. |
date_to | Nej | Ta med fax till och med slutet av denna dag enligt serverns lokala tid. Använd YYYY-MM-DD. |
Datumgränserna är inkluderande och använder API-serverns datumtolkning, inte en begärd tidszon för användaren. Ogiltiga datumsträngar kan ignoreras i stället för att avvisas; validera dem innan de skickas. Utan datumfilter tillämpar hanteraren inget förvalt datumintervall. Resultaten sorteras efter mottagningstid, med de senaste först. Slutpunkten ger ingen stabil ögonblicksbild över flera sidor: nya inkommande fax kan flytta poster mellan sidorna.
Läs en sida i inkorgen
Läs HTTP-resultatet och status.code i JSON. Fel på andra ställen i API kan returneras i ett felhölje i JSON även när HTTP-statusen är 200. Ett lyckat svar innehåller response.faxes och response.pagination. Det här exemplet använder påhittade värden.
{
"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 är den numeriska identifieraren för posten i inkorgen. hash är dess MD5-representation för det äldre arbetsflödet för inkommande dokument; det är varken en jobbidentifierare för send_fax eller en behörighetsuppgift. Använd det inte med slutpunkten för utgående fax fax_status.
received_timestamp är den lagrade Unix-tidsstämpeln. received_at är en tidsstämpel formaterad av servern utan tidszonsförskjutning, eller null om ingen mottagningstid har registrerats; använd Unix-värdet när du visar tider i din egen tidszon. cost är ett tal i JSON, inte en prisuppgift eller ett bevis på en separat genomförd debitering.
status är success endast när den lagrade statuskoden är noll; andra värden blir failed. status_text innehåller det lagrade bearbetningsmeddelandet, med OK eller Failed som reservvärde. emailed behåller det lagrade värdet i stället för ett booleskt värde. viewed är ett booleskt värde. Dra inte slutsatsen att e-postleveransen har lyckats enbart utifrån faxets status.
Hantera tomma och föränderliga listor
En tom inkorg returnerar en tom faxes-array, total med värdet 0 och total_pages med värdet 0. En sida efter den sista sidan kan också returnera en tom array. Avsluta hämtningen enligt sidindelningsfälten i stället för att anta att det finns minst en sida. Ingen markör eller sekundär sortering efter postidentifierare är tillgänglig. Behåll postidentifierarna när du stämmer av överlappande sidor.
Dokumentåtkomst och integritet
Poster i inkorgen innehåller privata telefon- och dokumentmetadata. Begränsa åtkomsten i din applikation och undvik att logga fullständiga svar. Listning markerar inte ett dokument som visat. Använd fax_file för kompatibilitetsnedladdning av inkommande dokument. Observera att detta markerar en befintlig inkommande post som visad även om dess fil inte är tillgänglig. Dokumenten kan också nås via portalens inkorg. Ingen garanti för hur länge filer sparas har fastställts.