प्राप्त फ़ैक्स की सूची देखें
सक्रिय MultiTEL API खाते के लिए कॉन्फ़िगर किए गए क्रेडेंशियल और IP प्रतिबंधों का पालन करते हुए HTTPS के ज़रिए उसका उपयोग करें। यह एंडपॉइंट प्रमाणित खाते से संबंधित प्राप्त फ़ैक्स की सूची देता है। यह फ़ैक्स नहीं भेजता और न ही उसका दस्तावेज़ डाउनलोड करता है।
curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
--data-urlencode page=1 \
--data-urlencode limit=25 \
--data-urlencode date_from=2026-10-01 \
--data-urlencode date_to=2026-10-02 \
https://api.multitel.net/v3/fax_inbox| पैरामीटर | अनिवार्य | अर्थ |
|---|---|---|
page | नहीं | पृष्ठ संख्या, जो 1 से शुरू होती है। डिफ़ॉल्ट: 1। |
limit | नहीं | हर पृष्ठ पर रिकॉर्ड की संख्या। डिफ़ॉल्ट: 25; अधिकतम: 100। धनात्मक पूर्णांक का उपयोग करें। |
search | नहीं | भेजने वाले नंबर, फ़ैक्स प्राप्त करने वाले नंबर और दूरस्थ स्टेशन की पहचान में खोज करता है। शुरुआत और अंत के स्पेस हटा दिए जाते हैं। बड़े और छोटे अक्षरों में अंतर किया जाएगा या नहीं, यह डेटाबेस के कोलेशन नियमों पर निर्भर करता है। |
date_from | नहीं | सर्वर के स्थानीय समय के अनुसार इस दिन की शुरुआत से प्राप्त फ़ैक्स शामिल करें। YYYY-MM-DD का उपयोग करें। |
date_to | नहीं | सर्वर के स्थानीय समय के अनुसार इस दिन के अंत तक प्राप्त फ़ैक्स शामिल करें। YYYY-MM-DD का उपयोग करें। |
तारीख़ की दोनों सीमाएँ शामिल होती हैं और तारीख़ों की व्याख्या API सर्वर के अनुसार की जाती है, अनुरोध किए गए उपयोगकर्ता के समय क्षेत्र के अनुसार नहीं। अमान्य तारीख़ स्ट्रिंग को अस्वीकार करने के बजाय अनदेखा किया जा सकता है; भेजने से पहले उनकी वैधता जाँचें। तारीख़ के फ़िल्टर न होने पर हैंडलर कोई डिफ़ॉल्ट तारीख़ अवधि लागू नहीं करता। परिणाम प्राप्ति के समय के अनुसार क्रमबद्ध होते हैं, जिनमें सबसे नए पहले आते हैं। यह एंडपॉइंट अलग-अलग पृष्ठों में एक स्थिर स्नैपशॉट नहीं देता: नए फ़ैक्स आने पर रिकॉर्ड एक पृष्ठ से दूसरे पृष्ठ पर जा सकते हैं।
मेलबॉक्स का पृष्ठ पढ़ें
HTTP परिणाम और JSON में status.code पढ़ें। API में अन्य जगहों पर होने वाली विफलताओं के लिए JSON त्रुटि आवरण का उपयोग किया जा सकता है, भले ही HTTP स्थिति 200 हो। सफल प्रतिक्रिया में response.faxes और response.pagination होते हैं। इस उदाहरण में काल्पनिक मान इस्तेमाल किए गए हैं।
{
"status": {"code": 200, "msg": ""},
"response": {
"faxes": [{
"id": 12,
"hash": "c20ad4d76fe97759aa27a0c99bff6710",
"from_number": "+12125550123",
"to_number": "+12125550124",
"remote_station_id": "Example sender",
"pages": 2,
"cost": 0.05,
"received_at": "2026-10-01 12:00:00",
"received_timestamp": 1790856000,
"status": "success",
"status_text": "OK",
"emailed": "yes",
"viewed": false
}],
"pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
}
}id इनबॉक्स रिकॉर्ड की संख्यात्मक पहचान है। hash पुराने इनबाउंड दस्तावेज़ कार्यप्रवाह के लिए उसका MD5 रूप है; यह send_fax जॉब की पहचान या प्राधिकरण का क्रेडेंशियल नहीं है। आउटबाउंड fax_status एंडपॉइंट के साथ इसका उपयोग न करें।
received_timestamp संग्रहीत यूनिक्स टाइमस्टैम्प है। received_at सर्वर के प्रारूप में दिया गया टाइमस्टैम्प है, जिसमें समय क्षेत्र का ऑफ़सेट नहीं होता; प्राप्ति का समय दर्ज न होने पर इसका मान null होता है। अपने समय क्षेत्र में समय दिखाते हुए यूनिक्स मान का उपयोग करें। cost एक JSON संख्या है, कीमत का प्रस्ताव या किसी अलग शुल्क की वसूली पूरी होने का प्रमाण नहीं।
status का मान केवल संग्रहीत स्थिति कोड शून्य होने पर success होता है; अन्य मानों पर यह failed हो जाता है। status_text में संग्रहीत प्रसंस्करण संदेश होता है; वह उपलब्ध न होने पर OK या Failed का उपयोग होता है। emailed बूलियन के बजाय संग्रहीत मान को बनाए रखता है। viewed एक बूलियन है। केवल फ़ैक्स की स्थिति के आधार पर यह निष्कर्ष न निकालें कि ईमेल सफलतापूर्वक पहुँच गया है।
खाली और बदलती सूचियाँ सँभालें
खाली मेलबॉक्स के लिए खाली faxes ऐरे, total का मान 0 और total_pages का मान 0 मिलता है। अंतिम पृष्ठ के बाद का पृष्ठ माँगने पर भी खाली ऐरे मिल सकता है। कम से कम एक पृष्ठ होने की धारणा बनाने के बजाय पृष्ठांकन के फ़ील्ड के अनुसार रुकें। कोई कर्सर या रिकॉर्ड की पहचान के आधार पर द्वितीयक क्रम उपलब्ध नहीं कराया जाता। एक ही रिकॉर्ड वाले पृष्ठों का मिलान करते समय रिकॉर्ड की पहचान सुरक्षित रखें।
दस्तावेज़ तक पहुँच और गोपनीयता
मेलबॉक्स की प्रविष्टियों में टेलीफ़ोन और दस्तावेज़ों का निजी मेटाडेटा होता है। अपने एप्लिकेशन में पहुँच सीमित रखें और पूरी प्रतिक्रियाओं को लॉग करने से बचें। सूची देखने से दस्तावेज़ को देखा गया चिह्नित नहीं किया जाता। इसका उपयोग करें: fax_file (संगतता वाले इनबाउंड डाउनलोड के लिए)। ध्यान दें कि यह किसी मौजूदा इनबाउंड रिकॉर्ड को देखा गया चिह्नित करता है, भले ही उसकी फ़ाइल उपलब्ध न हो। दस्तावेज़ तक पहुँचने के लिए पोर्टल का इनबॉक्स भी उपलब्ध है। फ़ाइल को कितने समय तक रखा जाएगा, इसकी कोई गारंटी स्थापित नहीं की गई है।