Пре слања
Користите број пошиљаоца за који имате овлашћење да га приказујете и шаљите примаоцу који очекује ваш факс. Овај захтев покреће стварни пренос који може бити наплаћен. За најпредвидљивије препознавање страница користите припремљен документ у формату PDF или TIFF. Одговор да је факс стављен у ред потврђује прихватање, а не испоруку.
Користите омогућен MultiTEL API налог. За налог са лозинком пошаљите акредитиве за HTTP Basic аутентификацију, а за налог са токеном пошаљите Bearer токен. Дозволе налога и ограничења IP адреса и даље важе. Не користите интерне акредитиве позадинског процеса.
Отпремите документ
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| Поље | Обавезно | Значење |
|---|---|---|
from_number | Да | Број пошиљаоца за који имате овлашћење. Користите међународни формат који почиње знаком + и позивним бројем државе. |
to_number | Да | Број факса примаоца у међународном формату. |
fax_file | Да, за вишеделни захтев | Отпремљени документ. Препустите алату curl да подеси Content-Type и гранични раздвајач вишеделног захтева. |
webhook_url | Не | Необавезна HTTP или HTTPS URL адреса за повратни позив; препоручује се HTTPS. Садржај повратног позива и гаранције његове испоруке још се проверавају: периодично упитујте fax_status у складу са документованим поступком праћења статуса. |
Прихвата се и JSON уз Content-Type: application/json, иста поља за бројеве и необавезно поље webhook_url, као и file_name и file_b64. file_b64 садржи бајтове документа кодиране строго по правилима формата Base64, без префикса data:. Важеће поље fax_file у вишеделном захтеву има предност. Ово није API за преузимање датотека са URL адреса.
Ограничења докумената и захтева за слање
Апликација прихвата највише 15,728,640 бајтова декодираног документа (15 MiB), са екстензијама pdf, tif, tiff, jpg, jpeg, png, doc, docx или txt. Дозвољена екстензија не гарантује да сервис може да преброји или конвертује странице. Инфраструктурна ограничења величине захтева могу бити нижа, а Base64 повећава величину захтева.
Тренутна апликација по налогу дозвољава један задатак у реду или у току слања ка истом одредишту, највише пет захтева за слање ка том одредишту у претходних сат времена и највише 50 захтева за слање укупно у претходних сат времена. Одговор због ограничења учесталости користи API код 429. Сачекајте пре поновног покушаја; не покушавајте да заобиђете ограничења.
Сачувајте идентификатор задатка
Проверите и HTTP резултат и поље status.code у JSON одговору. Грешке у JSON одговору могу стићи уз HTTP 200. Успешан JSON одговор садржи status и response; у примерима су коришћени измишљени подаци.
{
"status": {
"code": 200,
"msg": "Fax queued"
},
"response": {
"job_id": "0123456789abcdef0123456789abcdef"
}
}Периодично упитујте fax_status користећи response.job_id. Ако се одговор на захтев за слање изгуби, проверите излазно сандуче на порталу пре поновног слања: поновљени захтеви могу покренути засебне преносе. Овај обрађивач не ставља на располагање клијентски параметар за идемпотентност.
Грешке и провере расположивих средстава
API кодови обухватају 400 за недостајућа поља, неважећу URL адресу за повратни позив, одбијен документ или неуспело препознавање страница; 401 за недостатак аутентификације; 402 када процењени трошак факса, заједно са процењеним трошковима задатака у реду или у току слања, премашује расположива средства на налогу; 429 за ограничења учесталости; и 500 за грешку при припреми документа за слање. Прочитајте status.msg да бисте сазнали конкретан разлог.
У реду за слање се пре преноса бележи процењени трошак. Не тумачите прихватање, проверу расположивих средстава или ову процену као потврду да је наплата извршена. Детаљи коначног обрачуна и повратних позива и даље подлежу провери.