इनबॉक्स या आउटबॉक्स का फ़ैक्स डाउनलोड करें

आवक या जावक दस्तावेज़ चुनें

यह संगतता एंडपॉइंट आपके खाते से संबंधित फ़ैक्स दस्तावेज़ प्राप्त करता है। सक्षम किए गए MultiTEL API खाते का उपयोग उसके निर्धारित क्रेडेंशियल और IP प्रतिबंधों के साथ HTTPS पर करें। यह फ़ैक्स भेजता या दोबारा भेजता नहीं है।

डाउनलोड पथ के पैरामीटर
पैरामीटर	अनिवार्य	अर्थ
`type`	हाँ	inbound या outbound का उपयोग ठीक उसी रूप में करें जैसा दिखाया गया है।
`id`	हाँ	inbound के लिए, fax_inbox से लौटाए गए hash का उपयोग करें। outbound के लिए, fax_outbox से लौटाए गए uuid का उपयोग करें।

ये मान पथ में दिए जाने चाहिए। रूट है /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 लौटाता है। PDF मान लेने के बजाय हमेशा लौटाए गए Content-Type की जाँच करें।

जावक फ़ैक्स डाउनलोड करें

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 पैरामीटर के साथ करें।

मूल स्रोत फ़ाइल PDF या TIFF के बजाय application/octet-stream के रूप में लौटाई जा सकती है। संलग्न फ़ाइल के नाम में स्रोत का एक्सटेंशन बना रह सकता है। यह संगतता जावक डाउनलोड किसी इनबॉक्स रिकॉर्ड को देखा हुआ चिह्नित नहीं करता, कार्य की स्थिति नहीं बदलता और कोई प्रेषण नहीं बनाता।

बाइट और त्रुटियों को अलग-अलग संभालें

सफल होने पर दस्तावेज़ के मूल बाइट Content-Type, संलग्नक दर्शाने वाले Content-Disposition और Content-Length हेडर के साथ लौटाए जाते हैं। यह Base64 वाला JSON आवरण नहीं है। दिखाए गए तरीके से हेडर और बाइट अलग-अलग सहेजें, प्रतिक्रिया के प्रकार की जाँच करें, और उसके बाद ही फ़ाइल को उपयुक्त नाम दें या उसे संसाधित करें। स्रोत फ़ाइल का एक्सटेंशन अनुमत होने से यह गारंटी नहीं मिलती कि दस्तावेज़ मान्य है या उसका रूपांतरण हो चुका है।

API कोड 400 का अर्थ है कि पथ का कोई अनिवार्य मान मौजूद नहीं है या type अमान्य है। API कोड 404 का अर्थ है कि खाते के दायरे का रिकॉर्ड या उसकी फ़ाइल उपलब्ध नहीं है। त्रुटियाँ सामान्य JSON status/response आवरण का उपयोग करती हैं और HTTP 200 का उपयोग कर सकती हैं। प्रतिक्रिया के Content-Type और JSON के status.code की जाँच करें ताकि त्रुटि के मुख्य भाग को दस्तावेज़ के रूप में न खोला जाए।

गोपनीयता और उपलब्धता

फ़ैक्स की सामग्री में संवेदनशील जानकारी हो सकती है। डाउनलोड की गई फ़ाइलें केवल ऐसी जगह रखें जहाँ आपके निर्धारित प्राप्तकर्ता उन्हें प्राप्त कर सकें, और लॉग में दस्तावेज़ के सभी बाइट शामिल करने से बचें। मेलबॉक्स में रिकॉर्ड होने से यह गारंटी नहीं मिलती कि उसकी फ़ाइल उपलब्ध बनी रहेगी। फ़ाइलें कितने समय तक रखी जाएँगी, इसकी कोई अवधि निर्धारित नहीं की गई है और अतीत में संग्रहित हर दस्तावेज़ के लिए संगतता की कोई गारंटी स्थापित नहीं की गई है।