फ़ैक्स भेजें

भेजने से पहले

भेजने वाले के रूप में वही नंबर दें जिसे प्रदर्शित करने का आपको अधिकार है, और फ़ैक्स ऐसे प्राप्तकर्ता को भेजें जो इसकी अपेक्षा कर रहा हो। यह अनुरोध वास्तव में फ़ैक्स भेजने की प्रक्रिया शुरू करता है, जिसके लिए शुल्क लग सकता है। पृष्ठों की पहचान में अधिकतम विश्वसनीयता के लिए पहले से तैयार PDF या TIFF दस्तावेज़ का उपयोग करें। कतार में लगाए जाने का उत्तर अनुरोध स्वीकार होने की पुष्टि करता है, फ़ैक्स पहुँचने की नहीं।

सक्षम MultiTEL API खाते का उपयोग करें। पासवर्ड वाले खाते के लिए HTTP Basic प्रमाणीकरण विवरण भेजें, या टोकन वाले खाते के लिए Bearer टोकन भेजें। खाते की अनुमतियाँ और आईपी संबंधी प्रतिबंध फिर भी लागू होते हैं। आंतरिक पृष्ठभूमि कार्यकर्ता के प्रमाणीकरण विवरण का उपयोग न करें।

दस्तावेज़ अपलोड करें

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`	बहुभागीय अनुरोध के लिए हाँ	अपलोड किया गया दस्तावेज़। बहुभागीय अनुरोध का Content-Type और भागों को अलग करने वाला सीमा चिह्न curl को तय करने दें।
`webhook_url`	नहीं	वैकल्पिक HTTP या HTTPS कॉलबैक यूआरएल; HTTPS का उपयोग बेहतर है। कॉलबैक में भेजे जाने वाले डेटा और उसके पहुँचने की गारंटियों की अभी समीक्षा चल रही है: दस्तावेज़ में बताई गई स्थिति जानने की कार्यप्रक्रिया के लिए fax_status से नियमित अंतराल पर स्थिति पूछें।

JSON भी स्वीकार किया जाता है, जिसके लिए यह दें: Content-Type: application/json, वही नंबर वाले फ़ील्ड और वैकल्पिक webhook_url, साथ ही file_name और file_b64। file_b64 में दस्तावेज़ के बाइट सख्त Base64 एन्कोडिंग में होते हैं, जिनके आगे data: उपसर्ग नहीं होता। बहुभागीय अनुरोध के मान्य fax_file को प्राथमिकता मिलती है। यह फ़ाइल के यूआरएल से फ़ाइल प्राप्त करने वाला API नहीं है।

दस्तावेज़ और अनुरोध भेजने की सीमाएँ

एप्लिकेशन डिकोड किए गए दस्तावेज़ के अधिकतम 15,728,640 बाइट (15 MiB) स्वीकार करता है, जिनके फ़ाइल एक्सटेंशन pdf, tif, tiff, jpg, jpeg, png, doc, docx या txt हों। किसी एक्सटेंशन की अनुमति होने से यह गारंटी नहीं मिलती कि सेवा पृष्ठों की गिनती कर सकेगी या उन्हें परिवर्तित कर सकेगी। आधारभूत ढाँचे में अनुरोध के आकार की सीमाएँ इससे कम हो सकती हैं, और Base64 से अनुरोध का आकार बढ़ता है।

प्रत्येक खाते के लिए मौजूदा एप्लिकेशन एक ही प्राप्तकर्ता नंबर पर कतार में लगा हुआ या भेजा जा रहा एक कार्य, पिछले घंटे में उस नंबर पर अधिकतम पाँच अनुरोधों और पिछले घंटे में कुल अधिकतम 50 अनुरोधों की अनुमति देता है। अनुरोध दर की सीमा वाले उत्तर में API कोड 429 होता है। दोबारा प्रयास करने से पहले प्रतीक्षा करें; सीमाओं को दरकिनार करने की कोशिश न करें।

कार्य की पहचान संख्या सँभालकर रखें

HTTP परिणाम और JSON के status.code, दोनों को पढ़ें। JSON में विफलता के उत्तर HTTP 200 के साथ भी आ सकते हैं। सफल JSON उत्तर में status और response होते हैं; उदाहरणों में काल्पनिक डेटा दिया गया है।

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

नियमित अंतराल पर स्थिति पूछें: fax_status। इसके लिए response.job_id का उपयोग करें। यदि भेजने के अनुरोध का उत्तर खो जाए, तो दोबारा भेजने से पहले पोर्टल का आउटबॉक्स देखें: बार-बार अनुरोध करने से अलग-अलग फ़ैक्स भेजे जा सकते हैं। यह अनुरोध हैंडलर क्लाइंट को ऐसा कोई पैरामीटर उपलब्ध नहीं कराता जिससे दोहराए गए अनुरोध का प्रभाव एक ही बार तक सीमित रखा जा सके।

त्रुटियाँ और खाते की शेष राशि की जाँच

API कोड में ये शामिल हैं: फ़ील्ड न होने, कॉलबैक यूआरएल अमान्य होने, दस्तावेज़ अस्वीकार होने या पृष्ठों की पहचान विफल होने पर 400; प्रमाणीकरण न होने पर 401; फ़ैक्स की अनुमानित लागत और कतार में लगे या भेजे जा रहे फ़ैक्स के लागत अनुमानों का योग खाते की उपलब्ध शेष राशि से अधिक होने पर 402; अनुरोध दर की सीमाओं के लिए 429; और भेजने की तैयारी के चरण में विफलता होने पर 500। सटीक कारण जानने के लिए status.msg पढ़ें।

कतार फ़ैक्स भेजे जाने से पहले अनुमानित लागत दर्ज करती है। अनुरोध स्वीकार होने, शेष राशि की जाँच या इस अनुमान को शुल्क वसूल हो जाने की पुष्टि न मानें। अंतिम बिलिंग और कॉलबैक संबंधी विवरणों का सत्यापन अभी बाकी है।