किसी क्षेत्र के प्रीफ़िक्स की सूची पाएँ

शुरू करने से पहले

क्षेत्र चुनने के लिए getareas का उपयोग करें। क्षेत्र का ID इसके उत्तर या लौटाए गए next_function से कॉपी करें। अमेरिका या कनाडा के किसी क्षेत्र के लिए getstates का उपयोग करें, यदि आप परिणामों को किसी एक राज्य या प्रांत तक सीमित करना चाहते हैं।

परिणाम समझें

जाँचें: status.code का मान JSON बॉडी में देखें और HTTP स्थिति भी जाँचें। सफल परिणाम response ऐरे में होते हैं। डिफ़ॉल्ट उत्तर नाम के अनुसार क्रमबद्ध होता है। available एक अनुमान है, और कैटलॉग फ़्लैग देखने के बावजूद चुने गए नंबर की वास्तविक क्षमताओं और पंजीकरण आवश्यकताओं की जाँच करना ज़रूरी है।

अगला चरण चुनें

बिना समूहीकरण वाला परिणाम उपयोग करें। जब returns_numbers का मान 1 हो, तो लौटाया गया next_function नंबर खोजने की प्रक्रिया की ओर संकेत करता है। जब इसका मान 0 हो, तो नंबर ऑर्डर करते समय आवंटित होते हैं और पथ ऑर्डर करने की कार्रवाई की ओर संकेत करता है। अनुरोध भेजने से पहले उस कार्रवाई और उसकी आवश्यकताओं की जाँच करें: ऑर्डर के अनुरोध से आपके खाते पर शुल्क लग सकता है। लौटाए गए हर पथ पर अपने-आप अनुरोध न भेजें।

यहाँ कोई कीमत शामिल नहीं है। खरीदने से पहले संबंधित मूल्य प्रस्ताव, आवश्यक दस्तावेज़ों और ऑर्डर करने के निर्देशों की समीक्षा करें। लौटाए गए अलग-अलग प्रीफ़िक्स और मूल्य प्रस्ताव के ID सुरक्षित रखें; इन्हें दिखाए गए टेलीफ़ोन प्रीफ़िक्स से स्वयं न बनाएँ।

प्रदर्शन के उन्नत विकल्प

compact=1 अधिकतम 100 पंक्तियों का नमूना बेतरतीब क्रम में लौटाता है, किसी बड़े परिणाम समूह का एक पृष्ठ नहीं। समूहीकरण से सारांश पंक्तियाँ और कृत्रिम ID बनते हैं; किसी एक प्रीफ़िक्स को चुनने के लिए सामान्य, बिना समूहीकरण वाला उत्तर उपयोग करें। नमूने या समूहीकृत परिणामों के आधार पर पूरी उपलब्ध सूची या सटीक क्षमताओं का दावा न करें।

अनुरोध

HTTPS पर अपने सक्रिय API खाते के क्रेडेंशियल का उपयोग करें। Basic प्रमाणीकरण और API खाते के सक्रिय bearer टोकन समर्थित हैं; खाते के प्रतिबंध लागू होते हैं।

GET का उपयोग करें और वैकल्पिक पैरामीटर क्वेरी स्ट्रिंग में भेजें। वैकल्पिक व्यवस्था के रूप में फ़ॉर्म बॉडी से पैरामीटर लिए जाने पर निर्भर न रहें।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

उत्तर

मानक status/response JSON आवरण। status.results लौटाई गई पंक्तियों की संख्या बताता है, नमूना लेने या समूहीकरण की स्थिति में भी। response में प्रीफ़िक्स ऑब्जेक्ट होते हैं। कीमत का कोई फ़ील्ड नहीं लौटाया जाता। सामान्य, बिना समूहीकरण वाले उत्तर में uuid प्रीफ़िक्स का ID है; area_uuid और country_uuid लौटाए गए पहचानकर्ता हैं; prefix और name प्रदर्शन के लिए जानकारी हैं; available उपलब्धता का अनुमान है, आरक्षण नहीं; needs_registration और restrictions पंजीकरण संबंधी जानकारी देते हैं; sms_coverage, is_mobile और number_type कैटलॉग के संकेत हैं, किसी विशेष नंबर की क्षमता की गारंटी नहीं। number_type खाली हो सकता है या कैटलॉग की कोई अन्य स्ट्रिंग हो सकती है, इसलिए किसी निश्चित एनम की अनिवार्यता न रखें। state एक स्ट्रिंग है और खाली हो सकती है या उसमें कैटलॉग का स्वरूपण हो सकता है। latitude और longitude खाली हो सकते हैं। metered और overflow कैटलॉग फ़्लैग हैं, धनराशियाँ नहीं। returns_numbers नंबरों की सूची पाने का मार्ग (1) या ऑर्डर करते समय नंबर आवंटित करने का मार्ग (0) चुनता है। next_function उस अगले मार्ग की पहचान करता है। समूहीकृत उत्तरों में अतिरिक्त रूप से मिलाई गई विशेषताएँ होती हैं, जिनमें वैकल्पिक रूप से इस्तेमाल किए गए विशेषता मान भी शामिल हैं; इन्हें हर नंबर की सत्यापित क्षमताएँ न मानें।

उत्तर की संरचना का उदाहरण; यह खाते का वास्तविक समय का डेटा या वर्तमान मूल्य प्रस्ताव नहीं है।

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

त्रुटियाँ

• 404: Invalid area ID: जानकारी खोजने की प्रक्रिया से क्षेत्र का वर्तमान ID प्राप्त करें।
• 404: State filter is only available for US and CA: अन्य देशों के लिए state न भेजें।
• 404: Invalid state: इस देश के लिए getstates द्वारा लौटाए गए राज्य या प्रांत का उपयोग करें।
• 404: No prefixes found: कैटलॉग की कोई मेल खाती पंक्ति नहीं लौटाई गई। इससे यह सिद्ध नहीं होता कि किसी विशेष नंबर का ऑर्डर कभी नहीं दिया जा सकता।
• 500: त्रुटि: 'Failed loading prefixes': कैटलॉग में खोज विफल रही। बाद में फिर प्रयास करें और समस्या बनी रहे तो सहायता टीम से संपर्क करें।

उपलब्धता और अतिरिक्त प्रभाव

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