REST API दस्तावेज़

आपातकालीन कॉलिंग REST API

कोई नंबर और सेवा पता पंजीकृत करें, उसकी सक्रियण स्थिति देखें और स्थान बदलने पर रिकॉर्ड को अद्यतन रखें।

खाता-विशिष्ट संदर्भ खोलें डेवलपर और ऑटोमेशन

API और क्रेडेंशियल साथ में चुनें

डेवलपर और ऑटोमेशन, व्यवसाय और संचार प्रदाता श्रेणियों के स्वीकृत खाते सक्षम सेवाओं को इंटीग्रेट कर सकते हैं। किसी व्यक्तिगत डेवलपर को कंपनी होने का दिखावा करने की आवश्यकता नहीं है। एप्लिकेशन SMS/MMS के लिए लागू भेजने की स्वीकृति और पंजीकरण आवश्यक है। व्यक्तियों और परिवारों के लिए सेवा में ग्राहकों को संदेश भेजना शुरू करने वाला कोई API उपलब्ध नहीं है।

API परिवार	बेस URL	प्रमाणीकरण और परिणाम
Communications v3	`https://api.multitel.net/v3`	स्वीकृत Basic क्रेडेंशियल; योग्य प्रोविज़न किए गए टोकन केवल उन ऑपरेशनों के लिए जो उन्हें समर्थित करते हैं। JSON `status` और `response`।
आपातकालीन कॉलिंग के लिए पंजीकरण	`https://api.multi.tel/emergency`	स्वीकृत Basic क्रेडेंशियल या विशेष रूप से प्रोविज़न की गई bearer एक्सेस। JSON `code`, `message` और `data`।
पोर्टल REST इंटीग्रेशन	होस्ट और ऑपरेशन वही जो आपके खाते के डेवलपर संदर्भ में दिखाया गया है	उस ऑपरेशन के लिए दस्तावेज़ में बताए गए क्रेडेंशियल, स्कोप और स्कीमा का उपयोग करें। ब्राउज़र सेशन अनुरोध एक अलग इंटरफ़ेस का हिस्सा हैं।

उदाहरणों का उपयोग करने से पहले अपने सर्वर की सीक्रेट कॉन्फ़िगरेशन के माध्यम से MULTITEL_API_USERNAME और MULTITEL_API_PASSWORD सेट करें। इन्हें सार्वजनिक ब्राउज़र JavaScript, URL या सोर्स कंट्रोल में कभी न डालें। समर्पित क्रेडेंशियल API इंटीग्रेशन सेटिंग्स में प्रबंधित किए जाते हैं।

नंबर पंजीकृत किए बिना कवरेज पढ़ें

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency भी समर्थित है। आपातकालीन सेवा के किसी भी बेस URL में /v3 नहीं होता। कवरेज में अंतरराष्ट्रीय सेवा के समर्थित देश, नंबर प्रकार और कीमतें सूचीबद्ध होती हैं; उत्तर अमेरिकी E911 पात्रता की जाँच पंजीकरण के दौरान होती है।

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

यह केवल रिस्पॉन्स की बाहरी संरचना दर्शाता है। प्रत्येक ऑपरेशन का data स्कीमा प्रकाशित Emergency API गाइड में पढ़ें।

पंजीकरण करें, स्थिति देखें, फिर कॉलिंग कॉन्फ़िगर करें

