SMS API, SMPP API MS Scheduler API
प्रयोगकर्ता गाइड
SMS API, SMPP API MS Scheduler API
परिमार्जित: | ११/२/२०२२ |
संस्करण: | 1.7 |
लेखक: | केनी कोल्यान्डर नोर्डेन, केसीएन |
यो कागजात नामित प्राप्तकर्ताको लागि मात्र हो र विशेषाधिकार प्राप्त, स्वामित्व, वा अन्यथा निजी जानकारी समावेश हुन सक्छ। यदि तपाईंले त्रुटिवश प्राप्त गर्नुभएको छ भने, कृपया प्रेषकलाई तुरुन्तै सूचित गर्नुहोस् र मूल मेटाउनुहोस्। तपाइँ द्वारा कागजात को कुनै पनि अन्य प्रयोग निषेधित छ।
इतिहास परिवर्तन गर्नुहोस्
रेभ | मिति | By | अघिल्लो रिलीजबाट परिवर्तनहरू |
1.0 | ८००-५५५-०१९९ | KCN | सिर्जना गरियो |
1. | ८००-५५५-०१९९ | TPE | अपडेट गरिएका LINK लोगोहरू |
1. | ८००-५५५-०१९९ | PNI | SMPP 3.4 विशिष्टतामा सन्दर्भ थपियो |
1. | ८००-५५५-०१९९ | EP | वैधता अवधि बारे अवलोकन tag |
1. | ८००-५५५-०१९९ | KCN | समर्थित TLS संस्करणहरू बारे जानकारी थपियो |
2. | ८००-५५५-०१९९ | KCN | डेलिभरी रिपोर्टहरू सम्बन्धी थप जानकारी थपियो TLS १.३ सम्बन्धी अद्यावधिक जानकारी |
2. | ८००-५५५-०१९९ | GM | नतिजा कोड २१०८ थपियो |
2. | ८००-५५५-०१९९ | AK | कोटा थपियो |
परिचय
LINK मोबिलिटी 2001 देखि एसएमएस वितरक भएको छ र दुबै अपरेटर र जडान एग्रीगेटरहरूसँग काम गर्ने धेरै अनुभव छ। यो प्लेटफर्म ठूला ट्राफिक भोल्युमहरू ह्यान्डल गर्न, उच्च उपलब्धता कायम राख्न र धेरै जडानहरू मार्फत ट्राफिकलाई सजिलो बनाउन डिजाइन गरिएको हो।
यो कागजातले SMSC-प्लेटफर्ममा SMPP इन्टरफेस र कुन प्यारामिटरहरू र आदेशहरू आवश्यक छन् र कुन प्यारामिटरहरू समर्थित छन् भनेर वर्णन गर्दछ।
यो कागजातले विशेष प्रयोगका केसहरू जस्तै कङ्कटेनेटेड सन्देशहरू, WAPpush, Flash SMS, आदि ह्यान्डल गर्दैन। ती केसहरूको बारेमा थप जानकारी समर्थनलाई सम्पर्क गरेर प्रदान गर्न सकिन्छ।
समर्थित आदेशहरू
LINK मोबिलिटीको सर्भरलाई SMPP ३.४ मानिनुपर्छ। आधिकारिक विनिर्देशन मा पाउन सकिन्छ https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
सबै विधिहरू समर्थित छैनन्, र सबै भिन्नताहरू तल निर्दिष्ट गरिएका छन्।
4.1 बाँध्नुहोस्
निम्न बाइन्ड आदेशहरू समर्थित छन्।
- ट्रान्समिटर
- ट्रान्सीभर
- रिसिभर
आवश्यक प्यारामिटरहरू:
- system_id - समर्थनबाट प्राप्त
- पासवर्ड - समर्थनबाट प्राप्त
वैकल्पिक प्यारामिटरहरू:
- addr_ton - पूर्वनिर्धारित मान यदि TON सबमिट गर्दा अज्ञात मा सेट गरिएको छ।
- addr_npi - पूर्वनिर्धारित मान यदि सबमिट गर्दा NPI अज्ञात मा सेट गरिएको छ।
असमर्थित प्यारामिटरहरू:
- ठेगाना_ दायरा
4.2 अनबाइन्ड
अनबाइन्ड आदेश समर्थित छ।
4.3 लिङ्क सोध्नुहोस्
सोधपुछ लिङ्क आदेश समर्थित छ र प्रत्येक 60 सेकेन्डमा कल गर्नुपर्छ।
३.४ पेस गर्नुहोस्
सन्देशहरू पठाउनको लागि सबमिट विधि प्रयोग गर्नुपर्छ।
आवश्यक प्यारामिटरहरू:
- source_addr_ton
- source_addr_npi
- source_addr
- dest_addr_ton
- dest_addr_npi
- dest_addr
- esm_class
- डाटा_कोडिङ
- sm_length
- छोटो_सन्देश
असमर्थित प्यारामिटरहरू:
- सेवा_प्रकार
- protocol_id
- priority_flag
- तालिका_वितरण_समय
- प्रतिस्थापन_if_present_flag
- sm_default_msg_id
नोट त्यो पेलोड tag समर्थित छैन र प्रति कल एउटा मात्र SMS पठाउन सकिन्छ र यो सिफारिस गरिन्छ कि validity_period tag कम्तिमा 15 मिनेट लामो को मान छ।
4.4.1 सिफारिस गरिएको TON र NPI
सबमिट आदेश प्रयोग गरेर सन्देशहरू पठाउँदा निम्न TON र NPI प्रयोग गर्नुपर्छ।
4.4.1.1 स्रोत
स्रोत ठेगानाको लागि निम्न TON र NPI संयोजनहरू समर्थित छन्। अन्य सबै संयोजनहरूलाई अमान्य मानिनेछ। यदि TON अज्ञात (0) मा सेट गरिएको छ भने bind आदेशबाट पूर्वनिर्धारित TON प्रयोग गरिनेछ। यदि NPI अज्ञात (0) मा सेट गरिएको छ भने bind आदेशबाट पूर्वनिर्धारित NPI प्रयोग गरिनेछ।
टन | NPI | विवरण |
अल्फान्यूमेरिक (५) | अज्ञात (५०) ISDN (१) |
अल्फान्यूमेरिक प्रेषक पाठको रूपमा व्यवहार गरिनेछ |
अन्तर्राष्ट्रिय (1) | अज्ञात (५०) ISDN (१) |
MSISDN को रूपमा व्यवहार गरिनेछ |
राष्ट्रिय (२) नेटवर्क विशिष्ट (३) ग्राहक संख्या (४) संक्षिप्त (६) |
अज्ञात (५०) ISDN (१) राष्ट्रिय (२) |
देश विशिष्ट छोटो संख्याको रूपमा व्यवहार गरिनेछ। |
4.4.1.2 गन्तव्य
निम्न TON र NPI संयोजनहरू गन्तव्य ठेगानाका लागि समर्थित छन्। अन्य सबै संयोजनहरूलाई अवैध मानिनेछ। यदि TON अज्ञात (0) मा सेट गरिएको छ भने bind आदेशबाट पूर्वनिर्धारित TON प्रयोग हुनेछ। यदि NPI अज्ञात (0) मा सेट गरिएको छ भने bind आदेशबाट पूर्वनिर्धारित NPI प्रयोग हुनेछ।
टन | NPI | विवरण |
अन्तर्राष्ट्रिय (1) | अज्ञात (५०) ISDN (१) |
MSISDN को रूपमा व्यवहार गरिनेछ |
4.4.2 समर्थित एन्कोडिङहरू
निम्न इन्कोडिङहरू समर्थित छन्। X ले कुनै पनि मान समावेश गर्न सक्छ।
DCS | इन्कोडिङ |
०xX० | विस्तारको साथ पूर्वनिर्धारित GSM वर्णमाला |
०xX० | 8-बिट बाइनरी |
०xX० | UCS2 (ISO-10646-UCS-2) |
कोटा
५.१ कोटा समाप्त भयोview
कोटाले निर्दिष्ट समय अन्तराल भित्र पठाउन सकिने SMS सन्देशहरूको अधिकतम संख्या परिभाषित गर्दछ (जस्तै प्रति दिन, हप्ता, महिना, वा अनिश्चित कालसम्म)। प्रत्येक कोटालाई quotaId (UUID) द्वारा विशिष्ट रूपमा पहिचान गरिन्छ र ग्राहकको समय क्षेत्र अनुसार रिसेट गरिन्छ। कोटाहरू देश, क्षेत्र, वा पूर्वनिर्धारित स्तरमा कोटा प्रो मार्फत तोक्न सकिन्छ।file। कोटा म्यापिङ प्रयोग गरेर गतिशील रूपमा कोटा पनि तोक्न सकिन्छ। यसले अभिभावक कोटाआईडी (UUID) र एक अद्वितीय कोटा कुञ्जी (जस्तै, प्रेषक वा प्रयोगकर्ता) लाई एक विशिष्ट कोटाआईडीमा म्याप गर्छ।
तपाईंको स्थानीय समर्थन, तपाईंको तोकिएको खाता प्रबन्धक वा यदि केही निर्दिष्ट गरिएको छैन भने पूर्वनिर्धारित रूपमा कोटा सेट गरिन्छ।
५.२ स्थिति १०६ – कोटा नाघ्यो
निम्न अवस्थामा स्थिति कोड १०६ ("कोटा नाघेको") भएको SMS सन्देश ब्लक हुन सक्छ:
- सन्देशले हालको अन्तराल भित्र यसको सम्बन्धित कोटाआईडीको लागि परिभाषित सीमा नाघ्यो।
- गन्तव्य देश वा क्षेत्रमा कुनै कोटा तोकिएको छैन (अर्थात्, प्रो मा शून्य कोटा म्यापिङको साथ स्पष्ट रूपमा अवरुद्ध गरिएको छ)।file).
- कुनै मिल्दो कोटा छैन र कुनै पूर्वनिर्धारित कोटा परिभाषित गरिएको छैन, परिणामस्वरूप अस्वीकृत हुन्छ।
यी अवस्थाहरूमा, प्रणालीले ग्राहक वा गन्तव्य-आधारित सीमाहरू लागू गर्न र दुरुपयोगबाट बच्न थप सन्देश प्रशोधनलाई रोक्छ।
वितरण रिपोर्ट
सफल/असफल नतिजाको साथ कुनै पनि वा अन्तिम डेलिभरी मात्र समर्थित छैन।
डेलिभरी रिपोर्टमा ढाँचा: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx सम्पन्न मिति: yyMMddHHmm stat:
स्थितिमा उपलब्ध मानहरू:
- DELIVRD
- म्याद सकियो
- अस्वीकार गर्नुहोस्
- UNDELIV
- मेटाइयो
6.1 विस्तारित डेलिभरी रिपोर्ट ढाँचा
डेलिभरी रिपोर्टहरूमा विस्तारित जानकारी तपाईंको बिक्री प्रतिनिधिसँग सम्पर्कमा अनुरोध गर्न सकिन्छ।
डेलिभरी रिपोर्टको ढाँचा: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx उप: ००० dlvrd: ००० बुझाउने मिति:
yyMMddHHmm सम्पन्न मिति: yyMMddHHmm तथ्याङ्क: गल्ती: पाठ:
स्थितिमा उपलब्ध मानहरू:
- DELIVRD
- म्याद सकियो
- अस्वीकार गर्नुहोस्
- UNDELIV
- मेटाइयो
"sub" र "dlvrd" फिल्डहरू सधैं 000 मा सेट हुनेछन्, र "पाठ" फिल्ड सधैं खाली हुनेछ।
"त्रुटि" क्षेत्रका लागि मानहरूको लागि अध्याय त्रुटि कोडहरू हेर्नुहोस्।
समर्थित TLS संस्करणहरू
SMPP मा सबै TLS जडानहरूको लागि TLS 1.2 वा TLS 1.3 आवश्यक छ।
TLS 1.0 र 1.1 को लागि समर्थन 2020-11-15 देखि बन्द गरिएको छ। TLS को संस्करण 1.0 र 1.1 पुराना प्रोटोकलहरू हुन् जुन हटाइएको छ र इन्टरनेट समुदायमा सुरक्षा जोखिमहरू मानिन्छ।
यदि आज अनइन्क्रिप्टेड SMPP जडानहरू प्रयोग भइरहेको छ भने LINK TLS प्रयोग गर्न दृढताका साथ सिफारिस गर्दछ। LINK द्वारा 2020-09-01 सम्म इन्क्रिप्ट नगरिएका SMPP जडानहरू हटाइएको छ, र भविष्यमा हटाइनेछ। एन्क्रिप्टेड जडानहरू हटाउने मिति अझै तय गरिएको छैन।
TLS को लागि SMPP सर्भरमा जडानहरू पोर्ट 3601 मा अनइन्क्रिप्टको सट्टा पोर्ट 3600 मा छ।
तपाईको SMPP कार्यान्वयनले TLS लाई स्टनल प्रयोग गरेर समर्थन नगरे पनि तपाईले अझै पनि TLS प्रयोग गर्न सक्नुहुन्छ, हेर्नुहोस् https://www.stunnel.org/
त्रुटि कोडहरू
यदि फिल्ड सक्षम छ भने निम्न त्रुटि कोडहरूलाई त्रुटि क्षेत्रमा जवाफ दिन सकिन्छ।
त्रुटि कोड | विवरण |
0 | अज्ञात त्रुटि |
1 | अस्थायी मार्ग त्रुटि |
2 | स्थायी मार्ग त्रुटि |
3 | अधिकतम थ्रोटलिङ नाघ्यो |
4 | टाइमआउट |
5 | अपरेटर अज्ञात त्रुटि |
6 | अपरेटर त्रुटि |
100 | सेवा फेला परेन |
101 | प्रयोगकर्ता फेला परेन |
102 | खाता फेला परेन |
103 | अवैध पासवर्ड |
104 | कन्फिगरेसन त्रुटि |
105 | आन्तरिक त्रुटि |
106 | कोटा नाघ्यो |
200 | OK |
1000 | पठाइयो |
1001 | डेलिभर गरियो |
1002 | म्याद सकियो |
1003 | मेटाइयो |
1004 | मोबाइल भरिएको |
1005 | लामबद्ध |
1006 | पुर्याएको छैन |
1007 | डेलिभर भयो, चार्ज ढिलो भयो |
1008 | चार्ज गरियो, सन्देश पठाइएन |
1009 | चार्ज गरिएको छ, सन्देश डेलिभर गरिएको छैन |
1010 | म्याद सकियो, अपरेटर डेलिभरी रिपोर्टको अनुपस्थिति |
1011 | चार्ज गरियो, सन्देश पठाइयो (अपरेटरलाई) |
1012 | टाढाको लाइनमा |
1013 | अपरेटरलाई सन्देश पठाइयो, चार्जिङ ढिलो भयो |
2000 | अवैध स्रोत नम्बर |
2001 | छोटो संख्या स्रोतको रूपमा समर्थित छैन |
2002 | अल्फा स्रोतको रूपमा समर्थित छैन |
2003 | MSISDN स्रोत नम्बरको रूपमा समर्थित छैन |
2100 | गन्तव्यको रूपमा छोटो संख्या समर्थित छैन |
2101 | अल्फा गन्तव्यको रूपमा समर्थित छैन |
2102 | MSISDN गन्तव्यको रूपमा समर्थित छैन |
2103 | सञ्चालन अवरुद्ध |
2104 | अज्ञात सदस्य |
2105 | गन्तव्य अवरुद्ध |
2106 | नम्बर त्रुटि |
2107 | गन्तव्य अस्थायी रूपमा अवरुद्ध |
2108 | अमान्य गन्तव्य |
2200 | चार्जिङ त्रुटि |
2201 | ग्राहकसँग कम ब्यालेन्स छ |
2202 |
बढी शुल्क लिएकोमा (प्रिमियम) ग्राहकलाई प्रतिबन्ध लगाइयो
सन्देशहरू |
2203 |
ग्राहक धेरै सानो छ (यस विशेषको लागि
सामग्री) |
2204 | प्रिपेड ग्राहकलाई अनुमति छैन |
2205 | सेवा सदस्य द्वारा अस्वीकार गरियो |
2206 | ग्राहक भुक्तानी प्रणालीमा दर्ता छैन |
2207 | सदस्य अधिकतम ब्यालेन्समा पुगेका छन् |
2208 | अन्त प्रयोगकर्ता पुष्टिकरण आवश्यक छ |
2300 | फिर्ता गरियो |
2301 |
अवैध वा हराएको कारणले फिर्ता गर्न सकिएन
MSISDN ले |
2302 | म्यासेज आइडी छुटेको कारण फिर्ता गर्न सकिएन |
2303 | फिर्ताको लागि लामबद्ध |
2304 | फिर्ता समय समाप्त |
2305 | फिर्ता विफलता |
3000 | GSM एन्कोडिङ समर्थित छैन |
3001 | UCS2 एन्कोडिङ समर्थित छैन |
3002 | बाइनरी एन्कोडिङ समर्थित छैन |
4000 | डेलिभरी रिपोर्ट समर्थित छैन |
4001 | अवैध सन्देश सामग्री |
4002 | अवैध ट्यारिफ |
4003 | अवैध प्रयोगकर्ता डेटा |
4004 | अवैध प्रयोगकर्ता डेटा हेडर |
4005 | अवैध डेटा कोडिङ |
4006 | अवैध VAT |
4007 | गन्तव्यका लागि असमर्थित सामग्री |
कागजातहरू / स्रोतहरू
![]() |
लिङ्क गतिशीलता SMS API, SMPP API MS Scheduler API [pdf] प्रयोगकर्ता गाइड SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |