किसी देश के विशेष नंबर प्रकारों और कीमतों की सूची प्राप्त करें

स्थानीय नंबर खोजने के लिए उपयोग करें: getcountries और getareas। राष्ट्रीय, टोल-फ़्री, साझा लागत वाले, वैश्विक और मोबाइल नंबरों के लिए कॉल करें: other — देश के ISO कोड के साथ।

• समूह एक निश्चित क्रम में दिखाई देते हैं, और जिन समूहों में कोई प्रविष्टि नहीं होती, उन्हें छोड़ दिया जाता है।
• हर प्रविष्टि में आपके खाते की मूल्य योजनाएँ इस फ़ील्ड में दी जाती हैं: prices। योजना चुनते समय उसके इन फ़ील्डों को ध्यान में रखें: channels, monthly_price, setup_price, per_minute और free_minutes। साथ ही, उसका यह पहचानकर्ता सँभालकर रखें: price_id — ऑर्डर देने के लिए, जहाँ संबंधित एंडपॉइंट इसकी माँग करे।
• यदि needs_registration का मान सत्य माना जाता है, तो यह पढ़ें: restrictions — ऑर्डर देने से पहले। उस पाठ को प्रदर्शन के लिए अविश्वसनीय सामग्री मानें।
• इस फ़ील्ड में दिए गए मार्ग का अनुसरण करें: next_function: v3/getnumbers/{uuid} से आप कोई विशिष्ट नंबर चुन सकते हैं, और v3/order/{uuid} सीधे उस प्रविष्टि से ऑर्डर देता है।
• खाली response सूची और कोड 200 का अर्थ है कि अनुरोध के समय कोई विशेष नंबर प्रकार नहीं मिला। यदि नंबर सूची तक अस्थायी रूप से पहुँचना संभव नहीं था, तो जवाब अधूरा हो सकता है या मान्य JSON नहीं हो सकता, इसलिए बाद में फिर प्रयास करें।
• नंबर सूची से बाहर के देशों के लिए यह कोड लौटाया जाता है: 404 — इसके अनुरूप HTTP स्टेटस के बिना। हमेशा यह जाँचें: status.code।

अनुरोध

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

GET अनुरोध करें, जिसमें पथ में isocode हो। यदि पथ का वह खंड छोड़ दिया जाता है, तो उसकी जगह फ़ॉर्म-एन्कोडेड isocode फ़ील्ड पढ़ा जाता है।

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

जवाब

मानक बाहरी संरचना। सफलता मिलने पर status.code का मान 200 होता है, status.msg खाली होता है, और status.results समूहों की संख्या होती है। response समूहों की एक सूची है। समूह के फ़ील्ड: group_key (सामान्यीकृत प्रकार कुंजी: national, tollfree, sharedcost, global, mobile, या छोटे अक्षरों और अंकों वाली कोई अन्य कुंजी); group_name (दिखाया जाने वाला नाम); group_type_uuid (प्रकार का अपारदर्शी पहचानकर्ता); items। समूहों का क्रम national, tollfree, sharedcost, global, mobile होता है, और फिर अन्य कुंजियाँ group_name के अनुसार आती हैं। जिन समूहों में items नहीं होते, उन्हें छोड़ दिया जाता है; स्थानीय प्रकार को भी छोड़ दिया जाता है। US के लिए मोबाइल समूह छोड़ दिया जाता है, जब तक कि आपके खाते में US के मोबाइल नंबरों की सुविधा सक्षम न हो। प्रविष्टियाँ पहले name के अनुसार (बड़े और छोटे अक्षरों में भेद किए बिना), फिर prefix के अनुसार क्रमबद्ध की जाती हैं। प्रविष्टि के फ़ील्ड: uuid (प्रविष्टि का अपारदर्शी पहचानकर्ता, जिसका उपयोग next_function में होता है); area_uuid (नंबर सूची के समूह का अपारदर्शी पहचानकर्ता); country_uuid (देश का अपारदर्शी पहचानकर्ता); prefix ('+' और देश के कॉलिंग कोड से शुरू होने वाला पूरा उपसर्ग); name (नंबर सूची में दिया गया नाम; उद्धरण चिह्न बैकस्लैश से एस्केप किए हुए दिखाई दे सकते हैं); metered, overflow और needs_registration (ऐसे फ़्लैग जिनका प्रकार boolean या number हो सकता है; सत्य माने जाने वाले किसी भी मान को हाँ मानें); restrictions (पंजीकरण की आवश्यकता न होने पर खाली, अन्यथा आवश्यकताओं का पाठ, जिसमें HTML पंक्ति विराम और एक लिंक, आगे-पीछे उद्धरण चिह्न तथा एस्केप किए गए वर्ण शामिल हो सकते हैं; इसे प्रदर्शन के लिए अविश्वसनीय पाठ मानें); state (US, CA और PR के लिए राज्य का कोड, या कोई राज्य ज्ञात न होने पर खाली सूची; अन्य देशों के लिए देश का ISO कोड); country_iso; is_mobile (मोबाइल समूह में 1, अन्यथा 0); number_type (group_key के समान); available (प्रविष्टि के लिए नंबर सूची द्वारा बताई गई integer प्रकार की संख्या, न बताए जाने पर 0); sms_coverage (1 यदि किसी सुविधा में SMS या MMS का उल्लेख हो); returns_numbers (1 जब विशिष्ट नंबरों की सूची प्राप्त की जा सकती हो); next_function ('v3/getnumbers/{uuid}' जब returns_numbers का मान 1 हो, अन्यथा 'v3/order/{uuid}'); prices; features (क्षमताओं का वर्णन करने वाली स्ट्रिंगों की सूची); group_key; group_type_uuid। हर prices प्रविष्टि में price_id (योजना का अपारदर्शी पहचानकर्ता), is_customer_custom (true जब आपके खाते के लिए अनुकूलित मूल्य लागू हों; केवल उन योजनाओं के लिए जिनमें चैनल शामिल नहीं हैं), per_minute और free_minutes (दशमलव मान वाली स्ट्रिंगें), setup_price और monthly_price (दशमलव के बाद दो अंकों वाली स्ट्रिंगें), तथा channels (शामिल चैनलों की integer प्रकार की संख्या) होते हैं। जिन प्रविष्टियों में कोई मूल्य योजना नहीं होती, उन्हें छोड़ दिया जाता है। प्रत्येक अनुरोध में हर नंबर प्रकार की अधिकतम 1000 सूची प्रविष्टियों पर विचार किया जाता है। यदि किसी भी प्रकार में प्रविष्टियाँ नहीं हैं, तो response एक खाली सूची होती है और status.results का मान 0 होता है। यदि नंबर सूची में लाइव खोज विफल हो जाती है, तो जवाब इस बाहरी संरचना का उपयोग न करे, या उसमें कुछ समूह गायब हों, ऐसा हो सकता है।

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

त्रुटियाँ

• 500: msg 'ISO Code parameter is required': isocode मौजूद नहीं है या खाली है। यह अनुरोध की ऐसी त्रुटि है जिसे सुधारा जा सकता है। इसके अनुरूप HTTP स्टेटस सेट नहीं किया जाता।
• 404: msg 'Error: no such country': देश अज्ञात है या विशेष नंबरों की सूची से जुड़ा नहीं है। इसके अनुरूप HTTP स्टेटस सेट नहीं किया जाता।
• 401: प्रमाणीकरण मौजूद नहीं है या विफल हो गया है। HTTP स्टेटस 401 के साथ भेजा जाता है।

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

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