Messagio API अनुकूलता

SMSBAT ले Messagio API सँग अनुकूलता तहलाई समर्थन गर्दछ। यसले तपाइँलाई तपाइँको पेलोड संरचना पुन: लेख्न वा एकीकरण तर्क परिवर्तन नगरीकन मेसेजियोको लागि डिजाइन गरिएको तपाइँको अवस्थित भाइबर एकीकरणलाई सीधा SMSBAT मा स्थानान्तरण गर्न अनुमति दिन्छ।

---

जडान सेटिङहरू

SMSBAT मार्फत अनुरोधहरू रुट गर्न, तपाईंको एकीकरणमा आधार URL र प्रमाणीकरण प्रमाणहरू अद्यावधिक गर्नुहोस्:

• आधार URL: https://restapi.smsbat.com
• अन्तबिन्दु: POST /api/SendMessage
• अनुरोध ढाँचा: अनुप्रयोग/x-www-form-urlencoded (फारम डाटा)

---

प्रमाणीकरण र प्रमाणहरू

अनुरोधहरू सीधा अनुरोध शरीर फारम डेटा भित्र पठाइएका प्यारामिटरहरू प्रयोग गरेर प्रमाणीकरण गरिन्छ:

प्यारामिटर	प्रकार	आवश्यक	विवरण
'प्रयोगकर्ता'	स्ट्रिङ	हो	तपाईंको SMSBAT खाता लगइन वा प्रयोगकर्ता पहिचानकर्ता।
चिन्ह	स्ट्रिङ	हो	API गोप्य वा हस्ताक्षर प्रेषक नाम को लागी दर्ता।
'बाट'	स्ट्रिङ	हो	दर्ता प्रेषक अल्फा नाम।
पठाउने_विधि	स्ट्रिङ	हो	च्यानल प्रकार। नियमित Viber व्यापार सन्देशहरूको लागि viber प्रयोग गर्नुहोस् वा Viber OTP टेम्प्लेटहरूको लागि viber_otp प्रयोग गर्नुहोस्।
फोन	स्ट्रिङ	हो	अन्तर्राष्ट्रिय ढाँचामा प्रापकको फोन नम्बर (जस्तै, ३८०५०१२३४५६७)।

---

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

विशिष्ट प्यारामिटरहरू हेर्न तलको ट्याब छान्नुहोस् र विभिन्न भाइबर सन्देश संरचनाहरूको लागि पेलोडहरू अनुरोध गर्नुहोस्:

पाठ सन्देशपाठ + बटनछवि सन्देशपाठ + छवि + बटनभिडियो सन्देशOTP टेम्प्लेट

एक साधारण पाठ सन्देश पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
txt	स्ट्रिङ	हो	सन्देश पाठ।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hello+from+SMSBAT%21

अन्तरक्रियात्मक कल-टु-एक्शन बटनको साथ पाठ सन्देश पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
txt	स्ट्रिङ	हो	सन्देश पाठ।
बटन_टेक्स्ट	स्ट्रिङ	हो	बटनमा पाठ प्रदर्शित हुन्छ।
बटन_लिंक	स्ट्रिङ	हो	बटन क्लिक गर्दा गन्तव्य URL।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Check+our+latest+offers%21&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

सार्वजनिक छवि फाइल पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
छवि_लिङ्क	स्ट्रिङ	हो	छविको सार्वजनिक HTTPS URL।
txt	स्ट्रिङ	छैन	छवि तल प्रदर्शन गर्न वैकल्पिक क्याप्शन पाठ।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png

पाठ, छवि, र बटन समावेश रिच कार्ड पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
txt	स्ट्रिङ	हो	क्याप्सन पाठ।
छवि_लिङ्क	स्ट्रिङ	हो	छविको सार्वजनिक HTTPS URL।
बटन_टेक्स्ट	स्ट्रिङ	हो	बटनमा पाठ प्रदर्शित हुन्छ।
बटन_लिंक	स्ट्रिङ	हो	बटन क्लिक गर्दा गन्तव्य URL।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hot+deals+inside%21&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

