Prieš siunčiant
Naudokite siuntėjo numerį, kurį turite teisę nurodyti, ir siųskite gavėjui, kuris laukia jūsų fakso. Ši užklausa sukuria tikrą siuntimą, už kurį gali būti taikomas mokestis. Kad puslapių nustatymas būtų kuo labiau nuspėjamas, naudokite paruoštą PDF arba TIFF dokumentą. Atsakymas apie įtraukimą į eilę patvirtina priėmimą, o ne pristatymą.
Naudokite įjungtą MultiTEL API paskyrą. Jei paskyra naudoja slaptažodį, siųskite HTTP Basic prisijungimo duomenis, o jei paskyra naudoja prieigos raktą – Bearer prieigos raktą. Paskyros teisės ir IP apribojimai tebegalioja. Nenaudokite vidinių foninio vykdytojo prisijungimo duomenų.
Įkelkite dokumentą
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| Laukas | Privalomas | Reikšmė |
|---|---|---|
from_number | Taip | Siuntėjo numeris, kurį turite teisę naudoti. Naudokite tarptautinį formatą, prasidedantį + ir šalies kodu. |
to_number | Taip | Gavėjo fakso numeris tarptautiniu formatu. |
fax_file | Taip, siunčiant kelių dalių užklausą | Įkeliamas dokumentas. Leiskite curl nustatyti kelių dalių užklausos Content-Type ir dalių skirtuką. |
webhook_url | Ne | Neprivalomas grįžtamųjų pranešimų HTTP arba HTTPS URL adresas; rekomenduojama naudoti HTTPS. Grįžtamųjų pranešimų duomenų turinys ir pristatymo garantijos dar peržiūrimi: būseną tikrinkite periodiškai užklausdami fax_status pagal dokumentuotą būsenos tikrinimo eigą. |
Taip pat priimamas JSON, nurodant Content-Type: application/json, tuos pačius numerių laukus ir neprivalomą webhook_url, taip pat file_name ir file_b64. Lauke file_b64 pateikiami dokumento baitai, griežtai užkoduoti Base64 formatu, be data: priešdėlio. Galiojantis kelių dalių užklausos fax_file turi pirmenybę. Ši API neskirta failams gauti pagal URL adresą.
Dokumentų ir pateikimo apribojimai
Programa priima ne daugiau kaip 15,728,640 dekoduotų dokumento baitų (15 MiB) su pdf, tif, tiff, jpg, jpeg, png, doc, docx arba txt plėtiniais. Leidžiamas plėtinys negarantuoja, kad paslauga galės suskaičiuoti arba konvertuoti puslapius. Infrastruktūros užklausų dydžio ribos gali būti mažesnės, o Base64 padidina užklausos dydį.
Šiuo metu programa kiekvienai paskyrai leidžia turėti vieną į eilę įtrauktą arba vykdomą siuntimo užduotį tam pačiam gavėjui, ne daugiau kaip penkis pateikimus tam gavėjui per praėjusią valandą ir iš viso ne daugiau kaip 50 pateikimų per praėjusią valandą. Atsakyme apie dažnio ribojimą naudojamas API kodas 429. Prieš bandydami dar kartą palaukite; nebandykite apeiti apribojimų.
Išsaugokite užduoties identifikatorių
Patikrinkite ir HTTP rezultatą, ir JSON lauką status.code. JSON pranešimai apie klaidas gali būti grąžinami su HTTP 200. Sėkmingame JSON atsakyme yra status ir response; pavyzdžiuose naudojami išgalvoti duomenys.
{
"status": {
"code": 200,
"msg": "Fax queued"
},
"response": {
"job_id": "0123456789abcdef0123456789abcdef"
}
}Periodiškai užklauskite fax_status naudodami response.job_id. Jei siuntimo atsakymas prarandamas, prieš siųsdami dar kartą patikrinkite portalo siunčiamųjų aplanką: pakartotinės užklausos gali sukurti atskirus siuntimus. Ši apdorojimo funkcija nesuteikia klientui idempotentiškumo parametro.
Klaidos ir likučio patikros
API kodai apima 400, kai trūksta laukų, netinkamas grįžtamųjų pranešimų URL adresas, dokumentas atmetamas arba nepavyksta nustatyti puslapių; 401, kai nepateikti tapatybės nustatymo duomenys; 402, kai numatoma fakso kaina kartu su eilėje laukiančių ir siunčiamų faksų numatomomis kainomis viršija prieinamą paskyros likutį; 429, kai viršijami dažnio apribojimai; ir 500, kai nepavyksta paruošti dokumento siųsti. Konkrečią priežastį rasite status.msg.
Prieš siuntimą eilėje įrašoma numatoma kaina. Nelaikykite priėmimo, likučio patikros ar šio įverčio patvirtinimu, kad mokestis jau nuskaičiuotas. Galutinio atsiskaitymo ir grįžtamųjų pranešimų detalės dar turi būti patikrintos.