API दस्तावेज़

API प्रलेखन

API प्रोटोकॉल तर्क का संक्षिप्त विवरण

उपलब्ध फोन नंबरों की संख्या के लिए अनुरोध विधि GET_SERVICES

नंबर अनुरोध विधि GET_NUMBER

SMSBOWER सर्वर पर SMS भेजने की विधि – PUSH_SMS

सक्रियता समाप्त करने के लिए अनुरोध विधि FINISH_ACTIVATION

प्रोटोकॉल परीक्षण

स्थिति तालिकाएं

डेटा तालिकाएं

API प्रोटोकॉल तर्क का संक्षिप्त विवरण

पार्टनर प्रोटोकॉल फोन नंबर और आने वाले SMS संदेश API के माध्यम से सीधे SMSBOWER सर्वर को प्रदान करने के लिए डिज़ाइन किया गया है .

सभी अनुरोधों में पैरामीटर - KEY शामिल होता है। यह कुंजी सपोर्ट स्टाफ द्वारा प्रदान की जाती है और व्यक्तिगत खाते में उपलब्ध है .

मात्रा अनुरोध GET_SERVICES, नंबर अनुरोध GET_NUMBER और सक्रियण पूरा करना

FINISH_ACTIVATION हमारे सर्वर से सीधे पार्टनर के सर्वर पर भेजे जाते हैं .

URL प्रारूप — https://SMSBOWER जहाँ SMSBOWER हो सकता है partner.ru:port/SMSBOWER या partner.ru/SMSBOWER.php

GET_SERVICES

GET_NUMBER

PUSH_SMS

FINISH_ACTIVATION

SMSBOWER सर्वर फोन नंबर की मात्रा के लिए अनुरोध भेजता है GET_SERVICES लगभग हर 10-20 सेकंड में.

यदि आप प्रतिक्रिया में संख्या > 0 देते हैं, तो आपको फोन नंबर जारी करने के लिए अनुरोध मिलेगा GET_NUMBER

प्राप्त करने के बाद GET_NUMBER आपको सभी मानदंडों को पूरा करने वाला फोन नंबर प्रदान करना होगा और सभी आने वाले SMS संदेश हमें भेजने होंगे PUSH_SMS. यह स्पष्ट और वस्तुनिष्ठ फ़िल्टरिंग करने और हमारे ग्राहकों के लिए सही सेवा को SMS संदेश भेजने के लिए आवश्यक है.

फोन नंबरों से संबंधित सभी आवश्यक कार्य पूरे होने पर, आपको स्थिति 3 प्राप्त होगी FINISH_ACTIVATION. यह स्थिति बताती है कि फोन नंबर सफलतापूर्वक पंजीकृत हो गया है, और आपको इसके लिए पुरस्कार मिला है.

आवश्यकताएं

अनुरोध/प्रतिक्रिया प्रारूप: JSON
UTF-8 एन्कोडिंग
SMSBOWER सर्वर को अनुरोध करते समय हमेशा user-agent हेडर का उपयोग करें
सभी अनुरोधों/प्रतिक्रियाओं पर gzip संपीड़न विधि लागू करें

फ़ील्ड प्रकार:

int - पूर्णांक मान
-2,147,483,648 से 2,147,483,647 तक
Uint - बिना साइन वाला पूर्णांक मान
0 से 2,147,483,647 तक
long - पूर्णांक मान
-9,223,372,036,854,775,808 से 9,223,372,036,854,775,807 तक
Ulong - बिना साइन वाला लंबा पूर्णांक मान
0 से 9,223,372,036,854,775,807 तक
cur - वास्तविक मान जिसमें 2 दशमलव तक होते हैं, जैसे 177.77 ;
boolean - सच्चा या गलत मान
string - असीमित लंबाई वाला स्ट्रिंग मान

उपलब्ध फोन नंबरों की संख्या के लिए अनुरोध विधि GET SERVICES

यह अनुरोध हमें बिक्री के लिए उपलब्ध सेवा के फोन नंबर की मात्रा की जानकारी देता है .

POST अनुरोध SMSBOWER सर्वर से पार्टनर सर्वर को भेजा जाता है .

! कृपया ध्यान दें: यदि आपके GSM मोडेम में एक साथ सक्रिय मॉड्यूल की संख्या सीमित है, तो आपको सक्रिय मॉड्यूल की संख्या के बराबर संख्या प्रदान करनी चाहिए सक्रिय मॉड्यूल.

