REST API दस्तावेज़

खाता और बिलिंग REST API

आपके स्वीकृत इंटीग्रेशन के लिए उपलब्ध बैलेंस और बिलिंग जानकारी पढ़ें।

खाता-विशिष्ट संदर्भ खोलें डेवलपर और ऑटोमेशन

API और क्रेडेंशियल साथ में चुनें

डेवलपर और ऑटोमेशन, व्यवसाय और संचार प्रदाता श्रेणियों के स्वीकृत खाते सक्षम सेवाओं को इंटीग्रेट कर सकते हैं। किसी व्यक्तिगत डेवलपर को कंपनी होने का दिखावा करने की आवश्यकता नहीं है। एप्लिकेशन SMS/MMS के लिए लागू भेजने की स्वीकृति और पंजीकरण आवश्यक है। व्यक्तियों और परिवारों के लिए सेवा में ग्राहकों को संदेश भेजना शुरू करने वाला कोई API उपलब्ध नहीं है।

API परिवार	बेस URL	प्रमाणीकरण और परिणाम
Communications v3	`https://api.multitel.net/v3`	स्वीकृत Basic क्रेडेंशियल; योग्य प्रोविज़न किए गए टोकन केवल उन ऑपरेशनों के लिए जो उन्हें समर्थित करते हैं। JSON `status` और `response`।
आपातकालीन कॉलिंग के लिए पंजीकरण	`https://api.multi.tel/emergency`	स्वीकृत Basic क्रेडेंशियल या विशेष रूप से प्रोविज़न की गई bearer एक्सेस। JSON `code`, `message` और `data`।
पोर्टल REST इंटीग्रेशन	होस्ट और ऑपरेशन वही जो आपके खाते के डेवलपर संदर्भ में दिखाया गया है	उस ऑपरेशन के लिए दस्तावेज़ में बताए गए क्रेडेंशियल, स्कोप और स्कीमा का उपयोग करें। ब्राउज़र सेशन अनुरोध एक अलग इंटरफ़ेस का हिस्सा हैं।

उदाहरणों का उपयोग करने से पहले अपने सर्वर की सीक्रेट कॉन्फ़िगरेशन के माध्यम से MULTITEL_API_USERNAME और MULTITEL_API_PASSWORD सेट करें। इन्हें सार्वजनिक ब्राउज़र JavaScript, URL या सोर्स कंट्रोल में कभी न डालें। समर्पित क्रेडेंशियल API इंटीग्रेशन सेटिंग्स में प्रबंधित किए जाते हैं।

पहला अनुरोध: अपना बैलेंस पढ़ें

यह रीड कोई सेवा नहीं खरीदता और न ही कोई कॉल या संदेश शुरू करता है।

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

communications v3 API अपना एप्लिकेशन परिणाम JSON बॉडी के भीतर लौटाता है। response पढ़ने से पहले HTTP स्टेटस और status.code जाँचें; अस्वीकृत अनुरोध में response ऑब्जेक्ट नहीं हो सकता। कोड मान स्ट्रिंग या संख्या हो सकते हैं।

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "25.0000",
    "currency": "USD",
    "terms": "Prepaid"
  }
}

यह एक काल्पनिक उदाहरण है, किसी खाते का वास्तविक बैलेंस नहीं। मौद्रिक मानों को दशमलव राशि के रूप में लें। अस्वीकृत अनुरोध की जाँच करते समय क्रेडेंशियल हटाकर सर्वर का response संदेश सुरक्षित रखें।

बिलिंग डेटा का सही उपयोग करें

बैलेंस response में वर्तमान बैलेंस, मुद्रा और भुगतान की शर्तें होती हैं। इसमें भविष्य की किसी कॉल की लागत या पूरा इनवॉइस नहीं होता। इन प्रश्नों के लिए संबंधित रेट और उपयोग ऑपरेशन का उपयोग करें। मौजूदा नंबरों के प्लान आज की कैटलॉग से भिन्न हो सकते हैं।

Communications API के सामान्य नियम खाता-विशिष्ट बिलिंग स्कीमा

त्रुटियों और पुनः प्रयासों को संभालें

प्रमाणीकरण या अनुमति की विफलता: API क्रेडेंशियल की सक्षम स्थिति, अनुमत सेवा और स्रोत-IP प्रतिबंध जाँचें। पोर्टल सेशन कुकी इंटीग्रेशन क्रेडेंशियल नहीं है।
अपर्याप्त क्रेडिट या अपूर्ण स्वीकृति: ऑपरेशन दोहराने से पहले खाते के बैलेंस, भेजने की स्वीकृति या दस्तावेज़ की आवश्यकता का समाधान करें।
कोई परिणाम नहीं: खाली इन्वेंटरी या कॉलर का नाम न मिलने को सामान्य परिणाम मानकर संभालें। यह न मानें कि वाक्य-रचना की दृष्टि से मान्य नंबर पर हर सेवा उपलब्ध है।
नेटवर्क टाइमआउट या सेवा विफलता: रीड ऑपरेशन के लिए बैकऑफ़ के साथ सीमित पुनः प्रयास करें। खरीद, भेजने या पंजीकरण के लिए पहले ऑपरेशन की स्थिति देखें; स्वीकार किए जा चुके अनुरोध को दोबारा भेजने से शुल्क वाली कार्रवाई दोहराई जा सकती है।

Idempotency सहायता हर API परिवार की अपनी होती है। Emergency API पुनः प्रयास कुंजियाँ (retry keys) समर्थित करता है; इससे कोई भी मनमाना v3 अनुरोध idempotent नहीं हो जाता। सहायता के लिए टाइमस्टैम्प, लौटाए गए ID और संवेदनशील जानकारी हटाए गए रिस्पॉन्स सुरक्षित रखें।

अपने खाते के संदर्भ के साथ आगे बढ़ें

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

खाते के अनुसार एंडपॉइंट सूची संचार REST कंसोल सार्वजनिक संचार OpenAPI दस्तावेज़OAuth इंटीग्रेशन गाइड