डेवलपर

POST/v3/get_requirements

पंजीकरण की आवश्यकताएँ पढ़ें

किसी देश और नंबर के प्रकार के नाम के लिए वर्तमान में लौटाई जाने वाली पंजीकरण आवश्यकताएँ प्राप्त करें।

इस पृष्ठ पर
  1. देश और नंबर का प्रकार चुनें
  2. लौटाए गए निर्देश पढ़ें
  3. किसी त्रुटि को छूट न समझें
  4. अनुरोध
  5. प्रतिक्रिया
  6. त्रुटियाँ
  7. उपलब्धता और अन्य प्रभाव

देश और नंबर का प्रकार चुनें

पंजीकरण का देश चुनें, फिर इस फ़ंक्शन से लौटाया गया नाम इस्तेमाल करें: get_document_number_types। उस नाम को number_type के रूप में भेजें, प्रकार की आईडी या नंबर खोजने की कोई सामान्य श्रेणी नहीं।

लौटाए गए निर्देश पढ़ें

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

किसी त्रुटि को छूट न समझें

अमान्य देश या देश के लिए पंजीकरण दस्तावेज़ों की आवश्यकता न होने से संबंधित त्रुटि दो स्थितियों को एक साथ व्यक्त करती है। यह इस बात का प्रमाण नहीं है कि पंजीकरण आवश्यक नहीं है। जानकारी खोजने में विफलता या खाली परिणाम भी किसी ग्राहक या नंबर को स्वीकृति नहीं देता। परिणाम स्पष्ट न हो तो सहायता टीम से संपर्क करें।

अनुरोध

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

application/json या application/x-www-form-urlencoded के साथ POST अनुरोध भेजें।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
अनुरोध बॉडी के पैरामीटर
नामप्रकारअनिवार्यविवरण
countryस्ट्रिंगहाँget_document_countries से प्राप्त देश का ISO कोड।
number_typeस्ट्रिंगहाँget_document_number_types से प्राप्त प्रकार का नाम, जैसे Local; मिलान में बड़े और छोटे अक्षरों का अंतर नहीं माना जाता। नाम दें, उसकी आईडी नहीं।

प्रतिक्रिया

HTTP स्थिति के साथ-साथ JSON बॉडी में status.code भी जाँचें। response आवश्यकताओं का एकल संसाधन है, जिसमें id, type और attributes होते हैं, और यदि लौटाए गए हों तो relationships भी होते हैं। संसाधन और संबंध डेटा में मौजूद आईडी से उनके आंतरिक अर्थ का अनुमान नहीं लगाया जा सकता। वैकल्पिक restriction_message पाठ से HTML टैग हटा दिए जाते हैं; बचे हुए पाठ को सामान्य पाठ मानकर संभालें, विश्वसनीय HTML मानकर नहीं। हैंडलर आवश्यकताओं का पहला संसाधन लौटाता है, इसलिए यह न मानें कि यह प्रतिक्रिया पूरी सूची है। विशेषताओं और संबंधों की उपलब्धता देश और प्रकार पर निर्भर करती है; उदाहरण कोई पूर्ण, निश्चित स्कीमा नहीं है।

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

त्रुटियाँ

  • 400: देश और number_type का सत्यापन विफल हुआ: दोनों अनिवार्य मान दें। सत्यापन के पाठ में फ़ॉर्मैटिंग हो सकती है।
  • 400: Invalid country ISO or No country registration documents required.: यह अस्पष्ट संदेश अपने आप में पंजीकरण से छूट का प्रमाण नहीं है।
  • 400: Invalid number type: लौटाए गए प्रकार के नाम का उपयोग करें। पुराने त्रुटि संदेश में Global, Local, Mobile, National, Shared Cost और Toll Free सूचीबद्ध हैं।
  • 500: Unable to load registration requirements for the specified country and number type.: आवश्यकताएँ सफलतापूर्वक नहीं लौटाई गईं। बाद में फिर प्रयास करें या सहायता टीम से संपर्क करें।

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

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