अनुरोध फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
action	String		GET_SERVICES
key	String		प्रोटोकॉल कुंजी

प्रतिक्रिया फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
status	String		प्रतिक्रिया की स्थिति (देखें स्थिति तालिकाएं)
countryList	Array		देशों की सूची

CountryList

फ़ील्ड	प्रकार	आवश्यकता	विवरण
country	String		प्रतिक्रिया की स्थिति (देखें Status Table)
operatorMap*	एसोसिएटिव एरे		कुंजी - ऑपरेटर (देखें डेटा तालिकाएं), मूल्य - सेवाओं का एसोसिएटिव एरे **

अनुरोध का उदाहरण


            {
     "action": "GET_SERVICES",
     "key": "qwerty123"
}

कॉपी किया गया

प्रतिक्रिया का उदाहरण


            {
     "countryList":
     [
          {
              "country": "russia",
               "operatorMap":
               {
                    "beeline":
                    {
                         "ok": 15,
                         "wa": 20
                    },
                    "megafon":
                    {
                         "vk": 3,
                         "ok": 10
                    }
               }
          },
          {
               "country": "ukraine",
               "operatorMap":
               {
                    "life":
                    {
                         "vk": 0,
                         "wa": 32
                    }
               }
          }
     ],
     "status": "SUCCESS"
}

कॉपी किया गया

नंबर अनुरोध विधि GET_NUMBER

यह अनुरोध हमें एक फोन नंबर देता है जिसे हम ग्राहक को देते हैं .

POST अनुरोध SMSBOWER सर्वर से पार्टनर सर्वर को भेजा जाता है .

यदि exceptionPhoneSet एरे में कुछ उपसर्ग हैं, जैसे 44742 और 44740, तो आपको नहीं ऐसे नंबर प्रदान नहीं करने चाहिए जो इन उपसर्गों से शुरू होते हों। अंक की संख्या उपसर्ग के आकार से सीमित नहीं है .

अनुरोध फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
action	String		GET_NUMBER
key	String		डेटा तालिका
country	String		डेटा तालिका
service	String		डेटा तालिका
operator	String		प्रोटोकॉल कुंजी
sum	Cur		सफलतापूर्वक पंजीकृत सेवा के लिए आपको प्राप्त राशि
exceptionPhoneSet	Array		उपसर्गों की सूची जो प्रतिबंधित

प्रतिक्रिया फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
status	String		प्रतिक्रिया की स्थिति (देखें स्थिति तालिकाएं)
number	Ulong		देश कोड सहित फोन नंबर
activationId	Ulong		पार्टनर सिस्टम में सक्रियण ID
call	String		नंबर के लिए फ्लैश कॉल उपलब्ध है
voice	String		नंबर के लिए वॉइस कॉल उपलब्ध है

अनुरोध का उदाहरण


            {
     "action": "GET_NUMBER",
     "key": "qwerty123",
     "country": "russia",
     "operator": "beeline",
     "service": "tg",
     "sum": "20.00"
}

कॉपी किया गया

प्रतिक्रिया का उदाहरण


            {
      "number": "79156537788",
      "activationId": "36532",
      "status": "SUCCESS",
      "call": "1",
      "voice": "1"
}

कॉपी किया गया

अनुरोध का उदाहरण


            {
      "action": "GET_NUMBER",
      "key": "qwerty123",
      "country": "russia",
      "operator": "any",
      "service": "vk",
      "sum": "10",
      "exceptionPhoneSet":
      [
          "7918",
          "79281",
      ]
}

कॉपी किया गया

SMSBOWER सर्वर पर SMS भेजने की विधि PUSH_SMS

यह POST अनुरोध पार्टनर के सर्वर से SMSBOWER सर्वर को भेजा जाता है : https://smsbower.online/agent/api/sms

यदि आपको स्थिति के साथ प्रतिक्रिया मिलती है SUCCESS, तो SMS को सफलतापूर्वक वितरित के रूप में चिह्नित करें और दोबारा न भेजें . यदि स्थिति SUCCESS के अलावा लौटाया जाता है, अनुरोध को दोहराएं 10 सेकंड की देरी के साथ जब तक आपको SUCCESS स्थिति प्राप्त न हो .

अनुरोध का उदाहरण

