HTTPS और स्वीकृत API क्रेडेंशियल के साथ HTTP Basic प्रमाणीकरण का उपयोग करें। क्रेडेंशियल अपने एप्लिकेशन सर्वर पर रखें। ये होस्टेड PBX एंडपॉइंट api.multitel.net पर /hpbx/ का उपयोग करते हैं; /v3 न डालें। HTTP परिणाम और JSON प्रतिक्रिया में एप्लिकेशन स्टेटस, दोनों जाँचें।
फ़ैक्स रिकॉर्ड पढ़ें
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"अपने PBX का बिलिंग कोड इस्तेमाल करें। लौटाए गए रिकॉर्ड में फ़ैक्स का समय, दिशा, स्रोत, गंतव्य, डिलीवरी की स्थिति, प्रयास, त्रुटियाँ और पृष्ठों की संख्या होती है। भेजने का अनुरोध स्वीकार होने के बाद भी डिलीवरी लंबित हो सकती है।
भेजने के पैरामीटर
भेजने का एंडपॉइंट POST /hpbx/fax/send/{billing_code} है। यह कार्रवाई फ़ाइल वास्तव में भेजती है। सबमिट करने से पहले फ़ाइल और खाते के लिए अधिकृत गंतव्य तैयार करें; यदि पिछली बार भेजने का परिणाम स्पष्ट न हो, तो जाँचे बिना दोबारा न भेजें।
| फ़ील्ड | अर्थ |
|---|---|
| number | गंतव्य फ़ैक्स नंबर। |
| cidnum | भेजने के लिए स्वीकृत कॉलर आईडी। |
| schedule | निर्धारित भेजने का समय, जब उपयोग किया गया हो। |
| faxquality / pagesize / pagerotate | समर्थित गुणवत्ता, पेपर आकार और रोटेशन विकल्प। |
| statusemail | डिलीवरी सूचनाओं के लिए अधिकृत पता। |
| deleteaftersend | क्या भेजने के बाद अपलोड की गई और सहेजी हुई फ़ाइल हटानी है। |
| filename | इस फ़ैक्स वर्कफ़्लो द्वारा अपेक्षित दस्तावेज़ संदर्भ; यह कोई मनमाना स्थानीय फ़ाइल पथ नहीं है। |
पूरा होने की स्थिति देखें
भेजने का अनुरोध जमा करने के बाद फ़ैक्स रिकॉर्ड की स्थिति, प्रयास और त्रुटि जाँचें। वास्तविक डिलीवरी की पुष्टि करें; अनुरोध स्वीकार होना डिलीवरी का प्रमाण नहीं है। पोर्टल फ़ैक्स संदर्भ में वर्तमान अपलोड और भेजने की प्रक्रिया दी गई है; उसके पथ और प्रमाणीकरण ऊपर के एंडपॉइंट से अलग हैं।