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