वैकल्पिक टेक्स्ट क्याप्सन र कार्य बटनहरूको साथ भिडियो फाइल पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
video.url	स्ट्रिङ	हो	भिडियो फाइलको सार्वजनिक HTTPS URL।
video.thumbnail	स्ट्रिङ	हो	भिडियो पूर्वावलोकन छविको सार्वजनिक HTTPS URL।
video.size_mb	पूर्णांक	हो	मेगाबाइटमा अनुमानित भिडियो फाइल आकार।
video.duration_sec	पूर्णांक	हो	सेकेन्डमा भिडियो अवधि।
txt	स्ट्रिङ	छैन	वैकल्पिक वर्णन पाठ।
बटन_टेक्स्ट	स्ट्रिङ	छैन	वैकल्पिक बटन पाठ (क्याप्शन वा लिङ्कको रूपमा कार्य गर्न सक्छ)।
बटन_लिंक	स्ट्रिङ	छैन	वैकल्पिक बटन लिङ्क URL।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Watch+this+tutorial%21&video.url=https%3A%2F%2Fwww.example.com%2Fvideo.mp4&video.thumbnail=https%3A%2F%2Fwww.example.com%2Fvideo-thumbnail.png&video.size_mb=1&video.duration_sec=3&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

पूर्व-अनुमोदित टेम्प्लेट प्रयोग गरेर Viber वन-टाइम पासवर्डहरू (OTP) पठाउँछ।

!!! नोट OTP सन्देशहरू पठाउँदा, तपाईंले sending_method लाई viber_otp मा सेट गर्नुपर्छ।

अतिरिक्त प्यारामिटरहरू:

| प्यारामिटर | प्रकार | आवश्यक | विवरण |
| :--- | :--- | :--- | :--- |
| `template.id` | स्ट्रिङ | **हो** | पूर्व-अनुमोदित Viber OTP टेम्प्लेट ID। |
| `template.lang` | स्ट्रिङ | **हो** | टेम्प्लेट भाषा कोड (जस्तै, `en`, `uk`)। |
| `template.params.pin` | स्ट्रिङ | **हो** | टेम्प्लेटमा इन्जेक्सन गर्नको लागि OTP पिन मान। |
| `template.params.business_platform_name` | स्ट्रिङ | **हो** | टेम्प्लेटमा व्यवसाय नाम प्लेसहोल्डर। |
| `template.params.code_validity_time` | स्ट्रिङ | **हो** | मिनेटमा PIN वैधता अवधि। |

** अनुरोध पेलोड उदाहरण:**
```http
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber_otp&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&template.id=otp_template_123&template.lang=en&template.params.pin=123456&template.params.business_platform_name=SMSBAT&template.params.code_validity_time=7
```

क्यारोसेल सन्देशसर्वेक्षण सन्देश

प्रयोगकर्ताले स्वाइप गर्न सक्ने बहु स्लाइडहरू (कार्डहरू) समावेश भएको अन्तरक्रियात्मक सन्देश कार्ड पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
txt	स्ट्रिङ	हो	क्यारोसेलको शीर्षक पाठ।
carousel[N].title	स्ट्रिङ	हो	कार्डको शीर्षक N (० बाट सुरु हुने)।
carousel[N].image_url	स्ट्रिङ	हो	कार्ड N को सार्वजनिक HTTPS छवि URL।
carousel[N].primary_label	स्ट्रिङ	हो	कार्ड N को मुख्य बटन क्याप्सन।
carousel[N].primary_url	स्ट्रिङ	हो	कार्ड N को मुख्य बटन लिङ्क URL।
carousel[N].secondary_label	स्ट्रिङ	छैन	कार्ड N को माध्यमिक बटन क्याप्सन।
carousel[N].secondary_url	स्ट्रिङ	छैन	कार्ड N को माध्यमिक बटन लिङ्क URL।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Top+picks+for+you&carousel%5B0%5D.title=First+Offer&carousel%5B0%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-1.png&carousel%5B0%5D.primary_label=Open&carousel%5B0%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-1&carousel%5B0%5D.secondary_label=Details&carousel%5B0%5D.secondary_url=https%3A%2F%2Fwww.example.com%2Fitem-1%2Fdetails&carousel%5B1%5D.title=Second+Offer&carousel%5B1%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-2.png&carousel%5B1%5D.primary_label=Open&carousel%5B1%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-2

अन्तरक्रियात्मक सर्वेक्षण वा सर्वेक्षण प्रश्न समावेश सन्देश पठाउँछ।

अतिरिक्त प्यारामिटरहरू:

प्यारामिटर	प्रकार	आवश्यक	विवरण
txt	स्ट्रिङ	हो	सर्वेक्षण प्रश्न पाठ।
सर्वे_विकल्पहरू[N]	स्ट्रिङ	हो	वस्तु N को लागि सर्वेक्षण विकल्प पाठ (0 बाट सुरु हुने अनुक्रमणिका)। कम्तिमा 2 विकल्प आवश्यक छ।
option_type	पूर्णांक	हो	चयनकर्ताको प्रकार: १ (रेडियो बटन) वा २ (नियमित बटनहरू)।

** अनुरोध पेलोड उदाहरण:**

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Please+rate+our+service&survey_options%5B0%5D=Excellent&survey_options%5B1%5D=Good&survey_options%5B2%5D=Average&option_type=1