फ़ील्ड	प्रकार	आवश्यकता	विवरण
action	String		PUSH_SMS
key	String		प्रोटोकॉल कुंजी
smsId	Ulong		पार्टनर सिस्टम में SMS की ID
phone	Ulong		SMS भेजे गए फोन नंबर (देश कोड सहित)
phoneFrom	String		प्रेषक का नाम (अक्षर या संख्यात्मक हो सकता है) जिसने SMS भेजा
text	String		SMS टेक्स्ट
voice	Boolean		यह अनुरोध फ्लैश कॉल है
call	Boolean		यह अनुरोध वॉइस कॉल है

प्रतिक्रिया फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
status	String		प्रतिक्रिया की स्थिति (देखें स्थिति तालिकाएं)

अनुरोध का उदाहरण


            {
     "action": "PUSH_SMS",
     "key": "qwerty123",
     "smsId": 1,
     "phone": 447472190082,
     "phoneFrom": "Microsoft",
     "text": "Microsoft access code: 5015"
     "call": "0",
     "voice": "0"
}

कॉपी किया गया

Example of a flash call request


            {
     "action": "PUSH_SMS",
     "key": "qwerty123",
     "smsId": 1,
     "phone": 447472190082,
     "phoneFrom": "446756540011",
     "text": "446756540011"
     "call": "1",
     "voice": "0"
}

कॉपी किया गया

Example of a voice call request


            {
     "action": "PUSH_SMS",
     "key": "qwerty123",
     "smsId": 1,
     "phone": 447472190082,
     "phoneFrom": "446756540011",
     "text": "12345"
     "call": "0",
     "voice": "1"
}

कॉपी किया गया

प्रतिक्रिया फ़ील्ड


            {
      "status": "SUCCESS"
}

कॉपी किया गया

सक्रियता समाप्त करने के लिए अनुरोध विधि FINISH_ACTIVATION

यह अनुरोध SMSBOWER सर्वर से पार्टनर सर्वर को भेजा जाता है ताकि पूरा करें सक्रियण.

POST अनुरोध शुरू किया गया SMSBOWER पार्टनर सर्वर को.

सक्रियण प्रबंधन पूरी तरह से नियंत्रित है SMSBOWER. हमारे नियंत्रण से बाहर कारणों के कारण, हमें आपके द्वारा सफल स्थिति परिवर्तन की प्रतिक्रिया न मिल सके। इसलिए, यदि SMSBOWER पुनः सक्रियण पूर्णता अनुरोध भेजता है, तो आपको सक्रियण की उपस्थिति की जांच करनी चाहिए ID आपकी ओर। यदि सक्रियण मौजूद है, तो स्थिति भेजें SUCCESS प्रतिक्रिया में.

अनुरोध फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
action	String		FINISH_ACTIVATION
key	String		प्रोटोकॉल कुंजी
activationId	Ulong		दूसरे अनुरोध में प्राप्त सक्रियण ID
status	Unit		प्रतिक्रिया की स्थिति (देखें स्थिति तालिकाएं)

प्रतिक्रिया फ़ील्ड

फ़ील्ड	प्रकार	आवश्यकता	विवरण
status	String		प्रतिक्रिया की स्थिति (देखें स्थिति तालिकाएं)

अनुरोध का उदाहरण


            {
     "action": "FINISH_ACTIVATION",
     "key": "qwerty123",
     "activationId": 100,
     "status": 3,
}

कॉपी किया गया

प्रतिक्रिया का उदाहरण


            {
      "status": "SUCCESS"
}

कॉपी किया गया

प्रोटोकॉल परीक्षण

प्रोटोकॉल लागू करने के बाद, आपको संपर्क करना होगा हमारी तकनीकी सहायता टीम से संपर्क करें, प्रदान करें URL, और हमारी टीम परीक्षण करेगी। यदि सत्यापन सफल होता है, तो आप सफलतापूर्वक SMSBOWER से जुड़ जाएंगे .

समानांतर नंबर जारी करना

आपको समानांतर अनुरोधों को सही तरीके से संभालना चाहिए और नंबर दोहराकर नहीं जारी करने चाहिए। उदाहरण के लिए, यदि आपके पास Telegram यूनाइटेड किंगडम के लिए 100 नंबर हैं, और SMSBOWER एक साथ 100 अनुरोध करता है, तो पार्टनर सर्वर को 100 अद्वितीय नंबर जारी करने चाहिए। यदि कोई नंबर कई बार जारी किया गया, तो परीक्षण विफल होगा .

