Skip to content

सन्देश पठाउनुहोस्

/bat/messagelist अन्त्यबिन्दु प्रयोग गरेर SMSBAT API मार्फत सन्देशहरू पठाउनुहोस्।

अन्तिम बिन्दु

POST /bat/messagelist

अनुरोध संरचना

अनुरोधको मुख्य भाग सन्देश वस्तुहरूको JSON एरे हो:

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Your message text",
      "customerMessageId": "your-internal-id",
      "ttl": 3600
    }
  ]
}

प्यारामिटरहरू

आवश्यक प्यारामिटरहरू

प्यारामिटर प्रकार विवरण
'बाट' स्ट्रिङ अल्फान्यूमेरिक प्रेषक ID
to स्ट्रिङ प्रापकको फोन नम्बर E.164 ढाँचामा (जस्तै, +380XXXXXXXXX)
प्रकार स्ट्रिङ सन्देश प्रकार: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
पाठ स्ट्रिङ सन्देश सामग्री (धेरै प्रकारका लागि आवश्यक, केहि को लागी वैकल्पिक)

वैकल्पिक प्यारामिटरहरू

प्यारामिटर प्रकार विवरण
'customerMessageId' स्ट्रिङ ट्र्याकिङको लागि तपाईंको आन्तरिक पहिचानकर्ता
ttl पूर्णांक सेकेन्डमा बाँच्ने समय
messageData वस्तु प्रकार-विशिष्ट कन्फिगरेसन (सन्देश प्रकार अनुसार भिन्न हुन्छ)

प्रमाणीकरण

तीन प्रमाणीकरण विधिहरू मध्ये एउटा छान्नुहोस्:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'

प्रतिक्रिया

सफलताको प्रतिक्रिया

{
  "messagelistId": 123456,
  "messages": [
    {
      "messageId": "abc123def456",
      "status": "accepted",
      "parts": 1,
      "customerMessageId": "your-internal-id",
      "to": "+380XXXXXXXXX"
    }
  ]
}

प्रतिक्रिया क्षेत्रहरू

क्षेत्र प्रकार विवरण
'messagelistId' पूर्णांक सन्देश सूचीको लागि अद्वितीय पहिचानकर्ता
'messageId' स्ट्रिङ प्रत्येक सन्देशको लागि अद्वितीय पहिचानकर्ता
'स्थिति' स्ट्रिङ सन्देश स्थिति: स्वीकार गरिएको, अस्वीकृत, असफल
भाग पूर्णांक सन्देशका भागहरूको संख्या (एसएमएसका लागि)
'customerMessageId' स्ट्रिङ तपाईंको आन्तरिक पहिचानकर्ता (यदि प्रदान गरिएको छ)
to स्ट्रिङ प्रापकको फोन नम्बर

सन्देशका प्रकारहरू

SMS

सरल पाठ सन्देशहरू:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "sms",
  "text": "Your SMS message text"
}

भाइबर प्रोमो

रिच मिडिया संग प्रचार सन्देशहरु:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_promo",
  "text": "Check out our new product!",
  "messageData": {
    "image": "https://example.com/image.jpg",
    "button": {
      "text": "View Product",
      "url": "https://example.com/product"
    }
  }
}

भाइबर लेनदेन

लेनदेन सूचनाहरू:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_trans",
  "text": "Your order #12345 has been confirmed"
}

Viber OTP

एक पटक पासवर्ड सूचनाहरू:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_otp",
  "messageData": {
    "code": "123456",
    "validity": 300
  }
}

त्रुटि ह्यान्डलिंग

HTTP स्थिति कोडहरू

कोड विवरण
२०० अनुरोध सफल
400 खराब अनुरोध - अमान्य प्यारामिटरहरू
४०१ अनाधिकृत - प्रमाणीकरण असफल
४२९ धेरै अनुरोधहरू - दर सीमा नाघ्यो
५०० आन्तरिक सर्भर त्रुटि

त्रुटि प्रतिक्रिया

{
  "error": {
    "code": "INVALID_RECIPIENT",
    "message": "Invalid phone number format"
  }
}

उत्तम अभ्यासहरू

फोन नम्बर ढाँचा

फोन नम्बरहरूको लागि सधैं E.164 ढाँचा प्रयोग गर्नुहोस्:

  • ✅ सही: +380XXXXXXXXX
  • ❌ गलत: 380XXXXXXXXX, 0XXXXXXXXX

सन्देश पाठ

  • धेरै भागहरूबाट बच्नको लागि 160 क्यारेक्टरहरू भन्दा कम एसएमएस राख्नुहोस्
  • अन्तर्राष्ट्रिय क्यारेक्टरहरूको लागि UTF-8 इन्कोडिङ प्रयोग गर्नुहोस्
  • बल्क पठाउनु अघि विशेष क्यारेक्टरहरू परीक्षण गर्नुहोस्

TTL (समय-टु-लाइभ)

  • समय-संवेदनशील सन्देशहरूको लागि उपयुक्त TTL सेट गर्नुहोस्
  • OTP सन्देशहरू: 300-600 सेकेन्ड (5-10 मिनेट)
  • प्रचार सन्देशहरू: 3600-86400 सेकेन्ड (1-24 घण्टा)

ग्राहक सन्देश ID

  • प्रत्येक सन्देशको लागि अद्वितीय पहिचानकर्ताहरू प्रयोग गर्नुहोस्
  • ट्र्याकिङ र डिबगिङको साथ मद्दत गर्दछ
  • तपाइँको प्रणाली को रेकर्ड संग सम्बन्ध को लागी उपयोगी

दर सीमा

यस बारे जानकारीको लागि आफ्नो खाता प्रबन्धकलाई सम्पर्क गर्नुहोस्:

  • प्रति सेकेन्ड सन्देशहरू
  • प्रति दिन सन्देशहरू
  • समवर्ती जडानहरू

अर्को चरणहरू