डेवलपर

GET/v3/get_document_number_types/{country}

पंजीकरण के लिए नंबरों के प्रकारों की सूची देखें

किसी देश के पंजीकरण कैटलॉग में वर्तमान में मौजूद नंबरों के प्रकारों के नाम खोजें।

इस पृष्ठ पर
  1. लौटाए गए नाम के आधार पर प्रकार चुनें
  2. समूहों की गिनती उपलब्ध नंबरों की संख्या नहीं है
  3. अनुरोध
  4. प्रतिक्रिया
  5. त्रुटियाँ
  6. उपलब्धता और अन्य प्रभाव

लौटाए गए नाम के आधार पर प्रकार चुनें

देश चुनने के लिए इस कैटलॉग का उपयोग करें: get_document_countries। लौटाए गए प्रकार का नाम इस फ़ंक्शन को दें: get_requirements। प्रकार के कैटलॉग की आईडी, प्रीफ़िक्स की आईडी, नंबर की आईडी या प्रमाण की श्रेणी की आईडी नहीं है।

समूहों की गिनती उपलब्ध नंबरों की संख्या नहीं है

available_groups इस कैटलॉग खोज से लौटाए गए समूह रिकॉर्ड की गिनती बताता है। यह खरीदे जा सकने वाले फ़ोन नंबरों की गिनती नहीं करता, स्टॉक आरक्षित नहीं करता और न ही यह गारंटी देता है कि कैटलॉग ने मूल डेटा स्रोत के सभी पृष्ठों की जाँच कर ली है। संबंधित उपलब्ध नंबरों में खोज करें और अलग से मूल्य प्रस्ताव की समीक्षा करें।

अनुरोध

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

GET अनुरोध में कोई भी प्रलेखित पैरामीटर URL पथ में दें।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
पथ पैरामीटर
नामप्रकारअनिवार्यविवरण
countrystringहाँपंजीकरण के लिए देशों के कैटलॉग से देश का दो अक्षरों वाला ISO कोड। इसके आरंभ और अंत के रिक्त स्थान हटाए जाते हैं और अक्षरों को बड़े अंग्रेज़ी अक्षरों में बदला जाता है।

प्रतिक्रिया

JSON बॉडी में status.code के साथ-साथ HTTP स्थिति भी जाँचें। response एक ऐरे है जिसमें id, name और available_groups होते हैं। name को number_type के रूप में इस्तेमाल करें जब आप get_requirements को कॉल करें; इसके स्थान पर id न भेजें। available_groups उस प्रकार के लिए लौटाए गए समूह रिकॉर्ड की संख्या है, टेलीफ़ोन नंबरों के स्टॉक की गिनती या सभी पृष्ठों का पूरा योग नहीं। जिन प्रकारों के लिए कोई समूह नहीं लौटाया जाता, उन्हें शामिल नहीं किया जाता। वरीयता क्रम Local, Mobile, National, Toll Free, Shared Cost, Global है, जिनके बाद कैटलॉग के अन्य नाम आते हैं।

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

त्रुटियाँ

  • 400: country is required: पंजीकरण के लिए देश का ISO कोड दें।
  • 400: Invalid country ISO or no available DID registration country found: वर्तमान पंजीकरण कैटलॉग से कोई देश चुनें; इससे यह सिद्ध नहीं होता कि किसी दस्तावेज़ की आवश्यकता नहीं है।

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

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