Изаберите долазни или одлазни документ
Ова крајња тачка за компатибилност преузима факс документ који припада вашем налогу. Користите омогућен MultiTEL API налог преко HTTPS, са подешеним приступним подацима и ограничењима IP адреса. Она не шаље факс нити га поново шаље.
| Параметар | Обавезан | Значење |
|---|---|---|
type | Да | Користите inbound или outbound, тачно како је приказано. |
id | Да | За inbound користите hash који враћа fax_inbox. За outbound користите uuid који враћа fax_outbox. |
Ове вредности се наводе у путањи. Рута је /v3/fax_file/{type}/{id}, а не fax_download са додатним сегментима путање. Хеш вредност долазног факса није нумерички идентификатор записа нити идентификатор одлазног задатка. Копирајте идентификатор са листе одговарајућег сандучета; он не замењује аутентификацију.
Преузмите примљени факс
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710Хеш вредност у примеру представља измишљени запис 12 у пријемном сандучету. Своју вредност преузмите из fax_inbox. Преузимањем постојећег долазног записа он се означава као прегледан. То се дешава пре провере доступности датотеке, па чак и ако дође до грешке због недоступне датотеке, viewed може остати подешен на true. Немојте користити ову крајњу тачку само за проверу постојања примљеног факса ако желите да његово стање прегледаности остане непромењено.
Обрађивач даје предност сачуваном PDF документу. У супротном користи сачувани TIFF документ и покушава конверзију у PDF када је конвертор доступан. Ако конверзија није доступна или изазове изузетак који се обрађује, уместо тога враћа TIFF. Увек проверите враћено заглавље Content-Type уместо да претпостављате да је формат PDF.
Преузмите одлазни факс
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdefКористите uuid из fax_outbox. Ово преузимање ради компатибилности даје предност сачуваном бинарном објекту у формату PDF, затим бинарном објекту у формату TIFF, а потом доступној датотеци у формату PDF, датотеци у формату TIFF или изворној датотеци. Његов редослед приоритета разликује се од редоследа који користи актуелни излазни fax_download обрађивач. За нове интеграције које користе send_fax, користите тај актуелни ток рада за преузимање са његовим параметром job_id.
Изворна датотека може бити враћена као application/octet-stream уместо као PDF или TIFF. Име приложене датотеке може задржати изворну екстензију. Преузимање одлазног факса ради компатибилности не означава запис у пријемном сандучету као прегледан, не мења статус задатка нити покреће пренос.
Обрађујте бајтове и грешке одвојено
Успешан одговор враћа необрађене бајтове документа са заглављима Content-Type, Content-Disposition за прилог и Content-Length. То није JSON омотач са Base64 кодирањем. Сачувајте заглавља и бајтове одвојено, као што је приказано, проверите тип одговора и тек онда доделите датотеци одговарајуће име или је обрадите. Дозвољена екстензија изворне датотеке не гарантује да је документ исправан или конвертован.
Код 400 у API значи да недостаје обавезна вредност у путањи или да је type неважећи. Код 404 у API значи да запис у оквиру налога или његова датотека нису доступни. Грешке користе уобичајени JSON омотач status/response и могу користити HTTP 200. Проверите Content-Type одговора и status.code у JSON садржају како тело одговора са грешком не би било отворено као документ.
Приватност и доступност
Садржај факса може садржати осетљиве информације. Чувајте преузете датотеке само на местима којима могу приступити предвиђени примаоци и избегавајте бележење свих бајтова документа у евиденцијама. Запис у сандучету не гарантује да ће његова датотека остати доступна. Није утврђен период чувања датотека нити гаранција компатибилности за сваки раније сачувани документ.