CNAM इंटीग्रेशन

CNAM REST API संदर्भ

HTTPS पर कॉलर नाम का अनुरोध करें और परिणाम, शुल्क तथा त्रुटियों को संभालें।

लुकअप व्यवहार चुनें

टियरप्रति क्वेरी सार्वजनिक मूल्ययह क्या करता है
Starter$0.0026स्वामित्व वाली और कैश की गई कॉलर-नाम जानकारी का उपयोग करता है।
Standard$0.0037प्रत्येक क्वेरी के लिए रीयल-टाइम नेटवर्क लुकअप करता है।
Mixed$0.004पहले रीयल-टाइम लुकअप आज़माता है, फिर कोई नाम न मिलने पर Starter डेटा पर वापस आ जाता है।

चुनी गई सेवा लुकअप का व्यवहार तय करती है; Mixed कैश-फ़र्स्ट लुकअप नहीं है। प्रोडक्शन में उपयोग से पहले अपने खाते को असाइन की गई दर की समीक्षा करें। कॉलर का नाम पहचान या स्वामित्व का प्रमाण नहीं है।

प्रमाणित लुकअप भेजें

एंडपॉइंट: GET https://api.multitel.net/v3/cnam/NUMBER। देश कोड सहित अंतरराष्ट्रीय प्रारूप वाले फ़ोन नंबर केवल अंकों में लिखें, बिना विराम चिह्न या शुरुआती प्लस के। इसे अपने एप्लिकेशन सर्वर से स्वीकृत API क्रेडेंशियल का उपयोग करके चलाएँ।

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

दोनों एनवायरनमेंट वेरिएबल सर्वर-साइड सीक्रेट कॉन्फ़िगरेशन के माध्यम से प्रदान करें। प्रोविज़न किया गया बियरर क्रेडेंशियल केवल तभी विकल्प है जब वह एक्सेस सक्षम हो और उसके स्रोत-IP प्रतिबंध पूरे किए जाएँ। API सीक्रेट को कभी भी सार्वजनिक ब्राउज़र बंडल में न डालें।

API प्रमाणीकरण और पहला-अनुरोध गाइड

JSON रिस्पॉन्स पढ़ें

यह रिस्पॉन्स उदाहरणात्मक है। लौटाया गया नाम और शुल्क लुकअप और चुनी गई सेवा पर निर्भर करते हैं।

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}
status.code
एप्लिकेशन परिणाम कोड; 200 से तुलना करने से पहले स्ट्रिंग/संख्यात्मक मानों को सामान्यीकृत करें।
status.msg
साथ में दिया गया परिणाम या अस्वीकृति संदेश।
response.number
क्वेरी किया गया नंबर।
response.name
उपलब्ध कॉलर नाम।
response.cost
इस क्वेरी के लिए रिपोर्ट किया गया शुल्क; इसे दशमलव राशि मानें।
response.balance
रिपोर्ट किया गया खाता बैलेंस, जब उपलब्ध हो।

नाम-रहित परिणाम और त्रुटियाँ

सफल अनुरोध उपयोगी कॉलर नाम की गारंटी नहीं देता। खाली नाम, नाम की जगह लौटाए गए नंबर और अस्वीकृत लुकअप को संभालें। एप्लिकेशन कोड 403 अपर्याप्त क्रेडिट, निषिद्ध खरीद या ऐसे नंबर का संकेत दे सकता है जिसका कोई परिणाम नहीं है; संदेश की जाँच करें।

response.name तक पहुँचने से पहले HTTP स्टेटस और JSON status दोनों जाँचें। त्रुटि होने पर रिस्पॉन्स ऑब्जेक्ट अनुपस्थित हो सकता है। नाम न मिलने से सामान्य कॉल के रूट होने में बाधा नहीं आनी चाहिए।

बिलिंग, पुनः प्रयास और कॉलर ID अपडेट करने से अंतर

नए लुकअप पर क्वेरी शुल्क लग सकता है। ये लुकअप इंटरफ़ेस किसी idempotency key का दस्तावेज़ीकरण नहीं करते, इसलिए नया पुनः प्रयास दूसरी बिल योग्य क्वेरी हो सकता है। ट्रांसपोर्ट/सेवा विफलताओं के लिए सीमित बैकऑफ़ का उपयोग करें, पहले खाते की त्रुटियाँ ठीक करें और रिपोर्ट किए गए क्वेरी शुल्कों का मिलान करें। कैश केवल अपने एप्लिकेशन के लिए उपयुक्त अवधि तक रखें; कॉलर-नाम डेटा बदल सकता है।

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