डेवलपर

GET/v3/getcountries

स्टॉक में नंबर उपलब्ध वाले देशों की सूची पाएँ

वे दिखाई देने वाले देश लौटाता है जिनके कम से कम एक नंबर प्रीफ़िक्स के अंतर्गत अभी नंबर स्टॉक में हैं। प्रत्येक प्रविष्टि में कॉलिंग कोड, ISO कोड, देश स्तर के मोबाइल और SMS संकेतक, निर्देशांक और उस देश के कवरेज क्षेत्रों के लिए एक next_function लिंक शामिल होता है।

इस पृष्ठ पर
  1. अनुरोध
  2. प्रतिक्रिया
  3. त्रुटियाँ
  4. उपलब्धता और अन्य प्रभाव

स्थानीय नंबरों की खोज यहाँ से शुरू करें। सूची में केवल वे देश शामिल हैं जिनके नंबर अभी स्टॉक में हैं। इससे कुछ भी आरक्षित नहीं होता।

  • भेजें: isocode को getareas, getstates (केवल US और CA) या other पर।
  • next_function हमेशा इस पथ की ओर संकेत करता है: v3/getareas/{isocode}। संयुक्त राज्य अमेरिका और कनाडा के लिए, राज्य या प्रांत के अनुसार दायरा सीमित करने हेतु आप getstates को पहले कॉल कर सकते हैं।
  • is_mobile और sms_coverage देश स्तर के संकेतक हैं, हर नंबर के लिए गारंटी नहीं। संयुक्त राज्य अमेरिका के लिए, is_mobile का मान 0 होता है, जब तक कि आपके खाते में अमेरिकी मोबाइल नंबरों की सुविधा सक्षम न हो।
  • जिन देशों का कवरेज केवल ऑर्डर पर उपलब्ध है, वे सूची में शामिल नहीं होते। सूची में शामिल न होने वाले देश के लिए भी आप getareas या other को सीधे कॉल कर सकते हैं।
  • यदि आपको किसी विशेष क्रम की आवश्यकता है, तो सूची को स्वयं क्रमबद्ध करें।

यदि कोई देश शर्तें पूरी नहीं करता, तो response का मान null होता है और status.code का मान 200 होता है।

अनुरोध

आवश्यक: HTTP Basic या Bearer टोकन (प्रमाणीकरण और API प्रतिक्रियाएँ देखें)। प्रमाणीकरण विफल होने पर, खोज चलने से पहले HTTP 401 के साथ उत्तर दिया जाता है।

बिना अनुरोध बॉडी के GET। एकमात्र पैरामीटर वैकल्पिक pid है, जिसे क्वेरी स्ट्रिंग में भेजा जाता है।

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
क्वेरी पैरामीटर
नामप्रकारआवश्यकविवरण
pidstringनहींउन्नत और वैकल्पिक। सूची को एक इन्वेंटरी स्रोत के लिए चिह्नित देशों तक सीमित करता है। केवल MultiTEL द्वारा दिया गया मान संख्यात्मक रूप में या 32 वर्णों वाले हेक्साडेसिमल रूप में इस्तेमाल करें, और सामान्य उपयोग के लिए इसे छोड़ दें। pid प्रतिक्रिया में वर्णित स्टॉक की जाँच का दायरा सीमित नहीं करता। अपरिचित मानों, शून्य और इस एंडपॉइंट द्वारा स्वीकार न किए जाने वाले मानों को बिना किसी त्रुटि के अनदेखा किया जाता है; तब सूची में सभी समर्थित स्रोत शामिल होते हैं।

प्रतिक्रिया

मानक आवरण संरचना। सफल होने पर, status.code का मान 200, status.msg का मान 'Results: N', status.results का मान N होता है, और response देशों की एक सूची होती है जिसके क्रम की कोई गारंटी नहीं होती। फ़ील्ड: countrycode ('+' के बिना देश का कॉलिंग कोड); name (देश का नाम); description (name के समान मान); isocode (ISO 3166-1 alpha-2 कोड); is_mobile (0 या 1, देश स्तर का कैटलॉग संकेतक, US के लिए हमेशा 0, जब तक कि आपके खाते में US के मोबाइल नंबरों की सुविधा सक्षम न हो); sms_coverage (0 या 1, देश स्तर का कैटलॉग संकेतक); latitude और longitude (देश के निर्देशांक); next_function ('v3/getareas/{isocode}')। कोई देश तभी सूची में शामिल होता है जब वह दिखाई देने वाला हो और उसके कम से कम एक प्रीफ़िक्स के अंतर्गत किसी भी इन्वेंटरी स्रोत में अभी नंबर स्टॉक में हों। जिन देशों का कवरेज पूरी तरह केवल ऑर्डर पर उपलब्ध है (स्टॉक नहीं है), वे सूची में शामिल नहीं होते। स्टॉक की इस जाँच का दायरा getareas द्वारा लागू फ़िल्टरों से अधिक व्यापक है, इसलिए सूची में शामिल किसी देश के लिए वहाँ कभी-कभी 'No areas found' लौट सकता है। यदि कोई देश शर्तें पूरी नहीं करता, तो status.code का मान 200 और status.msg का मान 'Results: 0' होता है, status.results फ़ील्ड मौजूद नहीं होता, और response का मान null होता है।

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

त्रुटियाँ

  • 401: प्रमाणीकरण अनुपस्थित है या विफल हुआ है। HTTP स्थिति 401 के साथ भेजा जाता है (प्रमाणीकरण और API प्रतिक्रियाएँ देखें)।

उपलब्धता और अन्य प्रभाव

  • केवल जानकारी खोजता है। इससे कुछ भी आरक्षित या ऑर्डर नहीं होता और कोई बदलाव नहीं किया जाता।
  • परिणाम अनुरोध के समय के स्टॉक को दर्शाते हैं और कॉलों के बीच बदल सकते हैं।