REST API दस्तावेज़

SMS और MMS 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 इंटीग्रेशन सेटिंग्स में प्रबंधित किए जाते हैं।

एप्लिकेशन मैसेजिंग A2P सेवा का उपयोग करती है

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

व्यक्तिगत और परिवार मैसेजिंग प्रमाणित सब्सक्राइबर डिवाइस से भेजी जाती है। कोई भी ग्राहक-सुलभ API, चाहे दस्तावेज़ित हो या नहीं, उस Consumer/P2P सेवा के माध्यम से संदेश नहीं भेज सकता। खाता, टेलीफ़ोन नंबर या इस दस्तावेज़ की प्रति होने से API एक्सेस नहीं मिल जाता।

Business/A2P मैसेजिंग अनुसूची पढ़ें

SMS अनुरोध तैयार करें

खाते के स्वामित्व वाला स्वीकृत, SMS-सक्षम भेजने वाला नंबर और संदेश पाने के लिए सहमत प्राप्तकर्ता उपयोग करें; साथ ही आवश्यक Brand/Campaign पंजीकरण या टोल-फ़्री नंबर सत्यापन पूरा करें। नीचे दिया गया उदाहरण कार्यशील क्रेडेंशियल और नंबरों के साथ भरने पर वास्तविक संदेश भेजता है; यह सैंडबॉक्स नहीं है।

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
  "https://api.multitel.net/v3/sendsms"

भेजने वाले और प्राप्तकर्ता के प्लेसहोल्डर को देश कोड सहित अंतरराष्ट्रीय प्रारूप वाले फ़ोन नंबरों से बदलें और केवल अंक लिखें। MMS के लिए, media में समर्थित और सार्वजनिक रूप से प्राप्त किया जा सकने वाला मीडिया URL दें, और पहले MMS पात्रता और मूल्य की पुष्टि करें।

स्वीकृति का अर्थ डिलीवरी नहीं है

बाहरी एप्लिकेशन स्टेटस और लौटाया गया मैसेजिंग परिणाम, दोनों जाँचें। सेवा द्वारा दिया गया संदेश पहचानकर्ता दर्ज करें, और डिलीवरी स्टेटस तथा webhook इवेंट का अनुसरण करें। सफल सबमिशन यह साबित नहीं कर सकता कि प्राप्तकर्ता के हैंडसेट ने संदेश प्राप्त कर लिया।

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

मैसेजिंग नीति Communications अनुरोध स्कीमा

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

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

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

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

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

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