REST API दस्तावेज़

LRN रूटिंग लुकअप 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 इंटीग्रेशन सेटिंग्स में प्रबंधित किए जाते हैं।

किसी नंबर की लुकअप करें

GET /v3/lrn/{number} पाथ में गंतव्य नंबर स्वीकार करता है। कॉल करने वाले नंबर पर निर्भर जानकारी के लिए वह नंबर वैकल्पिक रूप से /v3/lrn/{number}/{ani} में दिया जा सकता है। उत्तर अमेरिकी फ़ोन नंबर केवल अंकों में लिखें और जहाँ लागू हो देश कोड शामिल करें; उदाहरणों में आरक्षित काल्पनिक नंबर उपयोग किए गए हैं।

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123"

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123/12025550124"

मान्य क्रेडेंशियल के साथ लुकअप चलाना शुल्क योग्य है। दर $0.00025 प्रति लुकअप है: 1,000 के लिए $0.25 या प्रति मिलियन $250। कोई वॉल्यूम छूट नहीं है। यह रूटिंग-जानकारी की लुकअप है; यह टेलीफ़ोन कॉल नहीं करती।

परिणाम पढ़ें

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": {
    "lrn": "12025550123",
    "ported": 0,
    "ocn": "",
    "lata": "",
    "rc": "",
    "cost": "$0.00025"
  }
}

यह गढ़ा हुआ उदाहरण केवल response का स्वरूप दिखाता है; यह मापा गया रूटिंग परिणाम नहीं है। response का उपयोग करने से पहले status.code जाँचें। cost फ़ील्ड मुद्रा-उपसर्ग वाली स्ट्रिंग है, JSON संख्या नहीं।

फ़ील्ड	अर्थ
`lrn`	Location Routing Number, जिसका उपयोग रूटिंग गंतव्य की पहचान के लिए होता है।
`ported`	इस लुकअप द्वारा दिया गया नंबर पोर्ट होने का संकेतक: सामान्यतः 0 या 1। इसे स्वामित्व या सेवा पात्रता के प्रमाण के रूप में उपयोग न करें।
`ocn`	Operating Company Number, जब उपलब्ध कराया गया हो।
`lata`	Local Access and Transport Area, जब उपलब्ध कराया गया हो।
`rc`	रेट सेंटर, जब उपलब्ध कराया गया हो।
`city`, `state`, `lec`, `lectype`, `jurisdiction`, `local`	उपलब्ध होने पर अतिरिक्त स्थान, कैरियर या मूल (origin) से संबंधित विवरण। ये अनुपस्थित या रिक्त हो सकते हैं।

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

अपने रूटिंग वर्कफ़्लो में लुकअप का उपयोग करें

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

LRN उत्पाद और फ़्लैट मूल्य निर्धारण देखें। सार्वजनिक OpenAPI पाथ में ANI सेगमेंट शामिल है; डिप्लॉय किया गया LRN कार्यान्वयन ANI के बिना छोटा अनुरोध भी स्वीकार करता है। lrninfo एक अलग ऑपरेशन है और इसे इस endpoint के स्थान पर उपयोग नहीं करना चाहिए।

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

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

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

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

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

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