डेवलपर

GET/v3/inventory/{number}

खरीदे गए नंबरों की सूची प्राप्त करें

खरीदे गए नंबरों का कॉन्फ़िगरेशन और संग्रहीत स्थिति पढ़ें; चाहें तो टेलीफ़ोन नंबर के आधार पर फ़िल्टर करें।

इस पृष्ठ पर
  1. अनुरोध
  2. प्रतिक्रिया
  3. फ़िल्टर करना और पृष्ठों में विभाजन
  4. कोई मेल खाने वाला नंबर नहीं
  5. अगले चरण

खरीदे गए नंबरों के उन रिकॉर्ड की सूची प्राप्त करें जिनका संग्रहीत स्वामी आपके API क्रेडेंशियल से संबद्ध खाते से मेल खाता है। किसी रिकॉर्ड का मौजूद होना, वास्तविक कॉल के सफल परीक्षण से अलग बात है।

अनुरोध

HTTPS के माध्यम से सर्वर पर रखे API क्रेडेंशियल का उपयोग करें। उदाहरण एनवायरनमेंट वेरिएबल से क्रेडेंशियल पढ़ते हैं; उनमें कोई काम करने वाले क्रेडेंशियल नहीं हैं। जाँचें status.code को JSON बॉडी में और साथ ही HTTP स्थिति को भी। ये पुराने हैंडलर एप्लिकेशन की त्रुटि होने पर हर बार HTTP त्रुटि स्थिति सेट नहीं करते।

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

किसी एक संग्रहीत टेलीफ़ोन नंबर के आधार पर फ़िल्टर करने के लिए वैकल्पिक पाथ प्रारूप का उपयोग करें:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

संग्रहीत अंतरराष्ट्रीय टेलीफ़ोन नंबर को देश कोड सहित अंकों में दें। इसके स्थान पर PBX एक्सटेंशन, नंबर का UUID, क्षेत्र की आईडी या उपसर्ग की आईडी न दें। दिया गया नंबर किसी मौजूदा रिकॉर्ड को चुनता है; इससे कोई नंबर खरीदा या कॉन्फ़िगर नहीं किया जाता।

प्रतिक्रिया

प्रतिक्रिया का response सदस्य सफल अनुरोध पर हमेशा एक ऐरे होता है, एक नंबर वाले पाथ प्रारूप में भी। status.results ऐरे की लंबाई है।

यह प्रतिक्रिया की संरचना का उदाहरण है, खाते का डेटा या मौजूदा कीमत का कोटेशन नहीं।

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}
लौटाए गए नंबर के फ़ील्ड
फ़ील्डअर्थ
number, uuid, description, isocodeसंग्रहीत टेलीफ़ोन नंबर, नंबर का ऐसा पहचानकर्ता जिससे कोई अर्थ नहीं निकाला जाना चाहिए, विवरण और देश कोड।
configसंग्रहीत वॉइस गंतव्य, बाहरी फ़ॉरवर्डिंग, SMS गंतव्य और SMS फ़ॉरवर्डिंग के फ़ील्ड। यह एंडपॉइंट इन्हें संपादित नहीं करता।
featuresवॉइस, SMS और MMS क्षमताओं के संग्रहीत फ़्लैग। पुराने संग्रहीत फ़्लैग के JSON बूलियन होने की गारंटी नहीं है।
status.capacityआवंटित और उपयोग किए गए चैनलों के मान, ओवरफ़्लो सेटिंग और सीमा से अधिक उपयोग का संग्रहीत शुल्क। यह संग्रहीत मेटाडेटा है, क्षमता का नया कोटेशन या वास्तविक कॉल का परीक्षण नहीं।
status.originationकॉल के उद्गम का संग्रहीत मेटाडेटा। पहचानकर्ताओं से कोई अर्थ न निकालें; आंतरिक नामों के आधार पर एप्लिकेशन का तर्क निर्धारित न करें।
status.service_active, force_codec, force_dtmfसक्रियण और मीडिया कॉन्फ़िगरेशन के संग्रहीत फ़ील्ड। केवल किसी फ़्लैग से यह साबित नहीं होता कि आने वाली कॉल सफलतापूर्वक पहुँच रही है।
billingCNAM, ओवरफ़्लो, नवीनीकरण, स्थायित्व और निर्माण के संग्रहीत मान। इन्हें पढ़ने से नवीनीकरण या बिलिंग की अन्य सेटिंग नहीं बदलतीं।
priceसेटअप, मासिक और प्रति मिनट की संग्रहीत कीमतें तथा मिलने वाले मिनटों की सीमा। हैंडलर मुद्रा का कोई फ़ील्ड या नया कोटेशन नहीं देता। उदाहरण के मानों से मुद्रा का अनुमान न लगाएँ और न ही उन्हें खरीदारी के मौजूदा कोटेशन के रूप में इस्तेमाल करें।

फ़िल्टर करना और पृष्ठों में विभाजन

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

कोई मेल खाने वाला नंबर नहीं

यदि खाते में कोई ऐसा मेल खाने वाला रिकॉर्ड नहीं है जिसे निरस्त न किया गया हो, तो JSON बॉडी में status.code का मान 404 होता है और संदेश में no numbers found शामिल होता है। यह सफल प्रतिक्रिया के रूप में खाली ऐरे नहीं लौटाता। संदेश के अंत में स्रोत के संदर्भ वाला एक प्रत्यय शामिल होता है, जिसे क्लाइंट को स्थिर पहचानकर्ता मानकर पार्स नहीं करना चाहिए।

अगले चरण

उपयोग करें: numberinfo — जब आपको किसी एक नंबर के लिए पुराने पंजीकरण और नंबर के संदर्भ से जुड़े अतिरिक्त फ़ील्ड चाहिए हों। किसी अलग कॉन्फ़िगरेशन कार्रवाई के माध्यम से कोई भी रूट बदलने से पहले वॉइस और मैसेजिंग गंतव्यों की जाँच करें।