Vis modtagne faxer
Brug en aktiveret MultiTEL API-konto via HTTPS med kontoens konfigurerede legitimationsoplysninger og IP-begrænsninger. Dette endepunkt viser modtagne faxer, der tilhører den autentificerede konto. Det sender ikke en fax og downloader heller ikke dens 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 | Påkrævet | Betydning |
|---|---|---|
page | Nej | Sidenummer, begyndende med 1. Standardværdi: 1. |
limit | Nej | Poster pr. side. Standardværdi: 25; maksimum: 100. Brug et positivt heltal. |
search | Nej | Søger i afsendernummeret, modtagerens faxnummer og fjernstationens id. Indledende og afsluttende mellemrum fjernes. Om der skelnes mellem store og små bogstaver, afhænger af databasens sorteringsregler. |
date_from | Nej | Medtag faxer fra begyndelsen af denne dag i serverens lokale tid. Brug YYYY-MM-DD. |
date_to | Nej | Medtag faxer til og med slutningen af denne dag i serverens lokale tid. Brug YYYY-MM-DD. |
Datogrænserne er inklusive og bruger API-serverens fortolkning af datoer, ikke en anmodet brugertidszone. Ugyldige datostrenge kan blive ignoreret i stedet for afvist; valider dem inden afsendelse. Uden datofiltre anvender forespørgselsbehandleren intet standarddatointerval. Resultaterne sorteres efter modtagelsestidspunkt med de nyeste først. Endepunktet giver ikke et stabilt øjebliksbillede på tværs af sider: nye faxer kan flytte poster mellem siderne.
Læs en side fra postkassen
Læs HTTP-resultatet og JSON-feltet status.code. Fejl andre steder i API'et kan bruge en JSON-fejlstruktur, selv når HTTP-status er 200. Et vellykket svar indeholder response.faxes og response.pagination. Dette eksempel bruger fiktive værdier.
{
"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 er det numeriske id for posten i indbakken. hash er dens MD5-repræsentation til den ældre arbejdsgang for indgående dokumenter; det er ikke et job-id til send_fax eller en legitimationsoplysning til autorisation. Brug det ikke med det udgående fax_status-endepunkt.
received_timestamp er det gemte Unix-tidsstempel. received_at er et tidsstempel formateret af serveren uden tidszoneforskydning, eller null hvis der ikke er registreret et modtagelsestidspunkt; brug Unix-værdien, når du viser tidspunkter i din egen tidszone. cost er et tal i JSON, ikke et pristilbud eller dokumentation for en særskilt gennemført opkrævning.
status er kun success, når den gemte statuskode er nul; andre værdier bliver til failed. status_text indeholder den gemte behandlingsmeddelelse med OK eller Failed som reserveværdi. emailed bevarer den gemte værdi i stedet for at bruge en boolesk værdi. viewed er en boolesk værdi. Udled ikke, at en e-mail er leveret, alene ud fra faxens status.
Håndter tomme lister og lister, der ændrer sig
En tom postkasse returnerer et tomt faxes-array, total 0 og total_pages 0. En side efter den sidste side kan også returnere et tomt array. Stop ud fra sideinddelingsfelterne i stedet for at antage, at der er mindst én side. Der stilles hverken en markør eller en sekundær sortering efter post-id til rådighed. Bevar posternes id'er, når du sammenholder overlappende sider.
Dokumentadgang og privatliv
Postkassens poster indeholder private telefon- og dokumentmetadata. Begræns adgangen i din applikation, og undgå at logge komplette svar. Visning af listen markerer ikke et dokument som set. Brug fax_file til download af indgående dokumenter via kompatibilitetsfunktionen; bemærk, at den markerer en eksisterende indgående post som set, selv hvis dens fil ikke er tilgængelig. Portalens indbakke kan også bruges til at få adgang til dokumenter. Der er ikke fastlagt nogen garanti for opbevaring af filer.