अमेरिका/कनाडा और अन्य समर्थित उत्तर अमेरिकी E911 क्षेत्रों के लिए, नंबर, E911 पता और आवश्यक सहमति की पुष्टियाँ दें। उत्तर अमेरिकी E911 केवल वास्तविक उपयोग के प्रोडक्शन वातावरण में उपलब्ध है।
समर्थित स्वामित्व वाले अंतरराष्ट्रीय नंबर के लिए, या तो सहेजा गया Document संदर्भ दें या एंड-यूज़र की पहचान और पता दें। पहले देश और नंबर-प्रकार की आवश्यकताएँ देखें।
एक POST /registrations अनुरोध भेजें। वैकल्पिक Idempotency-Key एक तार्किक परिवर्तन की पहचान करती है; पुनः प्रयासों में इसे और सटीक पेलोड को ज्यों का त्यों रखें।
GET /registrations/:number पढ़ें। जीवनचक्र, pending और actionRequired जाँचें; आवश्यक सुधारों का समाधान करें। स्वीकृति या लंबित होना सक्रिय सेवा नहीं है।
सक्रियण के बाद, सही आपातकालीन कॉलर ID और देश-विशिष्ट डायलिंग रूट कॉन्फ़िगर करें। सेवा की गैर-आपातकालीन सत्यापन प्रक्रिया का उपयोग करें।

अंतरराष्ट्रीय सैंडबॉक्स पंजीकरण अलग-थलग रहते हैं और वास्तविक आपातकालीन कॉलिंग सक्रिय नहीं करते। उत्तर अमेरिकी E911 के लिए मुख्य-खाते के क्रेडेंशियल आवश्यक हैं; गाइड अंतरराष्ट्रीय सबअकाउंट के सीमित समर्थन को समझाती है।

पोर्टल सेटअप और सत्यापन देशवार कवरेज और आपातकालीन फ़ोन नंबर पूर्ण सार्वजनिक अनुरोध, फ़ील्ड, स्टेटस और पुनः प्रयास गाइड

त्रुटियों और पुनः प्रयासों को संभालें

प्रमाणीकरण या अनुमति की विफलता: API क्रेडेंशियल की सक्षम स्थिति, अनुमत सेवा और स्रोत-IP प्रतिबंध जाँचें। पोर्टल सेशन कुकी इंटीग्रेशन क्रेडेंशियल नहीं है।
अपर्याप्त क्रेडिट या अपूर्ण स्वीकृति: ऑपरेशन दोहराने से पहले खाते के बैलेंस, भेजने की स्वीकृति या दस्तावेज़ की आवश्यकता का समाधान करें।
कोई परिणाम नहीं: खाली इन्वेंटरी या कॉलर का नाम न मिलने को सामान्य परिणाम मानकर संभालें। यह न मानें कि वाक्य-रचना की दृष्टि से मान्य नंबर पर हर सेवा उपलब्ध है।
नेटवर्क टाइमआउट या सेवा विफलता: रीड ऑपरेशन के लिए बैकऑफ़ के साथ सीमित पुनः प्रयास करें। खरीद, भेजने या पंजीकरण के लिए पहले ऑपरेशन की स्थिति देखें; स्वीकार किए जा चुके अनुरोध को दोबारा भेजने से शुल्क वाली कार्रवाई दोहराई जा सकती है।

Idempotency सहायता हर API परिवार की अपनी होती है। Emergency API पुनः प्रयास कुंजियाँ (retry keys) समर्थित करता है; इससे कोई भी मनमाना v3 अनुरोध idempotent नहीं हो जाता। सहायता के लिए टाइमस्टैम्प, लौटाए गए ID और संवेदनशील जानकारी हटाए गए रिस्पॉन्स सुरक्षित रखें।

अपने खाते के संदर्भ के साथ आगे बढ़ें

साइन-इन किया हुआ संदर्भ आपकी अनुमतियों और सक्षम सेवाओं के अनुसार ऑपरेशन फ़िल्टर करता है। इसके सटीक होस्ट, क्रेडेंशियल प्रकार, अनुरोध फ़ील्ड और रिस्पॉन्स स्कीमा का उपयोग करें। कंसोल लाइव ऑपरेशन चला सकते हैं, जिनमें खरीदारी और संदेश भी शामिल हैं।

खाते के अनुसार एंडपॉइंट सूची संचार REST कंसोल सार्वजनिक संचार OpenAPI दस्तावेज़OAuth इंटीग्रेशन गाइड