Messagio API अनुकूलता

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

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

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

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

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

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

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

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

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

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

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

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

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

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

| प्यारामिटर | प्रकार | आवश्यक | विवरण |
| :--- | :--- | :--- | :--- |
| `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
```

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

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
• विधि: पोस्ट

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

**** वितरण गरिएको:** http msg_id=MESSAGE_GUID&status=delivered *हेरिएको/पढिएको: http msg_id=MESSAGE_GUID&status=delivered&type=seen अनडेलिभर/असफल: http 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।