वाहक की निर्देशिका के लिए प्रविष्टि जमा करें
MultiTEL में अपने स्वामित्व वाले पात्र फ़ोन नंबर की निर्देशिका प्रविष्टि में इस्तेमाल करने के लिए नाम और पता जमा करें। यह वाहक द्वारा किया जाने वाला सशुल्क अद्यतन है, कॉल करने वाले का नाम खोजना, निजी पता पुस्तिका में प्रविष्टि करना या पोर्टल के LIDB इन्वेंटरी फ़ील्ड का सामान्य अद्यतन करना नहीं।
केवल वे विवरण जमा करें जिन्हें ग्राहक ने निर्देशिका प्रविष्टि के लिए अधिकृत किया है। इस पुराने रूट का उपयोग करने से पहले पुष्टि करें कि वाहक उस नंबर का समर्थन करता है। समीक्षा किया गया हैंडलर प्रदाता की पात्रता या अंतरराष्ट्रीय नंबर प्रारूप की जाँच नहीं करता; वाहक को भेजे जाने वाले उसके अनुरोध में नंबर को उत्तर अमेरिकी माना जाता है और संग्रहित नंबर का पहला अंक हटा दिया जाता है।
खाते और नंबर से जुड़ी आवश्यकताएँ
अनुमत स्रोत IP पते से HTTPS के माध्यम से सक्षम API खाते का उपयोग करें। ठीक वही नंबर उस खाते के खरीदे गए नंबरों के रिकॉर्ड में होना चाहिए और उसका रिकॉर्ड निरस्त नहीं होना चाहिए। अपनी इन्वेंटरी में मौजूद पूरे अंतरराष्ट्रीय अंकों का उपयोग करें, जैसे समर्थित उत्तर अमेरिकी नंबर के लिए देश कोड 1 वाला प्रारूप। मूल्य योजना की पहचान, नंबर का UUID या किसी दूसरे खाते का नंबर इस्तेमाल न करें।
फ़ॉर्म POST अनुरोध
इसका मान सेट करें: NUMBER को अपने स्वामित्व वाले नंबर पर सेट करें। काल्पनिक उदाहरण की जगह अधिकृत निर्देशिका विवरण भरें। यह रूट POST से फ़ॉर्म फ़ील्ड पढ़ता है; यह application/json अनुरोध बॉडी को पार्स नहीं करता।
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--data-urlencode "lastname=EXAMPLE" \
--data-urlencode "firstname=EXAMPLE" \
--data-urlencode "streetnum=1" \
--data-urlencode "streetname=Example" \
--data-urlencode "streetpredir=N" \
--data-urlencode "streetpostdir=W" \
--data-urlencode "city=Example City" \
--data-urlencode "state=NY" \
--data-urlencode "postalcode=10001" \
"https://api.multitel.net/v3/directory/$NUMBER"| फ़ील्ड | इस API में अनिवार्य | अर्थ |
|---|---|---|
| lastname | हाँ | प्रविष्टि में उपनाम या प्रविष्टि के नाम का लागू फ़ील्ड। |
| city | हाँ | प्रविष्टि में शहर। |
| postalcode | हाँ | प्रविष्टि में डाक कोड। |
| state | हाँ | प्रविष्टि में राज्य या क्षेत्र, जिसे समर्थित वाहक स्वीकार करता हो। |
| streetname | हाँ | सड़क का नाम। |
| streetnum | हाँ | सड़क के पते में भवन संख्या। |
| firstname | नहीं | व्यक्तिगत नाम का अतिरिक्त भाग। |
| streetpredir, streetpostdir | नहीं | जहाँ लागू हो, सड़क के नाम से पहले और बाद में आने वाले दिशा सूचक भाग। |
| streettype, location | नहीं | जहाँ लागू हो, सड़क का प्रकार या स्थान का अतिरिक्त विवरण। |
उदाहरण में दी गई दिशाएँ और पता केवल नमूने हैं, सुझाया गया डाक पता नहीं। ग्राहक के वास्तविक डेटा में काल्पनिक दिशा न जोड़ें। API में अनिवार्य फ़ील्ड की जाँच सतही है: इससे यह सिद्ध नहीं होता कि पता मान्य है या वाहक उसे स्वीकार करता है। पुराने वेबसाइट फ़ॉर्म की आवश्यकताएँ भी अलग थीं।
यदि कोई वैकल्पिक दिशा सूचक भाग मौजूद न हो या खाली हो, तो मौजूदा कार्यान्वयन ऐरे की कुंजी गायब होने की चेतावनी दे सकता है। यदि प्रतिक्रिया का प्रारूप गलत हो या वाहक पता अस्वीकार कर दे, तो अनुरोध का संदर्भ सुरक्षित रखें और सहायता टीम से प्रविष्टि की पुष्टि करवाएँ; अनुमान से पता बदलकर बार-बार जमा न करें।
शुल्क और दोबारा प्रयास करने का व्यवहार
समीक्षा किया गया हैंडलर कम-से-कम 10.00 शेष राशि इकाइयों की उपलब्ध शेष राशि की जाँच करने के बाद ही वाहक से संपर्क करता है। वाहक और स्थानीय नंबर अद्यतन, दोनों के सफल होने की सूचना मिलने के बाद यह 10.00 खाते की शेष राशि से काटता है और निर्देशिका स्थापना का लेनदेन दर्ज करता है। ये वर्तमान कार्यान्वयन में लागू राशियाँ हैं, किसी नई मूल्य योजना का प्रस्ताव नहीं; जमा करने से पहले अपने खाते की शर्तों के अनुसार लागू बिलिंग मुद्रा और समर्थित सेवा की पुष्टि करें।
इस प्रक्रिया में इडेम्पोटेंसी कुंजी, दोहरे ऑर्डर को रोकने की व्यवस्था या वाहक को अनुरोध भेजने, स्थानीय अद्यतन और बिलिंग को एक साथ बाँधने वाला लेनदेन नहीं है। दोहराया गया अनुरोध सफल होने पर वाहक को फिर से अनुरोध भेजा जा सकता है और फिर से शुल्क लग सकता है। समय सीमा समाप्त होने या API त्रुटि मिलने से यह सिद्ध नहीं होता कि वाहक ने पिछला अनुरोध अस्वीकार कर दिया था: स्थानीय अद्यतन विफल होने से पहले प्रदाता उसे स्वीकार कर चुका हो सकता है।
प्रतिक्रिया
{
"status": {
"code": 200,
"msg": "Success"
},
"response": ""
}सामान्य सफल प्रतिक्रिया में खाली स्ट्रिंग वाला फ़ील्ड होता है: response और इसमें प्रविष्टि की पहचान या कार्य पूरा होने का विवरण नहीं लौटाया जाता। इसका अर्थ है कि वाहक और स्थानीय अद्यतन प्रक्रियाओं ने सफलता की सूचना दी; इससे हर बाहरी निर्देशिका में प्रकाशन, तुरंत प्रसार या भविष्य में कॉलर पहचान दिखने की पुष्टि नहीं होती।
पुरानी प्रणाली की त्रुटियाँ
| API कोड | अर्थ |
|---|---|
| 404 | खाते में नंबर नहीं मिला, या फ़ॉर्म का कोई अनिवार्य फ़ील्ड खाली था। |
| 400 | खाते की शेष राशि लागू शुल्क से कम है। |
| 500 | वाहक को भेजा गया अनुरोध विफल हुआ, या स्थानीय अद्यतन उस समय विफल हुआ जब वाहक अनुरोध पहले ही स्वीकार कर चुका हो सकता था। |
| 200 | सफलता की सूचना मिली; प्रतिक्रिया में प्रकाशन की पुष्टि नहीं है। |
HTTP स्थिति और JSON के ये दोनों मान पढ़ें: status.code/status.msg। प्रमाणीकरण और स्रोत IP संबंधी प्रतिबंध भी उपयोग योग्य प्रतिक्रिया मिलने से रोक सकते हैं। केवल इसलिए अद्यतन का अनुरोध करने के लिए GET या क्वेरी पैरामीटर का उपयोग न करें कि पुराने हैंडलर में HTTP विधि की स्पष्ट जाँच नहीं है।
दोबारा प्रयास करने से पहले सत्यापित करें
- अनुरोध भेजने से पहले नंबर पर अपने स्वामित्व, वाहक की पात्रता, अधिकृत निर्देशिका विवरण और शुल्क की पुष्टि करें।
- एक बार जमा करें और खाते की ओर मिला परिणाम सुरक्षित रखें; ग्राहक का पता सार्वजनिक लॉग या विश्लेषण डेटा में उजागर न करें।
- समर्थित खाता प्रक्रिया या सहायता टीम के माध्यम से सहेजी गई प्रविष्टि और लेनदेन इतिहास जाँचें। वाहक द्वारा पुष्टि किए गए प्रसंस्करण समय तक प्रतीक्षा करें; यह API प्रसार की कोई गारंटीकृत समय सीमा निर्धारित नहीं करता।
- परिणाम अनिश्चित होने पर दोबारा प्रयास करने से पहले सहायता टीम से वाहक के ऑर्डर और स्थानीय बिलिंग का मिलान करवाएँ। अनुरोध दोहराना ऐसी स्थिति जाँच नहीं है जिसे दोहराने पर कोई अतिरिक्त प्रभाव न पड़े।