Enne saatmist
Kasutage saatjanumbrit, mida teil on õigus esitada, ja saatke faks saajale, kes seda ootab. See päring loob tegeliku edastuse, mille eest võidakse tasu võtta. Lehekülgede võimalikult usaldusväärseks tuvastamiseks kasutage ettevalmistatud PDF- või TIFF-dokumenti. Järjekorda lisamise vastus kinnitab vastuvõtmist, mitte kohaletoimetamist.
Kasutage aktiveeritud MultiTEL API kontot. Parooliga konto korral saatke HTTP Basic autentimisandmed, pääsmepõhise konto korral aga Bearer pääse. Konto õigused ja IP-piirangud kehtivad endiselt. Ärge kasutage sisemise taustatöötaja autentimisandmeid.
Laadige dokument üles
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| Väli | Kohustuslik | Tähendus |
|---|---|---|
from_number | Jah | Saatjanumber, mida teil on õigus kasutada. Kasutage rahvusvahelist vormingut, mis algab märgiga + ja riigikoodiga. |
to_number | Jah | Saaja faksinumber rahvusvahelises vormingus. |
fax_file | Jah, mitmeosalise päringu korral | Üleslaaditud dokument. Laske tööriistal curl määrata mitmeosalise päringu Content-Type ja osade eraldaja. |
webhook_url | Ei | Valikuline HTTP või HTTPS tagasikutse URL; eelistatud on HTTPS. Tagasikutse andmesisu ja kohaletoimetamise garantiid on veel ülevaatamisel: dokumenteeritud olekukontrolli töövoo järgimiseks tehke perioodilisi päringuid funktsioonile fax_status. |
Toetatud on ka JSON päisega Content-Type: application/json, samade numbriväljade ja valikulise väljaga webhook_url ning lisaväljadega file_name ja file_b64. file_b64 sisaldab dokumendi baite, mis on kodeeritud rangelt Base64 vormingus, ilma eesliiteta data:. Mitmeosalise päringu kehtiv väli fax_file on ülimuslik. See ei ole failide URL-i kaudu hankimise API.
Dokumendi ja päringute esitamise piirangud
Rakendus võtab vastu kuni 15,728,640 dekodeeritud dokumendibaiti (15 MiB) faililaienditega pdf, tif, tiff, jpg, jpeg, png, doc, docx või txt. Lubatud faililaiend ei taga, et teenus suudab lehekülgi loendada või teisendada. Taristu päringupiirangud võivad olla väiksemad ning Base64 suurendab päringu mahtu.
Praegune rakendus lubab konto kohta samale sihtnumbrile ühe järjekorras või saatmisel oleva töö, viimase tunni jooksul kuni viis päringu esitamist sellele sihtnumbrile ning viimase tunni jooksul kokku kuni 50 päringu esitamist. Sageduspiirangu vastuses kasutatakse API koodi 429. Enne uuesti proovimist oodake; ärge proovige piirangutest mööda minna.
Säilitage töö ID
Kontrollige nii HTTP tulemust kui ka JSON välja status.code. JSON veavastused võivad saabuda koos HTTP koodiga 200. Edukas JSON vastus sisaldab välju status ja response; näidetes kasutatakse väljamõeldud andmeid.
{
"status": {
"code": 200,
"msg": "Fax queued"
},
"response": {
"job_id": "0123456789abcdef0123456789abcdef"
}
}Tehke perioodilisi päringuid funktsioonile fax_status välja response.job_id abil. Kui saatmisvastus läheb kaotsi, kontrollige enne uuesti saatmist portaali väljundkausta: korduvad päringud võivad luua eraldi edastusi. See päringukäsitleja ei paku kliendile idempotentsusparameetrit.
Vead ja saldokontrollid
API koodide hulka kuuluvad 400 puuduvate väljade, vigase tagasikutse URL-i, tagasilükatud dokumendi või lehekülgede tuvastamise ebaõnnestumise korral; 401 puuduva autentimise korral; 402, kui faksi hinnanguline maksumus koos järjekorras või saatmisel olevate tööde hinnanguliste maksumustega ületab konto saadaolevat saldot; 429 sageduspiirangute korral; ja 500 edastuse ettevalmistamise ebaõnnestumise korral. Konkreetset põhjust vaadake väljalt status.msg.
Järjekord salvestab hinnangulise maksumuse enne edastamist. Ärge tõlgendage vastuvõtmist, saldokontrolli ega seda hinnangut kinnitusena, et tasu on juba võetud. Lõpliku arvelduse ja tagasikutsete üksikasjad vajavad veel kontrollimist.