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.multitel.net/v3/getcountries"v3 response में status और एक response ऐरे होता है। देश की प्रविष्टियों में isocode, name, countrycode, क्षमता की जानकारी और next_function शामिल हैं। उपलब्धता खाते और इन्वेंटरी पर निर्भर है; किसी देश का सूचीबद्ध होना इस बात का वादा नहीं है कि हर प्रिफ़िक्स या नंबर प्रकार स्टॉक में है।
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}खोज से सक्रियण तक
- संबंधित भूगोल ऑपरेशनों का उपयोग करके देश, जहाँ आवश्यक हो वहाँ उप-विभाग, क्षेत्र और नंबर प्रकार चुनें।
- चुने गए नंबर की सेटअप, मासिक और उपयोग कीमतें, कॉल चैनल, शामिल उपयोग की सीमा और पंजीकरण आवश्यकताएँ पढ़ें।
- आवश्यक एंड-यूज़र दस्तावेज़ जमा करें और उनकी स्थिति देखें। स्वीकृति तक कोई नंबर लंबित रह सकता है।
- सटीक इन्वेंटरी/मूल्य चयन के साथ एक ही बार ऑर्डर करें। यदि response अनिश्चित हो, तो दूसरा ऑर्डर भेजने से पहले अपनी इन्वेंटरी देखें।
- वॉइस रूटिंग और मैसेजिंग डिलीवरी को अलग-अलग कॉन्फ़िगर करें, फिर पूरे इच्छित रूट का परीक्षण करें।
त्रुटियों और पुनः प्रयासों को संभालें
- प्रमाणीकरण या अनुमति की विफलता
- API क्रेडेंशियल की सक्षम स्थिति, अनुमत सेवा और स्रोत-IP प्रतिबंध जाँचें। पोर्टल सेशन कुकी इंटीग्रेशन क्रेडेंशियल नहीं है।
- अपर्याप्त क्रेडिट या अपूर्ण स्वीकृति
- ऑपरेशन दोहराने से पहले खाते के बैलेंस, भेजने की स्वीकृति या दस्तावेज़ की आवश्यकता का समाधान करें।
- कोई परिणाम नहीं
- खाली इन्वेंटरी या कॉलर का नाम न मिलने को सामान्य परिणाम मानकर संभालें। यह न मानें कि वाक्य-रचना की दृष्टि से मान्य नंबर पर हर सेवा उपलब्ध है।
- नेटवर्क टाइमआउट या सेवा विफलता
- रीड ऑपरेशन के लिए बैकऑफ़ के साथ सीमित पुनः प्रयास करें। खरीद, भेजने या पंजीकरण के लिए पहले ऑपरेशन की स्थिति देखें; स्वीकार किए जा चुके अनुरोध को दोबारा भेजने से शुल्क वाली कार्रवाई दोहराई जा सकती है।
Idempotency सहायता हर API परिवार की अपनी होती है। Emergency API पुनः प्रयास कुंजियाँ (retry keys) समर्थित करता है; इससे कोई भी मनमाना v3 अनुरोध idempotent नहीं हो जाता। सहायता के लिए टाइमस्टैम्प, लौटाए गए ID और संवेदनशील जानकारी हटाए गए रिस्पॉन्स सुरक्षित रखें।
अपने खाते के संदर्भ के साथ आगे बढ़ें
साइन-इन किया हुआ संदर्भ आपकी अनुमतियों और सक्षम सेवाओं के अनुसार ऑपरेशन फ़िल्टर करता है। इसके सटीक होस्ट, क्रेडेंशियल प्रकार, अनुरोध फ़ील्ड और रिस्पॉन्स स्कीमा का उपयोग करें। कंसोल लाइव ऑपरेशन चला सकते हैं, जिनमें खरीदारी और संदेश भी शामिल हैं।