Ontvangen faxen opvragen

Ontvangen faxen opvragen

Gebruik een ingeschakeld MultiTEL-account voor de API via HTTPS, met de daarvoor ingestelde inloggegevens en IP-beperkingen. Dit eindpunt geeft een lijst van ontvangen faxen die bij het geauthenticeerde account horen. Het verstuurt geen fax en downloadt het bijbehorende document niet.

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

De datumgrenzen zijn inclusief en volgen de datuminterpretatie van de API-server, niet een aangevraagde tijdzone van de gebruiker. Ongeldige datumteksten kunnen worden genegeerd in plaats van afgewezen; controleer ze voordat u ze verstuurt. Zonder datumfilters legt de verwerking geen standaardperiode op. De resultaten worden gesorteerd op ontvangsttijd, met de nieuwste eerst. Het eindpunt biedt geen onveranderlijke momentopname over de pagina's heen: nieuwe binnenkomende faxen kunnen records naar andere pagina's verschuiven.

Een pagina van de inbox uitlezen

Controleer het HTTP-resultaat en status.code in de JSON. Fouten elders in de API kunnen een foutantwoord in JSON gebruiken, zelfs als de HTTP-status 200 is. Een geslaagd antwoord bevat response.faxes en response.pagination. Dit voorbeeld gebruikt fictieve waarden.

{
  "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 is de numerieke identificatie van het inboxrecord. hash is de MD5-weergave daarvan voor de oudere werkwijze voor inkomende documenten; het is geen taakidentificatie voor send_fax en geen autorisatiegegeven. Gebruik deze waarde niet met het eindpunt voor uitgaande faxen fax_status.

received_timestamp is het opgeslagen Unix-tijdstempel. received_at is een door de server opgemaakt tijdstempel zonder tijdzoneverschil, of null als er geen ontvangsttijd is vastgelegd; gebruik de Unix-waarde om tijden in uw eigen tijdzone weer te geven. cost is een getal in JSON, geen prijsopgave of bewijs van een afzonderlijke voltooide afschrijving.

status is alleen success als de opgeslagen statuscode nul is; andere waarden worden failed. status_text bevat het opgeslagen verwerkingsbericht, met OK of Failed als terugvalwaarde. emailed behoudt de opgeslagen waarde en zet deze niet om in een booleaanse waarde. viewed is een booleaanse waarde. Leid een geslaagde e-mailbezorging niet uitsluitend af uit de faxstatus.

Omgaan met lege en veranderende lijsten

Een lege inbox retourneert een lege array faxes, total met waarde 0 en total_pages met waarde 0. Een pagina na de laatste pagina kan ook een lege array retourneren. Stop op basis van de pagineringsvelden en ga er niet van uit dat er ten minste één pagina is. Er wordt geen cursor of aanvullende sortering op recordidentificatie aangeboden. Bewaar de recordidentificaties wanneer u overlappende pagina's met elkaar afstemt.

Documenttoegang en privacy

Inboxrecords bevatten vertrouwelijke telefoon- en documentmetadata. Beperk de toegang in uw toepassing en vermijd het vastleggen van volledige antwoorden in logboeken. Het opvragen van de lijst markeert een document niet als bekeken. Gebruik fax_file om inkomende documenten via de compatibiliteitsfunctie te downloaden. Houd er rekening mee dat dit een bestaand inkomend record als bekeken markeert, ook als het bijbehorende bestand niet beschikbaar is. Documenten zijn ook toegankelijk via de inbox in het portaal. Er is geen garantie voor het bewaren van bestanden vastgesteld.