Lähetä faksi | MultiTEL

Ennen lähettämistä

Käytä lähettäjänumerona numeroa, jonka näyttämiseen sinulla on oikeus, ja lähetä faksi vastaanottajalle, joka odottaa sitä. Tämä pyyntö luo todellisen lähetyksen, josta voidaan veloittaa. Käytä valmiiksi valmisteltua PDF- tai TIFF-asiakirjaa, jotta sivujen tunnistus toimii mahdollisimman ennakoitavasti. Jonoon lisäämisestä kertova vastaus vahvistaa pyynnön hyväksymisen, ei faksin toimittamista.

Käytä aktivoitua MultiTEL-palvelun API-tiliä. Lähetä salasanatilin tunnistetiedot HTTP Basic -todennuksella tai tunnistepohjaisen tilin tunniste Bearer-todennuksella. Tilin käyttöoikeudet ja IP-rajoitukset ovat edelleen voimassa. Älä käytä sisäisten taustaprosessien tunnistetietoja.

Lataa asiakirja

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

Pyynnön kentät
Kenttä	Pakollinen	Merkitys
`from_number`	Kyllä	Lähettäjänumerosi, jonka käyttöön sinulla on oikeus. Käytä kansainvälistä muotoa, joka alkaa +-merkillä ja maatunnuksella.
`to_number`	Kyllä	Vastaanottajan faksinumero kansainvälisessä muodossa.
`fax_file`	Kyllä, moniosaisissa pyynnöissä	Ladattu asiakirja. Anna curl-ohjelman asettaa moniosaisen pyynnön Content-Type-otsake ja osien erotin.
`webhook_url`	Ei	Valinnainen HTTP- tai HTTPS-paluukutsuosoite; HTTPS on suositeltava. Paluukutsujen tietosisältöä ja toimitustakuita tarkistetaan edelleen: tee toistuvia kyselyjä fax_status-toimintoon dokumentoidun tilanseurannan mukaisesti.

Myös JSON hyväksytään otsakkeella Content-Type: application/json, samoilla numerokentillä ja valinnaisella webhook_url-kentällä sekä lisäkentillä file_name ja file_b64. file_b64 sisältää asiakirjan tavut tiukasti Base64-koodattuina ilman data:-etuliitettä. Kelvollinen moniosaisen pyynnön fax_file on etusijalla. Tämä API-rajapinta ei nouda tiedostoja verkko-osoitteista.

Asiakirjojen ja lähetyspyyntöjen rajoitukset

Sovellus hyväksyy enintään 15,728,640 tavua dekoodattua asiakirjadataa (15 MiB), kun tiedostopääte on pdf, tif, tiff, jpg, jpeg, png, doc, docx tai txt. Sallittu tiedostopääte ei takaa, että palvelu pystyy laskemaan sivut tai muuntamaan ne. Infrastruktuurin pyyntöjen kokorajat voivat olla pienempiä, ja Base64 kasvattaa pyynnön kokoa.

Nykyinen sovellus sallii tiliä kohden yhden jonossa olevan tai lähetysvaiheessa olevan työn samaan vastaanottajanumeroon, enintään viisi lähetyspyyntöä kyseiseen numeroon edeltävän tunnin aikana ja enintään 50 lähetyspyyntöä yhteensä edeltävän tunnin aikana. Pyyntömäärän rajoittamisesta kertova vastaus käyttää API-koodia 429. Odota ennen uutta yritystä; älä yritä kiertää rajoituksia.

Säilytä työn tunniste

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

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

Tee toistuvia kyselyjä toimintoon fax_status käyttäen response.job_id-arvoa. Jos lähetyspyynnön vastaus katoaa, tarkista portaalin lähtevien faksien kansio ennen uutta lähetystä: toistetut pyynnöt voivat luoda erillisiä lähetyksiä. Tämä käsittelijä ei tarjoa asiakkaalle idempotenssiparametria.

Virheet ja saldotarkistukset

API-koodeihin kuuluvat 400, kun kenttiä puuttuu, paluukutsuosoite on virheellinen, asiakirja hylätään tai sivujen tunnistus epäonnistuu; 401, kun todennus puuttuu; 402, kun faksin arvioitu hinta yhdessä jonossa olevien ja lähetettävien töiden hinta-arvioiden kanssa ylittää tilin käytettävissä olevan saldon; 429 pyyntömäärän rajoituksille; ja 500 lähetyksen valmistelun epäonnistuessa. Lue tarkka syy kentästä status.msg.

Jono tallentaa hinta-arvion ennen lähetystä. Älä tulkitse pyynnön hyväksymistä, saldotarkistusta tai tätä arviota vahvistukseksi toteutuneesta veloituksesta. Lopullisen laskutuksen ja paluukutsujen yksityiskohdat on vielä varmistettava.