---

प्रतिक्रिया ढाँचा

Messagio API कम्प्याटिबिलिटी एन्डपोइन्टले XML ढाँचा मा HTTP 200 OK स्थिति कोडको साथ प्रतिक्रियाहरू फर्काउँछ।

स्वीकृत (सफल) प्रतिक्रिया

<response>
  <code>0</code>
  <tech_message>OK</tech_message>
  <msg_id phone="380501234567">MESSAGE_GUID</msg_id>
</response>

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

यदि अनुरोध प्यारामिटर प्रमाणीकरण असफल भयो वा प्रमाणीकरण असफल भयो भने, प्रतिक्रियाले गैर-शून्य कोड फिर्ता गर्नेछ।

हस्ताक्षर छुटेकोअनधिकृत

<response>
  <code>-1</code>
  <tech_message>PARAM ERROR (sign)</tech_message>
</response>

<response>
  <code>-2</code>
  <tech_message>ERROR(unauthorized)</tech_message>
</response>

---

कलब्याकहरू

कलब्याक URL हरू तपाईंको प्लेटफर्ममा लागू र होस्ट गरिएको हुनुपर्छ। SMSBAT ले तपाईंको प्रणालीलाई डेलिभरी घटनाहरू, सर्वेक्षण प्रतिक्रियाहरू, र प्रयोगकर्ता जवाफहरू सम्बन्धी अद्यावधिक गर्न HTTP कलब्याकहरू पठाउँछ।

१. डेलिभरी स्थिति कलब्याक

सन्देश ट्रान्जिसन स्थितिमा पठाइयो (डेलिभर भयो, पढियो, असफल भयो)।

• सामग्री-प्रकार: अनुप्रयोग/x-www-form-urlencoded
• विधि: पोस्ट

पेलोड ढाँचाहरू अनुरोध गर्नुहोस्:

* वितरण गरिएको:*

msg_id=MESSAGE_GUID&status=delivered

हेरिएको/पढिएको:

msg_id=MESSAGE_GUID&status=delivered&type=seen

अनडेलिभर/असफल:*

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

क्षेत्र विवरण:

• msg_id: SMSBAT अद्वितीय सन्देश ID (GUID) SendMessage प्रतिक्रियामा फर्काइयो।
• स्थिति: डेलिभरीको नतिजा (डेलिभर गरिएको, अडिलिभर गरिएको, वा स्थिति अज्ञात)।
• प्रकार: सन्देश प्राप्तकर्ताले हेरेको बेला हेरिएको मा सेट गर्नुहोस्।
• status_extended: डेलिभर नगरिएको स्थितिको लागि विशेष प्राविधिक कारण (जस्तै VIBER_EXPIRED, VIBER_BLOCKED_BY_USER, VIBER_USER_NOT_FOUND, VIBER_NO_DEVICE)।

---

२. सर्वेक्षण उत्तर कलब्याक

प्रयोगकर्ताले Viber सर्वेक्षण सन्देशमा प्रतिक्रिया विकल्प चयन गर्दा ट्रिगर हुन्छ।

• सामग्री-प्रकार: अनुप्रयोग/x-www-form-urlencoded
• विधि: पोस्ट

** अनुरोध पेलोड ढाँचा:**

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

---

३. इनबाउन्ड प्रयोगकर्ता सन्देश कलब्याक

जब प्रयोगकर्ताले तपाइँको Viber व्यवसाय सेवामा पाठ वा मिडिया जवाफ पठाउँछ तब ट्रिगर हुन्छ।

• सामग्री-प्रकार: एप्लिकेशन/json
• विधि: पोस्ट

** अनुरोध पेलोड ढाँचा:**

{
  "msg_id": "INBOUND_MESSAGE_GUID",
  "text": "Hello, I have a question",
  "media": "https://example.com/user-attachment.png",
  "phone": "380501234567",
  "sender_bm_id": "12345"
}

क्षेत्र विवरण:

• msg_id: इनबाउन्ड जवाफको लागि उत्पन्न गरिएको अद्वितीय सन्देश ID।
• पाठ: प्रयोगकर्ताले पठाएको पाठ सामग्री (उनीहरूले मिडिया मात्र पठाएमा नल हुन सक्छ)।
• media: प्रयोगकर्ताले पठाएको कुनै पनि मिडिया संलग्नकहरू डाउनलोड गर्नको लागि प्रत्यक्ष URL (पाठ मात्र भएमा नल हुन सक्छ)।
• फोन: अन्तर्राष्ट्रिय ढाँचामा प्रेषकको फोन नम्बर।
• sender_bm_id: Viber व्यवसाय प्रेषक ID।