Преди изпращане
Използвайте номер на подателя, който имате право да представяте, и изпращайте до получател, който очаква вашия факс. Тази заявка създава реално предаване, което може да бъде таксувано. За най-предвидимо разпознаване на страниците използвайте подготвен документ във формат 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 за конкретната причина.
В опашката се записва прогнозна цена преди предаването. Не тълкувайте приемането, проверката на наличността или тази прогноза като потвърждение за извършено таксуване. Подробностите за окончателното таксуване и обратните извиквания все още подлежат на проверка.