SMSBAT RESTful API गाइड

SMSBAT RESTful API को लागि पूर्ण गाइड - तपाईलाई थाहा हुनु पर्ने सबै कुरा।

अन्तिम अद्यावधिक: अगस्त २९, २०२५

SMSBAT RESTful API ले तपाईंलाई विभिन्न प्रकारका सन्देशहरू पठाउन अनुमति दिन्छ: Viber-carousel, Viber-survey, Viber-promo (छवि, भिडियो), Viber व्यापार च्याटहरू, OTP सन्देशहरू (Viber OTP, Flash Call), र तिनीहरूको फलब्याक संस्करणहरू।

नोट: यो आउटबाउन्ड सन्देशको लागि एकीकृत HTTP API हो। यदि तपाईंलाई इनबाउन्ड बट्स (भाइबर बट / टेलिग्राम बट) सँग एकीकरण चाहिन्छ भने, कृपया क्यास्केड एपीआईलाई सन्दर्भ गर्नुहोस्।

१. प्रोटोकल

प्रोटोकल: HTTPS
अनुरोधको मुख्य भाग: JSON वस्तु जसमा सन्देशहरू को एरे समावेश छ।
विधि:
डेटा ल्याउनको लागि GET (सन्देश स्थिति, ब्यालेन्स, आदि)
वस्तुहरू सिर्जना गर्न POST (जस्तै, प्रसारण/डिस्प्याच सुरु गर्दै)
वस्तुहरू परिमार्जन गर्न PATCH

२. प्राधिकरण

हामी तपाईंको सुविधाको लागि धेरै प्राधिकरण विधिहरू प्रदान गर्दछौं: - HTTP आधारभूत प्रमाणीकरण (तपाईंको ड्यासबोर्डबाट लगइन र पासवर्ड)। - अनुकूलन HTTP हेडर X-Authorization-Key एउटा API टोकन समावेश गर्दछ। - HTTP आधारभूत प्रमाणीकरण पासवर्ड फिल्ड API टोकन होल्ड गर्दै (लगइनको रूपमा @ पास गर्नुहोस्)।

एपीआई टोकन ड्यासबोर्डमा प्रयोगकर्ता प्रोफाइल अन्तर्गत उत्पन्न गर्न सकिन्छ।

उदाहरणहरू अनुरोध गर्नुहोस्

आधारभूत प्रमाणीकरणको साथ:

curl -H "Content-Type: application/json" \
  -X POST -d @/path/to/data.json https://api.smsbat.com/bat/messagelist \
  --user user:password

'X-Authorization-Key' सँग:

curl -H "X-Authorization-Key: <token>" \
  -H "Content-Type: application/json" \
  -X POST -d @/path/to/data.json https://api.smsbat.com/bat/messagelist

३. सन्देशहरू पठाउँदै

SMSBAT प्लेटफर्ममा, कुनै पनि सन्देश प्रेषण (एउटा सन्देश पनि) लाई "प्रसारण" (सन्देश सूची) मानिन्छ।

अन्तबिन्दु - विधि: पोस्ट - URL: https://api.smsbat.com/bat/messagelist - हेडर: सामग्री-प्रकार: application/json

आधारभूत पेलोड संरचना:

{
  "messages": [
    {
      "from": "ALPHANAME",
      "to": "380936670003",
      "text": "Check out our new products!",
      "type": "viber_carousel",
      "ttl": 300,
      "messageData": { ... }
    }
  ]
}

प्रत्येक सन्देश वस्तुको लागि आवश्यक क्षेत्रहरू:

बाट: प्रमाणित प्रेषक अल्फा-नाम।
to: प्रापकको फोन नम्बर (E.164 ढाँचा)।
प्रकार: सन्देश प्रकार enum।
पाठ: सन्देशको मुख्य पाठ (वैकल्पिक यदि प्रकारलाई पाठ आवश्यक पर्दैन)।

समर्थित प्रकार मानहरू: - sms - viber_service (वा viber_trans) - viber_promo - viber_carousel - viber_survey - viber_otp - viber_session - फ्लैशकल_कलब्याक - 'फ्लैशकल'

वैकल्पिक साझा क्षेत्रहरू:

customerMessageId: तपाईको आफ्नै प्रणाली भित्र स्ट्रिङ ID (कलब्याक ट्र्याक गर्न प्रयोग गरिन्छ)। प्रति सन्देश अद्वितीय हुनुपर्छ।
dtSend: ISO8601 मिति/समय निर्धारित भविष्यमा पठाउने।
dtExpire: ISO8601 मिति/डिलिवरीको समय सीमा।
ttl: सेकेन्डमा बाँच्नको लागि समय। (यदि dtExpire प्रदान गरिएको छैन भने, API ले type बाट पूर्वनिर्धारित म्यापिङ गणना गर्दछ)।

पूर्वनिर्धारित TTLs (सेकेन्ड):

sms - ८६४०० (२४ घन्टा)
viber_trans / viber_service - ३४५६००
viber_promo - ६०४८००
viber_session - ६०४८००

