लिंक मोबिलिटी कार्यान्वयन गाइड REST API SMS
लिंक मोबिलिटी संदेश वितरण, माइक्रो भुगतान और स्थान-आधारित सेवाओं के लिए एक सेवा प्रदान करता है। यह प्लेटफ़ॉर्म सेवा प्रदाताओं और ऑपरेटरों के बीच एक पारदर्शी, व्हाइट-लेबल कंटेंट एक्वायरर और ट्रांजेक्शन राउटर के रूप में कार्य करता है।
लिंक मोबिलिटी एक RESTful API प्रदान करता है जिसका उपयोग SMS भेजने जैसी लिंक मोबिलिटी सेवाओं तक पहुँचने के लिए किया जा सकता है। इस API को उपयोग में आसान और सभी आधुनिक भाषाओं और फ़्रेमवर्क के साथ संगत होने के लिए डिज़ाइन किया गया है। अपनी पसंद की भाषा का उपयोग करके आपका एप्लिकेशन शक्तिशाली संदेश और भुगतान क्षमताओं को लागू करने के लिए लिंक मोबिलिटी REST API का उपयोग कर सकता है
© लिंक मोबिलिटी, 10 मार्च, 2021
कानूनी जानकारी
इस दस्तावेज़ में दी गई जानकारी नेटसाइज़ की एकमात्र संपत्ति और कॉपीराइट है। यह गोपनीय है और इसका उद्देश्य केवल सूचनात्मक उपयोग है। यह बाध्यकारी नहीं है और बिना किसी सूचना के इसमें बदलाव किया जा सकता है। किसी भी अनधिकृत प्रकटीकरण या उपयोग को गैरकानूनी माना जाएगा।
नेटसाइज़™ और लिंकमोबिलिटी™ फ्रांसीसी, ईईसी और अंतर्राष्ट्रीय बौद्धिक संपदा कानूनों द्वारा संरक्षित हैं।
उद्धृत अन्य सभी ट्रेडमार्क उनके संबंधित स्वामियों की एकमात्र संपत्ति हैं।
इसमें निहित किसी भी बात को नेटसाइज़ पेटेंट, कॉपीराइट या ट्रेडमार्क के तहत कोई लाइसेंस या अधिकार प्रदान करने के रूप में नहीं समझा जाएगा।
नेटसाइज़
सोसाइटी एनोनिमे औ कैपिटल डे 5 478 070 यूरो
घेराबंदी सामाजिक: 62, एवेन्यू एमिल ज़ोला92100 बोलोग्ने - फ़्रांस
418 712 477 आरसीएस नैनटेरे
http://www.LinkMobility.com
http://www.linkmobility.com
दस्तावेज़ का दायरा
यह दस्तावेज़ बताता है कि सेवा प्रदाता SMS के लिए LINK Mobility REST API का उपयोग कैसे करता है। यह तकनीकी आर्किटेक्ट और डिज़ाइनरों के लिए है जो सेवा प्रदाता की सेवाओं को लागू करते हैं।
1. मूल उपयोग
एसएमएस भेजना बहुत आसान है। आप लिंक मोबिलिटी को HTTP अनुरोध भेजते हैं जिसे सिर्फ़ एक का उपयोग करके पूरा किया जा सकता है web ब्राउज़र.
2. कार्यात्मक ओवरview
लिंक मोबिलिटी प्रणाली एसएमएस संदेशों के लिए निम्नलिखित बुनियादी कार्यक्षमता प्रदान करती है:
मोबाइल टर्मिनेटेड (एमटी) एसएमएस संदेश भेजना, जैसे टेक्स्ट या बाइनरी (जैसे WAP पुश) प्रीमियम और मानक दर संदेश।
प्रस्तुत MT संदेशों के लिए डिलीवरी रिपोर्ट प्राप्त करना।
मोबाइल व्युत्पन्न (एमओ) एसएमएस संदेश, प्रीमियम और मानक दर प्राप्त करना।
एसएमएस रेस्ट एपीआई मानक दर एमटी एसएमएस संदेश भेजने के लिए समर्पित है।
एपीआई सभी एसएमएस संदेशों को एसिंक्रोनस रूप से भेजता है, जिससे निम्नलिखित सुविधाएं सक्षम होती हैं:
"फायर-एंड-फॉरगेट" - सेवा प्रदाता अधिक पूर्वानुमानित प्रतिक्रिया समय चाहता है और ऑपरेटर से परिणाम की प्रतीक्षा नहीं करना चाहता है।
पुनः प्रयास कार्यक्षमता - यदि ऑपरेटर को अस्थायी समस्या होती है तो LINK Mobility संदेश पुनः भेजेगा।
2.1 एसएमएस संदेश भेजना
सेवा प्रदाता नेटसाइज़ कंज्यूमर
- MT संदेश भेजें
- वापसी संदेश आईडी
- एसएमएस संदेश सबमिट करें
- डिलीवरी रिपोर्ट डिलीवर करें
- डिलीवरी रिपोर्ट भेजें
एसएमएस संदेश भेजने का मूल प्रवाह इस प्रकार वर्णित है:
सेवा प्रदाता लिंक मोबिलिटी प्रणाली के माध्यम से प्राप्तकर्ता को एसएमएस संदेश भेजने का अनुरोध करता है।
सेवा प्रदाता को एक संदेश आईडी लौटा दी जाती है। इस आईडी का उपयोग संदेश को सही डिलीवरी रिपोर्ट से जोड़ने के लिए किया जा सकता है।
लिंक मोबिलिटी रूटिंग का काम संभालती है और एसएमएस संदेश को उपभोक्ता तक पहुंचाती है।
डिलीवरी रिपोर्ट तैयार हो जाती है, उदाहरण के लिए जब एसएमएस संदेश उपभोक्ता के डिवाइस पर डिलीवर हो जाता है।
डिलीवरी रिपोर्ट सेवा प्रदाता को भेजी जाती है। रिपोर्ट में वही संदेश आईडी होती है जो चरण 2 में लौटाई गई थी।
वैकल्पिक प्रवाह: अमान्य अनुरोध
यदि अनुरोध में दिए गए पैरामीटर या उपयोगकर्ता क्रेडेंशियल अमान्य हैं, तो सेवा प्रदाता को एक त्रुटि लौटाई जाती है। त्रुटि अस्वीकृति का कारण बताती है और प्रवाह समाप्त हो जाता है। कोई संदेश आईडी वापस नहीं की जाती है।
3. अंतिम बिंदु
एसएमएस संसाधन तक निम्नलिखित पथ का उपयोग करके पहुंचा जा सकता है:
/रेस्टापी/v1/एसएमएस
Example URL
https://europe.ipx.com/restapi/v1/sms
कनेक्शन सुरक्षा के लिए LINK Mobility REST API केवल HTTPS पर ही उपलब्ध है।
लिंक मोबिलिटी सर्वर प्रमाणपत्र Thawte सर्वर CA द्वारा हस्ताक्षरित है।
4. संचालन
एसएमएस सेवा निम्नलिखित कार्य प्रदान करती है:
| नाम | पथ |
| भेजना | /restapi/v1/sms/भेजें |
4.1 भेजें
भेजें ऑपरेशन का उपयोग एकल प्राप्तकर्ता को एसएमएस भेजने के लिए किया जाता है।
यह ऑपरेशन बुनियादी और उन्नत दोनों उपयोगकर्ताओं के लिए है। सबसे सरल मामले में, एसएमएस डिलीवर करने के लिए केवल गंतव्य पता और संदेश पाठ की आवश्यकता होती है। लिंक मोबिलिटी डेटा कोडिंग स्कीम का पता लगाएगी और यदि आवश्यक हो तो संदेश को कई संदेश भागों में स्वचालित रूप से संयोजित करेगी।
उन्नत उपयोग के लिए, सेवा प्रदाता उपयोगकर्ता डेटा हेडर सहित संदेश स्वरूपण के पूर्ण नियंत्रण के लिए वैकल्पिक मापदंडों का उपयोग कर सकता है।
सेवा प्रदाता संयोजित संदेश भेज सकता है, लेकिन उपयोगकर्ता डेटा और उपयोगकर्ता डेटा हेडर की तैयारी सेवा प्रदाता द्वारा की जानी चाहिए और संदेश को लिंक मोबिलिटी की ओर एकाधिक भेजने के अनुरोधों के माध्यम से भेजा जाना चाहिए।
5. प्रमाणीकरण
प्रत्येक अनुरोध में उपयोगकर्ता नाम और पासवर्ड HTTP बेसिक प्रमाणीकरण योजना का उपयोग करके प्रस्तुत किया जाता है।
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
HTTP अनुरोध में क्रेडेंशियल्स को प्राधिकरण हेडर में भेजा जाता है। क्लाइंट हेडर फ़ील्ड का निर्माण इस प्रकार करता है जैसा कि यहाँ वर्णित है:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
उदाहरणार्थampयदि उपयोगकर्ता नाम john है और पासवर्ड changeme है, तो परिणामी प्राधिकरण हेडर है:
प्राधिकरण: बेसिक am9objpjaGFuZ2VtZSA=
फ़ॉल-बैक के रूप में उपयोगकर्ता नाम और पासवर्ड को अनुरोध पैरामीटर के रूप में सबमिट किया जा सकता है। यह केवल उन क्लाइंट के लिए अनुशंसित है जो बेसिक ऑथ का समर्थन नहीं करते हैं।
6. अनुरोध प्रस्तुत करना
6.1 क्वेरी स्ट्रिंग
अनुरोध पैरामीटर नाम/मूल्य जोड़े वाले क्वेरी स्ट्रिंग के रूप में सबमिट किए जाते हैं। क्वेरी स्ट्रिंग को प्रतिशत एन्कोडिंग का उपयोग करके एन्कोड किया जाता है (URL एनकोडिंग).
http://www.w3schools.com/tags/ref_urlencode.asp
उदाहरणार्थampले, Hello World! को Hello+World%21 के रूप में एनकोड किया गया है।
6.2 अनिवार्य अनुरोध पैरामीटर
| नाम | अधिकतम लंबाई | विवरण |
| गंतव्यपता | 40 | MSISDN जिस पर SMS संदेश भेजा जाना चाहिए, देश कोड से शुरू होता है। उदाहरणampले: 46123456789। कुछ बाजारों के लिए (जहां उपभोक्ता MSISDN को अस्पष्ट किया जाना चाहिए) यह मान एक अल्फ़ान्यूमेरिक उपनाम भी हो सकता है, जिसके आगे “#” लगा हो। |
| संदेश पाठ | 1600 | एसएमएस संदेश की सामग्री. |
6.3 वैकल्पिक अनुरोध पैरामीटर (उन्नत उपयोग के लिए)
| नाम | अधिकतम लंबाई | विवरण |
| मूल पता | 16 | आउटगोइंग एसएमएस संदेश के लिए मूल पता। मूल पते का प्रकार originatorTON पैरामीटर द्वारा परिभाषित किया जाता है। लघु संख्या की अधिकतम लंबाई 16 है। अल्फा न्यूमेरिक प्रेषक अधिकतम लंबाई 11 अक्षरों के साथ GSM डिफ़ॉल्ट वर्णमाला तक सीमित है। MSISDN प्रेषक की अधिकतम लंबाई 15 है (गंतव्य पता तत्व के समान प्रारूप का उपयोग करते हुए)। जब सिस्टम द्वारा originatingAddress और originatingTON का चयन किया जाता है तो इसे छोड़ा जा सकता है। यह फ़ंक्शन बाज़ार और कॉन्फ़िगरेशन पर निर्भर करता है। ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| मूलकर्ताTON | 1 | मूल पते की संख्या का प्रकार (TON): 0 – छोटी संख्या 1 – अल्फा न्यूमेरिक (अधिकतम लंबाई 11) 2 – एमएसआईएसडीएन जब सिस्टम द्वारा originatingAddress और originatingTON का चयन किया जाएगा तो इसे छोड़ा जा सकता है। यह फ़ंक्शन बाज़ार और कॉन्फ़िगरेशन पर निर्भर है। ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| उपयोगकर्ताडेटाहैडर | 280 | यूजर डेटा हेडर में यूजर डेटा के साथ 140 तक, यानी हेक्स-एनकोडेड होने पर 280, ऑक्टेट हो सकते हैं। यह पैरामीटर हमेशा हेक्स-एनकोडेड होता है। |
| डीसीएस | 3 | डेटा कोडिंग योजना. ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| पीआईडी | 3 | प्रोटोकॉल आईडी. ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| सापेक्ष वैधतासमय | 6 | सेकंड में सापेक्ष वैधता समय (LINK Mobility को सबमिट करने के समय के सापेक्ष)। अधिकतम मान 604800 (7 दिन) है और डिफ़ॉल्ट 48 घंटे है। ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| डिलीवरी का समय | 20 | टाइमस्टamp एसएमएस संदेश कब वितरित किया जाना चाहिए (विलंबित वितरण समय)। दिनांक समय प्रारूप पर अनुभाग देखें। |
| स्थितिरिपोर्टझंडे | 1 | रिपोर्ट अनुरोध प्रस्तुत करें: 0 – कोई डिलीवरी रिपोर्ट नहीं (डिफ़ॉल्ट) 1 – डिलीवरी रिपोर्ट का अनुरोध किया गया 9 – सर्वर डिलीवरी रिपोर्ट का अनुरोध किया गया (लिंक मोबिलिटी रिपोर्ट को सेवा प्रदाता को अग्रेषित नहीं करती है, लेकिन इसे रिपोर्ट आदि में उपलब्ध कराती है) |
| campaignनाम | 50 | लिंक मोबिलिटी लेनदेन इस प्रकार हैं: tagइस नाम से ged. इसका उपयोग लिंक मोबिलिटी रिपोर्ट में लेनदेन को समूहीकृत करने के लिए किया जाता है। |
| अधिकतम संयोजितसंदेश | 1 | 1 से 10 के बीच का मान जो यह निर्धारित करता है कि कितने संयोजित संदेशों की अनुमति है। डिफ़ॉल्ट 3 है। |
| सहसंबंधआईडी | 100 | सेवा प्रदाता द्वारा प्रदान की गई आईडी जो डिलीवरी रिपोर्ट में दर्शाई जाएगी। |
| उपयोगकर्ता नाम | 100 | HTTP बेसिक प्रमाणीकरण के विकल्प के रूप में प्रदान किया गया। |
| पासवर्ड | 100 | HTTP बेसिक प्रमाणीकरण के विकल्प के रूप में प्रदान किया गया। |
6.4 HTTP अनुरोध विधियाँ
अधिकतम अंतर-संचालनीयता के लिए, API HTTP GET और POST दोनों अनुरोध विधियों का समर्थन करता है। किसी अन्य HTTP विधि की अनुमति नहीं है।
6.4.1 प्राप्त करें
एनकोडेड क्वेरी स्ट्रिंग को इसमें जोड़ा जाता है URL.
पाना
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&संदेशटेक्स्ट=हैलो+वर्ल्ड%21
प्राधिकरण: बेसिक am9objpjaGFuZ2VtZSA=
6.4.2 पोस्ट
एन्कोडेड क्वेरी स्ट्रिंग HTTP अनुरोध संदेश बॉडी में सबमिट की जाती है। Content-Type application/x-www-form- हैurlएन्कोडेड।
डाक https://europe.ipx.com/restapi/v1/sms/send
होस्ट: europe.ipx.com
सामग्री-प्रकार: application/x-www-form-urlइनकोडिंग
प्राधिकरण: बेसिक am9objpjaGFuZ2VtZSA=
सामग्री-लंबाई: 57
गंतव्य पता=46123456789&संदेश पाठ=नमस्ते+विश्व%21
6.5 दिनांक और समय
REST API में दिनांक और समय को दर्शाने वाले पैरामीटर हमेशा UTC समय क्षेत्र (समन्वित सार्वभौमिक समय) में होते हैं।amps को इस सटीक प्रारूप में एक स्ट्रिंग के रूप में दर्शाया गया है:
2017-04-25T23:20:50Z
यह UTC के अनुसार 20 अप्रैल, 50 के 23वें घंटे के 25 मिनट और 2017 सेकंड बाद का समय दर्शाता है।
7. प्रतिक्रिया संदेश
अनुरोध संदेश प्राप्त करने और उसकी व्याख्या करने के बाद API HTTP प्रतिक्रिया संदेश के साथ प्रतिक्रिया करता है।
7.1 HTTP स्थिति कोड
REST API हमेशा संसाधित अनुरोधों के लिए HTTP स्थिति कोड 200 OK लौटाता है। संदेश निकाय में एक पैरामीटर responseCode होता है जिसका उपयोग सटीक परिणाम निर्धारित करने के लिए किया जाता है।
7.2 संदेश का मुख्य भाग
संदेश का मुख्य भाग JSON से बना होता है जो अनुरोध के परिणाम का वर्णन करता है।
http://json.org/
लिंक मोबिलिटी JSON, Google JSON स्टाइल गाइड का अनुपालन करता है.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 प्रतिक्रिया पैरामीटर
| नाम | अधिकतम लंबाई | विवरण |
| प्रतिसाद कोड | 3 | 0 सफल लेनदेन को इंगित करता है. |
| प्रतिक्रियासंदेश | 255 | प्रतिक्रिया पाठ्य विवरण, जैसे त्रुटि पाठ. |
| टाइमस्टamp | 20 | दिनांक और समय जब LINK Mobility ने अनुरोध संसाधित किया। (दिनांक/समय प्रारूप अनुभाग देखें)। |
| ट्रेसआईडी | 36 | लिंक मोबिलिटी आंतरिक पहचानकर्ता। सहायता और समस्या निवारण के लिए उपयोग किया जाता है। |
| संदेशआईडी | 10 x 36 | प्रत्येक सफल संदेश के लिए LINK Mobility अद्वितीय संदेश ID की सरणी (यदि संदेश संयोजित है तो एकाधिक संदेश ID लौटाई जाती हैं)। असफलता की स्थिति में छोड़ दिया गया। |
7.4 पूर्वample प्रतिक्रियाएँ
सफलता
HTTP/1.1 200 ठीक
सामग्री-प्रकार: application/json
सामग्री-लंबाई: 144
दिनांक: गुरु, 15 सितम्बर 2016 13:20:31 GMT
{“प्रतिक्रिया कोड”:0,”प्रतिक्रिया संदेश”:”सफलता”,,”समय सीमाamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
पठनीयता के लिए उसी JSON को प्रारूपित किया गया है:
{
“प्रतिसाद कोड“:0,
“प्रतिक्रियासंदेश":"सफलता",
“टाइमस्टamp“:”2016-0915T13:20:31Z”,
“ट्रेसआईडी“:”f678d30879fd4adc25f2”,
“संदेशआईडी“:[“1-4850879008”] }
असफलता
HTTP/1.1 200 ठीक
सामग्री-प्रकार: application/json
सामग्री-लंबाई: 148
दिनांक: गुरु, 15 सितम्बर 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” अमान्य लॉगिन या अनधिकृत API उपयोग”,,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
सफलता
HTTP/1.1 200 ठीक
सामग्री-प्रकार: application/json
सामग्री-लंबाई: 144
दिनांक: गुरु, 15 सितम्बर 2016 13:20:31 GMT
{“प्रतिक्रिया कोड”:0,”प्रतिक्रिया संदेश”:”सफलता”,,”समय सीमाamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
पठनीयता के लिए उसी JSON को प्रारूपित किया गया है:
{
“प्रतिसाद कोड“:0,
“प्रतिक्रियासंदेश":"सफलता",
“टाइमस्टamp“:”2016-0915T13:20:31Z”,
“ट्रेसआईडी“:”f678d30879fd4adc25f2”,
“संदेशआईडी“:[“1-4850879008”] }
असफलता
HTTP/1.1 200 ठीक
सामग्री-प्रकार: application/json
सामग्री-लंबाई: 148
दिनांक: गुरु, 15 सितम्बर 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” अमान्य लॉगिन या अनधिकृत API उपयोग”,,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 प्रतिक्रिया कोड
भेजे गए प्रत्युत्तर में निम्नलिखित प्रत्युत्तर कोड लौटाए जा सकते हैं:
| कोड | मूलपाठ | विवरण |
| 0 | सफलता | सफलतापूर्वक निष्पादित. |
| 1 | अमान्य लॉगिन या अनधिकृत API उपयोग | गलत उपयोगकर्ता नाम या पासवर्ड या सेवा प्रदाता को LINK Mobility द्वारा प्रतिबंधित कर दिया जाता है। |
| 2 | लिंक मोबिलिटी द्वारा उपभोक्ता को ब्लॉक कर दिया गया है | उपभोक्ता को लिंक मोबिलिटी द्वारा ब्लॉक कर दिया गया है। |
| 3 | संचालन LINK Mobility द्वारा प्रावधानित नहीं है | सेवा प्रदाता के लिए यह कार्य अवरुद्ध है। |
| 4 | उपभोक्ता लिंक मोबिलिटी से अनभिज्ञ है | उपभोक्ता लिंक मोबिलिटी से अनभिज्ञ है। या यदि अनुरोध में उपनाम का उपयोग किया गया था; उपनाम नहीं मिला। |
| 5 | उपभोक्ता ने LINK Mobility में इस सेवा को ब्लॉक कर दिया है | उपभोक्ता ने LINK Mobility में इस सेवा को ब्लॉक कर दिया है। |
| 6 | मूल पता समर्थित नहीं है | मूल पता समर्थित नहीं है. |
| 7 | अल्फा मूल पता खाते द्वारा समर्थित नहीं है | अल्फा मूल पता खाते द्वारा समर्थित नहीं है. |
| 8 | MSISDN मूल पता समर्थित नहीं है | MSISDN मूल पता समर्थित नहीं है. |
| 9 | GSM विस्तारित समर्थित नहीं है | GSM विस्तारित समर्थित नहीं है. |
| 10 | यूनिकोड समर्थित नहीं है | यूनिकोड समर्थित नहीं है. |
| 11 | स्थिति रिपोर्ट समर्थित नहीं है | स्थिति रिपोर्ट समर्थित नहीं है. |
| 12 | आवश्यक क्षमता समर्थित नहीं है | संदेश भेजने के लिए आवश्यक क्षमता (उपर्युक्त के अलावा) समर्थित नहीं है। |
| 13 | सामग्री प्रदाता की अधिकतम थ्रॉटलिंग दर पार हो गई है | सेवा प्रदाता लिंक मोबिलिटी को एसएमएस संदेश बहुत तेजी से भेज रहा है। |
| 14 | प्रोटोकॉल आईडी खाते द्वारा समर्थित नहीं है | प्रोटोकॉल आईडी समर्थित नहीं है. |
| 15 | संदेश संयोजन सीमा पार हो गई | संयोजित संदेशों की संख्या अनुरोधित अधिकतम संख्या से अधिक है। |
| 16 | संदेश रूट करने में असमर्थ. | लिंक मोबिलिटी संदेश को रूट करने में असमर्थ रही। |
| 17 | निषिद्ध समय अवधि | समय अवधि के दौरान संदेश भेजने की अनुमति नहीं है |
| 18 | सेवा प्रदाता खाते में बहुत कम शेष राशि | सेवा प्रदाता बहुत कम शेष राशि के कारण अवरुद्ध है |
| 50 | आंशिक सफलता | एकाधिक प्राप्तकर्ताओं को एसएमएस संदेश भेजते समय आंशिक सफलता। |
| 99 | आंतरिक सर्वर त्रुटि | अन्य लिंक मोबिलिटी त्रुटि, अधिक जानकारी के लिए लिंक मोबिलिटी समर्थन से संपर्क करें। |
| 100 | अमान्य गंतव्य पता | गंतव्य पता (MSISDN, या उपनाम) अमान्य है. |
| 102 | अमान्य संदर्भित (लिंक की गई) आईडी | संदर्भ आईडी अमान्य है, हो सकता है कि संदर्भ आईडी पहले से उपयोग की जा चुकी हो, बहुत पुरानी हो या अज्ञात हो। |
| 103 | अमान्य खाता नाम | खाता नाम अमान्य है. |
| 105 | अमान्य सेवा मेटा डेटा | सेवा मेटा डेटा अमान्य है. |
| 106 | अमान्य मूल पता | मूल पता अमान्य है. |
| 107 | अमान्य अल्फ़ान्यूमेरिक मूल पता | अल्फ़ान्यूमेरिक मूल पता अमान्य है. |
| 108 | अमान्य वैधता समय | वैधता समय अमान्य है. |
| 109 | डिलीवरी का समय अमान्य | डिलीवरी का समय अमान्य है. |
| 110 | संदेश सामग्री/उपयोगकर्ता डेटा अमान्य है | उपयोगकर्ता डेटा, अर्थात एसएमएस संदेश, अमान्य है। |
| 111 | संदेश की लंबाई अमान्य है | एसएमएस संदेश की लंबाई अमान्य है. |
| 112 | अमान्य उपयोगकर्ता डेटा शीर्षलेख | उपयोगकर्ता डेटा हेडर अमान्य है. |
| 113 | अमान्य डेटा कोडिंग योजना | डी.सी.एस. अमान्य है। |
| 114 | अमान्य प्रोटोकॉल आईडी | पीआईडी अमान्य है. |
| 115 | अमान्य स्थिति रिपोर्ट फ़्लैग | स्थिति रिपोर्ट ध्वज अमान्य हैं. |
| 116 | अमान्य TON | मूल TON अमान्य है. |
| 117 | अमान्य campनाम अंकित करें | सीampaign नाम अमान्य है. |
| 120 | संयोजित संदेशों की अधिकतम संख्या की सीमा अमान्य है | संयोजित संदेशों की अधिकतम संख्या अमान्य है. |
| 121 | msisdn मूल पता अमान्य है | MSISDN मूल पता अमान्य है. |
| 122 | अमान्य सहसंबंध आईडी | सहसंबंध आईडी अमान्य है. |
8. वैकल्पिक सुविधाएँ
8.1 एमएसआईएसडीएन सुधार
MSISDN सुधार एक वैकल्पिक सुविधा है जिसे अनुरोध किए जाने पर LINK Mobility समर्थन द्वारा सक्षम किया जा सकता है।
यह सुविधा गंतव्य पतों को सही करेगी और उन्हें आवश्यक E.164 प्रारूप में संरेखित करेगी। प्रारूप सुधार के अलावा सिस्टम बाजार विशिष्ट कार्यक्षमता भी कर सकता है जैसे कि लागू होने पर अंतर्राष्ट्रीय फ्रेंच नंबरों को DOM-TOM (départements et territoires d'outre-mer) नंबरों में अनुवाद करना।
नीचे कुछ पूर्व उदाहरण दिए गए हैंampसुधारों की संख्या:
| प्रस्तुत गंतव्य पता | संशोधित गंतव्य पता |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (फ्रेंच संख्या का DOM-TOM संख्या में अनुवाद) |
इसके अतिरिक्त, किसी चयनित बाज़ार के लिए राष्ट्रीय फ़ोन नंबर की अनुमति देना संभव है। जब यह सुविधा सक्षम होती है, तो अन्य बाज़ारों के लिए किसी भी अंतर्राष्ट्रीय नंबर को चयनित बाज़ार से अलग करने के लिए प्रारंभिक `+' चिह्न के साथ भेजा जाना चाहिए।
नीचे कई पूर्व हैंampराष्ट्रीय नंबरों के लिए डिफ़ॉल्ट बाज़ार के रूप में स्वीडन (देश कोड 46) का उपयोग करते समय किए गए सुधारों की संख्या कम है।
| प्रस्तुत गंतव्य पता | संशोधित गंतव्य पता |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | '+' चिह्न गायब होने के कारण अमान्य |
ध्यान दें कि संशोधित MSISDN का उपयोग LINK Mobility द्वारा किया जाएगा और इसे डिलीवरी रिपोर्ट में लौटा दिया जाएगा।
अधिक जानकारी के लिए कृपया लिंक मोबिलिटी सहायता से संपर्क करें।
8.2 वर्ण प्रतिस्थापन
चरित्र प्रतिस्थापन एक वैकल्पिक सुविधा है जिसे अनुरोध किए जाने पर LINK Mobility समर्थन द्वारा सक्षम किया जा सकता है।
यह सुविधा उपयोगकर्ता डेटा (एसएमएस पाठ) में गैर-जीएसएम वर्णमाला वर्णों को समकक्ष जीएसएम वर्णमाला वर्णों में तब अनुवादित करेगी जब डीसीएस को "जीएसएम" (17) पर सेट किया जाएगा। उदाहरण के लिएampले "सेक्वेंसिया डे टेस्टे एम पोर्टुगुएस" का अनुवाद "सेक्वेंसिया डे टेस्टे एम पोर्टुगुएस" में किया जाएगा।
9. डिलीवरी रिपोर्ट
सेवा प्रदाता, यदि प्रावधानित है, तो भेजे गए MT संदेशों के लिए SMS संदेश वितरण रिपोर्ट या वितरण अधिसूचनाओं का अनुरोध कर सकता है। ये रिपोर्ट ऑपरेटर SMSC में तब ट्रिगर होती हैं जब MT संदेश लक्षित उपभोक्ता को डिलीवर हो जाता है या डिलीट हो जाता है, जैसे कि एक्सपायर हो जाता है या किसी कारण से रूटेबल नहीं होता है।
एसएमएस संदेश की केवल अंतिम स्थिति की रिपोर्ट सेवा प्रदाता को दी जाती है, अर्थात डिलीवर या डिलीट किया गया। प्रत्येक MT संदेश के लिए केवल एक रिपोर्ट तैयार की जाती है। डिलीट की गई स्थिति के साथ, एक कारण कोड लागू हो सकता है। यह कारण कोड एसएमएस संदेश डिलीवर न होने का कारण बताता है।
रिपोर्ट्स को लिंक मोबिलिटी के माध्यम से भेजा जाता है और HTTP प्रोटोकॉल का उपयोग करके सेवा प्रदाता को भेजा जाता है।
रिपोर्ट प्राप्त करने के लिए, सेवा प्रदाता को पूर्व के लिए कार्यान्वयन करना होगाampजावा सर्वलेट या ASP.NET पेज खोलें। दोनों ही HTTP GET या POST अनुरोध प्राप्त करते हैं।
पैरामीटर
अनुरोध में निम्नलिखित पैरामीटर शामिल हैं:
| पैरामीटर | प्रकार | एम/ओ/आई* | डिफ़ॉल्ट मान | अधिकतम लंबाई | विवरण |
| संदेशआईडी | डोरी | M | – | 22 | MT संदेश की संदेश ID जिससे यह रिपोर्ट संबंधित है. |
| गंतव्यपता | डोरी | M | – | 40 | उपभोक्ता का MSISDN, अर्थात मूल MT संदेश का गंतव्य पता। |
| स्थिति कोड | पूर्णांक | M | 1 | स्थिति कोड MT संदेश की स्थिति को इंगित करता है। लागू स्थिति कोड हैं: 0 – वितरित 2 – हटाया गया (कारण कोड लागू होता है) |
|
| टाइमस्टamp | डोरी | M | – | 20 | वह समय जब लिंक मोबिलिटी द्वारा डिलीवरी रिपोर्ट प्राप्त की गई। वर्तमान समय का समय क्षेत्रamp CET या CEST (यूरोपीय संघ के लिए परिभाषित ग्रीष्मकालीन समय के साथ) है। प्रारूप: yyyyMMdd HH:mm:ss. |
| ऑपरेटर | डोरी | M | – | 100 | एसएमएस संदेश भेजते समय प्रयुक्त ऑपरेटर का नाम या एसएमएस संदेश भेजते समय प्रयुक्त खाता नाम। उपलब्ध ऑपरेटरों की सूची लिंक मोबिलिटी सपोर्ट द्वारा प्रदान की गई है। |
| कारण कोड | पूर्णांक | O | – | 3 | कारण कोड यह बताता है कि संदेश क्यों हटा दिया गया। लागू कारण कोड हैं: 100 – समाप्त 101 – अस्वीकृत 102 – प्रारूप त्रुटि 103 – अन्य त्रुटि 110 – ग्राहक अज्ञात 111 – सब्सक्राइबर प्रतिबंधित 112 – सब्सक्राइबर को प्रावधानित नहीं किया गया 113 – सब्सक्राइबर उपलब्ध नहीं 120 – एसएमएससी विफलता 121 – एसएमएससी भीड़ 122 – एसएमएससी रोमिंग 130 – हैंडसेट त्रुटि 131 – हैंडसेट मेमोरी की सीमा पार हो गई ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है. |
| ऑपरेटरटाइमस्टamp | डोरी | O | – | 20 | ऑपरेटर के एसएमएससी में रिपोर्ट कब सक्रिय हुई, यह दर्शाने वाला समय (यदि ऑपरेटर द्वारा प्रदान किया गया हो)। वर्तमान समय का समय क्षेत्रamp CET या CEST (यूरोपीय संघ के लिए परिभाषित ग्रीष्मकालीन समय के साथ) है। प्रारूप: yyyyMMdd HH:mm:ss. |
| स्थिति पाठ | डोरी | O | – | 255 | ऑपरेटर से अतिरिक्त जानकारी के लिए प्लेसहोल्डर, जैसे कि स्थिति/कारण का स्पष्ट पाठ विवरण। ऑपरेटर एकीकरण के साथ व्यवहार भिन्न हो सकता है। |
| सहसंबंधआईडी | डोरी | O | – | 100 | SendRequest या SendTextRequest में प्रदान किया गया सहसंबंध ID. |
| ऑपरेटरनेटवर्ककोड | पूर्णांक | O | – | 6 | ऑपरेटर का मोबाइल नेटवर्क कोड (MCC + MNC)। |
* M = अनिवार्य, O = वैकल्पिक, I = अनदेखा.
सेवा प्रदाता को लिंक मोबिलिटी को लक्ष्य उपलब्ध कराना होगा URL डिलीवरी रिपोर्ट के लिए (वैकल्पिक रूप से HTTP मूल प्रमाणीकरण के लिए क्रेडेंशियल्स सहित)। सेवा प्रदाता चुन सकता है कि किस पसंदीदा HTTP विधि का उपयोग करना है:
HTTP पोस्ट (अनुशंसित)
HTTP प्राप्त करें.
ExampHTTP GET का उपयोग करके फ़ाइल (सफलतापूर्वक वितरित):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
ExampHTTP GET का उपयोग करके फ़ाइल (डिलीवर नहीं की गई, ऑपरेटर ने टाइमस्ट की आपूर्ति की हैamp इस आयोजन के लिए):
पैरामीटर हैं URL एनकोडेडी.
वर्ण एनकोडिंग:
सेवा प्रदाता चुन सकता है कि किस पसंदीदा वर्ण एन्कोडिंग का उपयोग करना है:
UTF-8 (अनुशंसित)
आईएसओ-8859-1.
9.1 सेवा प्रदाता पावती
सेवा प्रदाता को प्रत्येक डिलीवरी रिपोर्ट की पावती देनी चाहिए। पावती सकारात्मक हो सकती है, यानी डिलीवरी रिपोर्ट सफलतापूर्वक प्राप्त हुई, या नकारात्मक, यानी विफलता।
कृपया ध्यान दें: लिंक मोबिलिटी में डिलीवरी रिपोर्ट के लिए पावती के लिए 30 सेकंड का रीड टाइमआउट है। टाइमआउट डिलीवरी पुनः प्रयास (यदि पुनः प्रयास सक्षम है) या डिलीवरी को रद्द करने (यदि पुनः प्रयास अक्षम है) को ट्रिगर करेगा। इसका मतलब है कि सेवा प्रदाता एप्लिकेशन को त्वरित प्रतिक्रिया समय सुनिश्चित करना चाहिए, खासकर उच्च लोड के दौरान।
यह अत्यधिक अनुशंसित है कि डिलीवरी रिपोर्ट को संसाधित करने से पहले लिंक मोबिलिटी को इसकी सूचना दे दी जाए।
सकारात्मक और नकारात्मक स्वीकृति का नियम इस प्रकार वर्णित है:
सकारात्मक स्वीकृति, एसीके, डिलीवरी रिपोर्ट वितरित:
HTTP 200 रेंज प्रतिक्रिया कोड निम्नलिखित XML स्वरूपित सामग्री के साथ संयोजन में:
नकारात्मक पावती, एनएके, डिलीवरी रिपोर्ट वितरित नहीं की गई:
सकारात्मक पावती के अलावा कोई भी उत्तर, उदाहरणार्थample, किसी भी HTTP त्रुटि कोड या निम्नलिखित XML सामग्री द्वारा नकारात्मक पावती ट्रिगर की जाती है:
XML सामग्री का उपयोग LINK मोबिलिटी पुनः प्रयास तंत्र को नियंत्रित करने के लिए किया जा सकता है। यदि सक्षम किया गया है, तो NAK पुनः प्रयास का कारण बनेगा। पुनः प्रयास तंत्र के लिए कॉन्फ़िगर नहीं किए गए सेवा प्रदाताओं के लिए, XML सामग्री वैकल्पिक है।
नीचे एक HTTP POST अनुरोध और प्रतिक्रिया उदाहरण हैampसेवा प्रदाता को दी गई डिलीवरी रिपोर्ट की प्रति:
HTTP अनुरोध:
पोस्ट / संदर्भ / ऐप HTTP / 1.1
सामग्री-प्रकार: application/x-www-form-urlएनकोडेड; वर्णसेट = utf-8
होस्ट: सर्वर:पोर्ट
सामग्री-लंबाई: xx
संदेशआईडी=213123213&गंतव्यपता=46762050312&ऑपरेटर=टेलिया& ऑपरेटरटाइमस्टamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
HTTP प्रतिक्रिया:
HTTP/1.1 200 ठीक
सामग्री-प्रकार: पाठ/सादा
9.2 पुनः प्रयास करें
लिंक मोबिलिटी सिस्टम विफल, यानी स्वीकार न की गई, डिलीवरी रिपोर्ट डिलीवरी के लिए पुनः प्रयास कर सकता है। सेवा प्रदाता पसंदीदा पुनः प्रयास व्यवहार चुन सकता है:
पुनः प्रयास नहीं (डिफ़ॉल्ट) - यदि कनेक्शन प्रयास विफल हो जाता है, पढ़ने का समय समाप्त हो जाता है या कोई HTTP त्रुटि कोड होता है तो संदेश त्याग दिया जाएगा।
पुन: प्रयास करें - हर प्रकार की कनेक्शन समस्या, पढ़ने का समय समाप्त होने या नकारात्मक पावती के लिए संदेश पुनः भेजा जाएगा।
जब NAK के लिए पुनः प्रयास सक्षम किया जाता है, तो यह समझना महत्वपूर्ण है कि कौन से परिदृश्य LINK Mobility से पुनः प्रयास प्रयास उत्पन्न करेंगे और पुनः प्रयास कैसे काम करता है। प्रत्येक सेवा प्रदाता की अपनी स्वयं की पुनः प्रयास कतार होती है, जहाँ संदेशों को संदेश समय के अनुसार क्रमबद्ध किया जाता हैampलिंक मोबिलिटी हमेशा पुराने संदेशों को पहले डिलीवर करने की कोशिश करती है, भले ही सेवा प्रदाता को डिलीवर किए गए संदेशों के व्यक्तिगत क्रम की गारंटी न हो। संदेशों को पुनः प्रयास कतार से हटा दिए जाने का मुख्य कारण दो कारणों में से एक है: या तो संदेश TTL समाप्त हो जाता है या (सैद्धांतिक रूप से) पुनः प्रयास कतार भर जाती है। TTL ऑपरेटर और खाते पर निर्भर करता है, यानी, ऑपरेटर और या संदेश के प्रकार के आधार पर भिन्न हो सकता है, जैसे, प्रीमियम एसएमएस या मानक दर एसएमएस संदेश।
पुनः प्रयास सक्षम सेवा प्रदाताओं को MT संदेश की विशिष्ट ID की जांच करनी चाहिए ताकि यह सुनिश्चित किया जा सके कि संदेश पहले ही प्राप्त नहीं हुआ है।
डिलीवरी रिपोर्ट की प्रोसेसिंग के दौरान कोई त्रुटि होने पर सेवा प्रदाता के लिए इन सरल नियमों का पालन करना महत्वपूर्ण है, यदि त्रुटि का कारण यह है: अस्थायी, जैसे कि डेटाबेस उपलब्ध नहीं है, तो NAK वापस किया जाना चाहिए। LINK Mobility संदेश को फिर से भेजेगा।
स्थायी और पुनः प्रयास करने से एक ही तरह की समस्या उत्पन्न होने की संभावना है, एक ACK लौटाया जाना चाहिए। उदाहरण के लिएample, जब संदेश को सही ढंग से पार्स नहीं किया जा सका या अप्रत्याशित रनटाइम त्रुटि उत्पन्न हुई।
तदनुसार कार्य करने से यह सुनिश्चित होगा कि डिलीवरी रिपोर्ट को बार-बार पुनः भेजे जाने के कारण कोई अवरोध या थ्रूपुट गिरावट उत्पन्न न हो।
10. कार्यान्वयन युक्तियाँ
1. यह संभव है कि आप अपने web ब्राउज़र को API को अनुरोध सबमिट करने के लिए। इससे किसी भी विकास उपकरण के बिना सेवाओं का पता लगाना और उनका मूल्यांकन करना बहुत आसान हो जाता है।
2. JSON जैसे एक्सटेंशन के साथ क्रोम या फ़ायरफ़ॉक्स का उपयोग करने की अनुशंसा की जाती हैView सुंदर स्वरूपित JSON प्रदर्शित करने के लिए.
3. हमने POST, बेसिक प्रमाणीकरण के परीक्षण और कच्चे HTTP अनुरोध और प्रतिक्रिया संदेशों के निरीक्षण के लिए SoapUI का उपयोग किया है।
4. सीURL यह टूल बेसिक ऑथेंटिकेशन के साथ POST अनुरोध सबमिट करने के लिए उपयोगी है। उदाहरण देखेंampले नीचे.
curl डाक \
-एच "सामग्री-प्रकार: आवेदन/x-www-फॉर्म-urlएनकोडेड” \
-H “प्राधिकरण: बेसिक am9objpjaGFuZ2VtZSA=" \
https://europe.ipx.com/restapi/v1/sms/send \
–डेटा “गंतव्य पता=46123456789&संदेश पाठ=हैलो+विश्व%21”
_______________
वैयक्तिक संचार में परिवर्तन
दस्तावेज़ / संसाधन
 |
लिंक मोबिलिटी कार्यान्वयन गाइड REST API SMS [पीडीएफ] उपयोगकर्ता गाइड गतिशीलता कार्यान्वयन गाइड REST API SMS, गतिशीलता, कार्यान्वयन गाइड REST API SMS, REST API SMS, API SMS, SMS |
