Kehittäjät

GET/v3/fax_status?job_id={job_id}

Tarkista faksityön tila

Lue yksi tilillesi kuuluva lähtevä faksityö käyttämällä send_fax-kutsun palauttamaa työn tunnistetta.

Tällä sivulla
  1. Hae faksityösi
  2. Lue tulos
  3. Virheet

Hae faksityösi

Käytä käytössä olevaa MultiTEL API -tiliä. Lähetä salasanatilille HTTP Basic -tunnukset tai tunnistepohjaiselle tilille Bearer-tunniste. Tilin käyttöoikeudet ja IP-rajoitukset ovat edelleen voimassa. Älä käytä taustaprosessin sisäisiä tunnuksia.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  https://api.multitel.net/v3/fax_status

job_id on pakollinen, ja sen on oltava send_fax-kutsun palauttama 32 merkin heksadesimaalinen tunniste. Kopioi se täsmälleen. Pyynnöt rajataan todennettuun omistajaan.

Lue tulos

Lue sekä HTTP-tulos että JSON-vastauksen status.code. JSON-virheet voivat saapua HTTP 200 -vastauksella. Onnistunut JSON-vastaus sisältää kentät status ja response; esimerkeissä käytetään kuvitteellisia tietoja.

{
  "status": {
    "code": 200,
    "msg": "Fax status"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef",
    "from_number": "+12125550123",
    "to_number": "+12125550124",
    "status": "queued",
    "result": "",
    "pages_requested": 3,
    "pages_sent": 0,
    "cost": "0.07500",
    "webhook_status": "",
    "created_at": "2026-10-23 10:00:00",
    "updated_at": "2026-10-23 10:00:00"
  }
}

Esimerkki on jonossa oleva työ, ei toimitettu faksi tai hintatarjous. pages_requested on havaittu lähdesivujen määrä; pages_sent ilmoittaa käsittelyn kirjaaman edistymisen. cost on desimaaliluvun sisältävä merkkijono, jossa voi olla arvio jo työn ollessa jonossa. result sisältää käsittelytietoja; webhook_status sisältää kirjatun takaisinkutsutilan. Aikaleimat ovat palvelimen muotoilemia merkkijonoja ilman aikavyöhykkeen poikkeamaa.

Tee kyselyjä pitenevin välein tiukan silmukan sijaan. Käsittely voi ilmoittaa lähetetyn tai valmistuneen tilan, mutta nykyisessä tarkastuksessa ei ole todettu takuuta toimituksesta vastaanottajalle. Varmista tärkeän asiakirjan vastaanotto vastaanottajalta ennen kuin pidät sitä toimitettuna tai lähetät uuden kopion. Aktiivisen taustaprosessin elinkaarta, lopullisia laskutussääntöjä ja takaisinkutsusopimusta tarkistetaan edelleen. Älä oleta, että jonoon hyväksyminen tai muu kuin tyhjä työn tunniste tarkoittaisi toimitusta.

Virheet

API-koodi 400 tarkoittaa puuttuvaa tai virheellistä job_id-tunnistetta; 401 tarkoittaa puuttuvaa todennusta; 404 tarkoittaa, ettei työtä löytynyt tältä tililtä. Älä päättele omistajuutta pelkästä tunnisteesta.