4. फलब्याक रूटिङ (क्यास्केडिङ)

यदि प्राथमिक च्यानल असफल वा म्याद समाप्त हुन्छ भने सन्देश डेलिभरी सुनिश्चित गर्न तपाईंले फलब्याक लाम निर्दिष्ट गर्न सक्नुहुन्छ।

प्रदायकले मुख्य सन्देश अस्वीकार गर्दा वा TTL समाप्त href="#__codelineno-3-1">{ "messages": [ { "from": "ALPHANAME", "to": "380500505051", "text": "test message", "type": "viber_service", "ttl": 60, "fallbacks": [ { "from": "ALPHANAME", "to": "380936670003", "text": "test sms fallback message2", "type": "sms" } ] } ] } हुँदा फलब्याक ट्रिगर हुन्छ।

५. सन्देशका प्रकार र सन्देश डेटाको अवलोकन

जटिल सन्देश प्रकारहरूलाई messageData गुणमा इन्जेक्ट गरिएको अतिरिक्त कन्फिगरेसन आवश्यक हुन्छ।

५.१ भाइबर प्रोमो (`viber_promo`)

छवि मात्र

"messageData":{
  "img":"https://domain.com/image.png"
}

पाठ + बटन

"messageData":{
  "buttonText":"Save Now",
  "buttonAction":"https://help.smsbat.com"
}

छवि + पाठ + बटन img, buttonText, र buttonAction जोड्छ।

भिडियो पेलोड:

"messageData":{
  "video": "https://domain.com/test.mp4",
  "thumbnail": "https://domain.com/carusel.png",
  "fileSize": 12000000,
  "duration": 30
}

(तपाईँले बटन टेक्स्ट र बटन कार्य सँग भिडियो गुणहरू पनि संयोजन गर्न सक्नुहुन्छ)।

५.२ भाइबर लेनदेन / सेवा (`viber_trans`, `viber_service`)

यदि तपाइँसँग संलग्न फाइल समावेश अनुमोदित टेम्प्लेट छ भने:

"messageData": {
  "fileUrl": "https://domain.com/receipt.pdf",
  "fileName": "Receipt.pdf",
  "fileType": "pdf"
}

५.३ Viber Carousel (`viber_carousel`)

messageData भित्र carousel.items array आवश्यक छ।

सीमाहरू: - वस्तुहरूको लम्बाइ: 2 र 5 वस्तुहरू बीच - शीर्षक: 2 देखि 38 वर्णहरू - imageUrl: JPEG/PNG सिफारिस गरिएको साइज २१५x१८५

"messageData": {
  "carousel": {
    "items": [
      {
        "title": "50% Off Shoes!",
        "imageUrl": "https://domain.com/image1.png",
        "primaryButton": { "label": "Shop", "actionUrl": "..." },
        "secondaryButton": { "label": "Details", "actionUrl": "..." }
      }
    ]
  }
}

५.४ भाइबर सर्वेक्षण / सूची (`viber_survey`)

च्याट दृश्य भित्र अन्तरक्रियात्मक सर्वेक्षण सिर्जना गर्दछ।

"messageData": {
  "survey": {
    "options": [
      "Excellent", "Good", "Normal", "Bad", "Terrible"
    ]
  }
}

सन्देशको पाठ गुणले सर्वेक्षण शीर्षकको रूपमा कार्य गर्दछ (अधिकतम ८५ वर्णहरू)। तपाईं 2 र 5 विकल्पहरू बीचमा पास गर्न सक्नुहुन्छ, प्रत्येक अधिकतम 50 वर्णहरू।

५.५ Viber OTP (`viber_otp`)

विश्वव्यापी रूपमा पूर्व-दर्ता गरिएको स्थानीयकृत भाइबर टेम्प्लेटहरू प्रयोग गर्दछ।

"messageData": {
  "templateId": "6c929cef-29b4-4349-bc9d-2a07bdbb6e43",
  "templateLang": "uk",
  "templateParams": {
    "pin": "3211",
    "business_platform_name": "SMSBAT",
    "code_validity_time": 7
  }
}

टेम्प्लेट प्यारामिटरहरू (pin, business_platform_name) कडा रूपमा केस-संवेदनशील हुन्छन्। API ले विभिन्न ISO कोड भाषा भेरियन्टहरूलाई समर्थन गर्दछ (EN, ES, RU, TR, UK, आदि)।

५.६ फ्ल्यास कल (`फ्ल्याशकल`)

डायलिङ नम्बरको अन्तिम अंकहरू (उत्पन्न गरिएको कोड) पाठ प्यारामिटर मार्फत पास गरिनुपर्छ। यदि पाठ हटाइयो भने, कोड अनियमित हुन्छ र तपाईंले यसलाई API को सिंक्रोनस 200 ओके रेस्पोन्स बडी (सन्देश/पाठ) बाट निकाल्नु पर्छ।

{
  "from": "FLASHCALL",
  "to": "380500000000",
  "type": "flashcall",
  "text": "340"
}