Utviklere

GET/v3/fax_inbox

Vis mottatte fakser

Les innboksen for innkommende fakser med sideinndeling, nummersøk og filtre for mottaksdato.

På denne siden
  1. Vis mottatte fakser
  2. Les en side fra innboksen
  3. Håndter tomme lister og lister som endrer seg
  4. Dokumenttilgang og personvern

Vis mottatte fakser

Bruk en aktivert MultiTEL-konto for API over HTTPS med kontoens konfigurerte påloggingsopplysninger og IP-begrensninger. Dette endepunktet viser mottatte fakser som tilhører den autentiserte kontoen. Det sender ikke en faks og laster heller ikke ned dokumentet.

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
Spørringsparametere for innboksen
ParameterPåkrevdBetydning
pageNeiSidenummer, fra og med 1. Standardverdi: 1.
limitNeiAntall oppføringer per side. Standardverdi: 25; maksimum: 100. Bruk et positivt heltall.
searchNeiSøker i avsendernummeret, mottakerens faksnummer og identifikatoren til den eksterne stasjonen. Innledende og avsluttende mellomrom fjernes. Om det skilles mellom store og små bokstaver, avhenger av databasens sammenligningsregler.
date_fromNeiTa med fakser fra starten av denne dagen i serverens lokale tid. Bruk YYYY-MM-DD.
date_toNeiTa med fakser til og med slutten av denne dagen i serverens lokale tid. Bruk YYYY-MM-DD.

Datogrensene er inklusive og følger datotolkningen til serveren for API, ikke en forespurt tidssone for brukeren. Ugyldige datostrenger kan bli ignorert i stedet for avvist; kontroller dem før de sendes. Uten datofiltre legger ikke forespørselsbehandleren inn noe standard datointervall. Resultatene sorteres etter mottakstidspunkt, med de nyeste først. Endepunktet gir ikke et stabilt øyeblikksbilde på tvers av sider: nye fakser kan flytte oppføringer mellom sider.

Les en side fra innboksen

Les resultatet fra HTTP og feltet status.code i JSON. Feil andre steder i API kan returneres i en feilkonvolutt i JSON, selv når statusen for HTTP er 200. Et vellykket svar inneholder response.faxes og response.pagination. Dette eksemplet bruker oppdiktede verdier.

{
  "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 den numeriske identifikatoren til oppføringen i innboksen. hash er oppføringens MD5-representasjon for den eldre arbeidsflyten for innkommende dokumenter; det er ikke en jobbidentifikator for send_fax eller en autorisasjonsopplysning. Ikke bruk den med endepunktet for utgående fakser fax_status.

received_timestamp er det lagrede Unix-tidsstempelet. received_at er et tidsstempel formatert av serveren uten tidssoneforskyvning, eller null hvis det ikke er registrert noe mottakstidspunkt; bruk Unix-verdien når du viser tidspunkter i din egen tidssone. cost er et tall i JSON, ikke et pristilbud eller dokumentasjon på en separat gjennomført belastning.

status har verdien success bare når den lagrede statuskoden er null; andre verdier blir failed. status_text inneholder den lagrede behandlingsmeldingen, med OK eller Failed som reserveverdi. emailed beholder den lagrede verdien i stedet for å konvertere den til en boolsk verdi. viewed er en boolsk verdi. Ikke trekk slutningen at e-posten er levert, utelukkende på grunnlag av faksstatusen.

Håndter tomme lister og lister som endrer seg

En tom innboks returnerer en tom faxes-tabell, total 0 og total_pages 0. En forespørsel om en side etter den siste siden kan også returnere en tom tabell. Avslutt hentingen ut fra feltene for sideinndeling, i stedet for å anta at det finnes minst én side. Verken markør eller sekundær sortering etter oppføringsidentifikator er tilgjengelig. Ta vare på oppføringsidentifikatorene når du sammenstiller sider som overlapper.

Dokumenttilgang og personvern

Oppføringer i innboksen inneholder private metadata om telefonnumre og dokumenter. Begrens tilgangen i applikasjonen din, og unngå å logge fullstendige svar. Å hente listen markerer ikke et dokument som vist. Bruk fax_file for nedlasting av innkommende dokumenter via kompatibilitetsfunksjonen. Vær oppmerksom på at dette markerer en eksisterende oppføring for en innkommende faks som vist, selv om filen ikke er tilgjengelig. Innboksen i portalen gir også tilgang til dokumenter. Det er ikke fastsatt noen garanti for hvor lenge filer oppbevares.