सही सक्रियण पूर्णता

सक्रियण स्थिति में परिवर्तन पूरी तरह SMSBOWER द्वारा नियंत्रित होता है। पार्टनर सर्वर को नहीं स्वतंत्र रूप से सक्रियण पूरा करना चाहिए.

SMS वितरण सत्यापन

जैसे ही आपको SMS प्राप्त हो, आपको तुरंत इसे SMSBOWER सर्वर को अग्रेषित करना चाहिए। यदि आपको SUCCESS स्थिति मिलती है, तो आपको SMS फिर से अग्रेषित नहीं करना चाहिए। यदि स्थिति अलग हो, तो हर 10-20 सेकंड में पुनः प्रयास करें। SUCCESS स्थिति मिलने के बाद यदि SMS फिर से भेजा गया, तो परीक्षण विफल होगा .

फ़ील्ड प्रकार सत्यापन

ध्यानपूर्वक जांचें फ़ील्ड के प्रकार, जो इस दस्तावेज़ में दिए गए हैं। यदि यह शर्त उल्लंघन होती है, तो परीक्षण विफल होगा .

फोन नंबर में देश कोड

फोन नंबर जारी करना डिजिटल फ़ॉर्मेट में होना चाहिए और देश कोड शामिल होना चाहिए .

नंबर जारी करने का समय सत्यापन

आपको नंबर इस विलंब के साथ जारी करने चाहिए कम 3 सेकंड से। यदि यह 3 सेकंड से अधिक होता है, तो परीक्षण विफल होगा .

नंबर मात्रा सत्यापन

यदि आप संख्या अनुरोध में 1000 नंबर दिखाते हैं, लेकिन केवल 100 नंबर एक साथ जारी करते हैं, तो परीक्षण विफल होगा .

अपवाद हैंडलिंग सत्यापन

यदि आप नंबर जारी करते समय अपवादों को गलत तरीके से संभालते हैं, तो परीक्षण विफल होगा .

प्रतिक्रिया स्थिति

स्थिति	विवरण
SUCCESS	अनुरोध सफलतापूर्वक पूरा हुआ सफलतापूर्वक
ERROR	त्रुटि अनुरोध निष्पादन के दौरान। ERROR फ़ील्ड में विवरण भरना चाहिए
NO_NUMBER	कोई नंबर उपलब्ध नहीं है। यह प्रतिक्रिया केवल अनुरोध के लिए वापस की जाती है नंबर.

सक्रियण स्थिति

स्थिति	विवरण
1	इस सेवा के लिए नंबर जारी करना प्रतिबंधित है
3	सक्रियण था सफलतापूर्वक बेचा गया। आपको इनाम मिला है
4	सक्रियण था रद्द किया गया*
5	सक्रियण किया गया है वापस किया गया. ग्राहक को सक्रियण के लिए धनवापसी मिली है। संभव है कि यह नंबर पहले से पंजीकृत हो, और दो-कारक प्रमाणीकरण सक्रिय हो

* रद्द करने की प्रक्रिया इस प्रकार काम करती है: यदि नंबर 5 बार रद्द किया गया हो, तो आपको वह नंबर दोबारा जारी नहीं करना चाहिए। संभव है कि नंबर ग्राहक के लिए उपयुक्त न हो या पहले से किसी सेवा के लिए पंजीकृत हो.

अनुरोध का सफल उत्तर


            {
     "status": "SUCCESS",
     //सूचना
}

कॉपी किया गया

त्रुटि की स्थिति में उत्तर


            {
      "status": "ERROR",
      "error": "त्रुटि का विवरण"
}

कॉपी किया गया

डेटा तालिकाएं

देशों की सूची

देशों की पूरी सूची नामों और ID के साथ इस लिंक पर है https://smsbower.org /api#countries.

ऑपरेटरों की सूची

फिलहाल, ऑपरेटरों के अनुसार विवरण विकासाधीन है, इसलिए आपको मान देना चाहिए any. जैसे ही यह कार्यक्षमता लागू होती है, हम सूचित करेंगे तकनीकी सहायता चैट के माध्यम से आपको .

सेवाओं की सूची

सेवाओं की पूरी सूची नामों और ID के साथ इस लिंक पर है https://smsbower.org /api#services

Example Postman