Lys ontvangde fakse

Lys ontvangde fakse

Gebruik 'n geaktiveerde MultiTEL API-rekening oor HTTPS met die ingestelde aanmeldbesonderhede en IP-beperkings daarvan. Hierdie eindpunt lys ontvangde fakse wat aan die geoutentiseerde rekening behoort. Dit stuur nie 'n faks of laai die dokument daarvan af nie.

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

Datumgrense is inklusief en gebruik die API-bediener se interpretasie van datums, nie 'n aangevraagde gebruikertydsone nie. Ongeldige datumstringe kan geïgnoreer word eerder as om verwerp te word; kontroleer die geldigheid daarvan voordat jy dit stuur. Sonder datumfilters stel die versoekhanteerder geen verstekdatumvenster nie. Resultate word volgens ontvangtyd gerangskik, met die nuutste eerste. Die eindpunt bied nie 'n onveranderlike momentopname oor bladsye heen nie: nuwe aankomste kan rekords tussen bladsye verskuif.

Lees die inkassiebladsy

Lees die HTTP-resultaat en die JSON-veld status.code. Mislukkings elders in die API kan 'n JSON-foutomhulsel gebruik, selfs wanneer die HTTP-status 200 is. 'n Suksesvolle antwoord bevat response.faxes en response.pagination. Hierdie voorbeeld gebruik fiktiewe waardes.

{
  "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 die numeriese identifiseerder van die inkassierekord. hash is die MD5-voorstelling daarvan vir die ou werkvloei vir inkomende dokumente; dit is nie 'n send_fax-taakidentifiseerder of 'n magtigingsbewys nie. Moet dit nie gebruik met die uitgaande fax_status-eindpunt nie.

received_timestamp is die gestoorde Unix-tydstempel. received_at is 'n tydstempel wat deur die bediener geformateer is sonder 'n tydsone-afwyking, of null indien geen ontvangtyd aangeteken is nie; gebruik die Unix-waarde wanneer jy tye in jou eie tydsone vertoon. cost is 'n JSON-getal, nie 'n pryskwotasie of bewys van 'n afsonderlike voltooide heffing nie.

status is slegs success wanneer die gestoorde statuskode nul is; ander waardes word failed. status_text bevat die gestoorde verwerkingsboodskap, met OK of Failed as terugvalwaarde. emailed behou die gestoorde waarde eerder as om dit na 'n Boole-waarde om te skakel. viewed is 'n Boole-waarde. Moenie bloot uit die faksstatus aflei dat e-pos suksesvol afgelewer is nie.

Hanteer leë en veranderende lyste

'n Leë inkassie gee 'n leë faxes-skikking, total met waarde 0 en total_pages met waarde 0 terug. 'n Bladsy ná die laaste bladsy kan ook 'n leë skikking teruggee. Staak volgens die bladsynavigasievelde eerder as om aan te neem dat daar minstens een bladsy is. Geen kursor of sekondêre sortering volgens rekordidentifiseerder word beskikbaar gestel nie. Behou rekordidentifiseerders wanneer jy oorvleuelende bladsye met mekaar versoen.

Dokumenttoegang en privaatheid

Inkassie-inskrywings bevat private telefoon- en dokumentmetadata. Beperk toegang in jou toepassing en vermy die aantekening van volledige antwoorde in loglêers. Die lysversoek merk nie 'n dokument as bekyk nie. Gebruik fax_file vir die aflaai van inkomende dokumente ter wille van versoenbaarheid; let daarop dat dit 'n bestaande inkomende rekord as bekyk merk, selfs al is die lêer daarvan nie beskikbaar nie. Die portaal se inkassie is ook beskikbaar vir toegang tot dokumente. Geen waarborg vir lêerbewaring is vasgestel nie.