အကြောင်းအရာသို့ ကရန်

Messagio API လိုက်ဖက်မှု

SMSBAT သည် Messagio API နှင့် တွဲဖက်အသုံးပြုနိုင်သော အလွှာတစ်ခုကို ပံ့ပိုးပေးပါသည်။ ၎င်းသည် သင့်အား သင်၏ payload တည်ဆောက်ပုံကို ပြန်လည်ရေးသားခြင်း သို့မဟုတ် ပေါင်းစည်းမှုဆိုင်ရာ ယုတ္တိကို ပြောင်းလဲရန် မလိုအပ်ဘဲ Messagio အတွက် ဖန်တီးထားသည့် လက်ရှိ Viber ပေါင်းစည်းမှုများကို SMSBAT သို့ တိုက်ရိုက်ရွှေ့ပြောင်းနိုင်စေမည်ဖြစ်သည်။

ချိတ်ဆက်မှု ဆက်တင်များ

SMSBAT မှတဆင့် တောင်းဆိုမှုများကို လမ်းကြောင်းပြရန်၊ သင်၏ပေါင်းစပ်မှုတွင် အခြေခံ URL နှင့် စစ်မှန်ကြောင်းအထောက်အထားများကို အပ်ဒိတ်လုပ်ပါ-

  • အခြေခံ URL- https://restapi.smsbat.com
  • အဆုံးမှတ်- POST /api/SendMessage
  • တောင်းဆိုမှုပုံစံ- application/x-www-form-urlencoded (ဖောင်ဒေတာ)

စစ်မှန်ကြောင်းနှင့် အထောက်အထားများ

တောင်းဆိုချက်များအား တောင်းဆိုချက်ကိုယ်ထည်ပုံစံဒေတာအတွင်း တိုက်ရိုက်ပေးပို့သော ကန့်သတ်ဘောင်များကို အသုံးပြု၍ စစ်မှန်ကြောင်းအထောက်အထားပြသည်-

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
အသုံးပြုသူ string ဟုတ်ကဲ့ သင်၏ SMSBAT အကောင့် အကောင့်ဝင်ခြင်း သို့မဟုတ် အသုံးပြုသူသတ်မှတ်မှု။
ဆိုင်း string ဟုတ်ကဲ့ API လျှို့ဝှက် သို့မဟုတ် ပေးပို့သူအမည်အတွက် မှတ်ပုံတင်ထားသော လက်မှတ်။
from string ဟုတ်ကဲ့ မှတ်ပုံတင်ထားသော ပေးပို့သူ အယ်လ်ဖာအမည်။
sending_method string ဟုတ်ကဲ့ ချန်နယ်အမျိုးအစား။ ပုံမှန် Viber Business မက်ဆေ့ဂျ်များ သို့မဟုတ် Viber OTP နမူနာများအတွက် viber_otp ကို အသုံးပြုပါ။
ဖုန်း string ဟုတ်ကဲ့ လက်ခံသူဖုန်းနံပါတ် (ဥပမာ၊ 380501234567)။

Viber Message အမျိုးအစားများ

သတ်မှတ်ထားသောဘောင်များကိုကြည့်ရှုရန်နှင့် မတူညီသော Viber မက်ဆေ့ခ်ျဖွဲ့စည်းပုံများအတွက် payloads တောင်းဆိုရန်အောက်ပါတဘ်ကိုရွေးချယ်ပါ-

ရိုးရှင်းသောစာသားမက်ဆေ့ခ်ျကိုပေးပို့ပါ။

နောက်ထပ် ကန့်သတ်ချက်များ-

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
txt string ဟုတ်ကဲ့ မက်ဆေ့ချ်စာသား။

** Payload နမူနာ တောင်းဆိုရန်-** 

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 string ဟုတ်ကဲ့ မက်ဆေ့ချ်စာသား။
button_text string ဟုတ်ကဲ့ ခလုတ်ပေါ်တွင် စာသားပေါ်လာသည်။
button_link string ဟုတ်ကဲ့ ခလုတ်ကိုနှိပ်လိုက်သောအခါ ဦးတည်ရာ URL။

** Payload နမူနာ တောင်းဆိုရန်-** 

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

အများသူငှာ ပုံဖိုင်ကို ပို့ပေးသည်။

နောက်ထပ် ကန့်သတ်ချက်များ-

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
image_link string ဟုတ်ကဲ့ ပုံ၏ အများသူငှာ HTTPS URL
txt string မရှိ ပုံအောက်တွင်ပြသရန် ရွေးချယ်နိုင်သော စာတန်းစာသား။

** Payload နမူနာ တောင်းဆိုရန်-** 

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 string ဟုတ်ကဲ့ စာတန်းစာသား။
image_link string ဟုတ်ကဲ့ ပုံ၏ အများသူငှာ HTTPS URL
button_text string ဟုတ်ကဲ့ ခလုတ်ပေါ်တွင် စာသားပေါ်လာသည်။
button_link string ဟုတ်ကဲ့ ခလုတ်ကိုနှိပ်လိုက်သောအခါ ဦးတည်ရာ URL။

** Payload နမူနာ တောင်းဆိုရန်-** 

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 string ဟုတ်ကဲ့ ဗီဒီယိုဖိုင်၏ အများသူငှာ HTTPS URL
video.thumbnail string ဟုတ်ကဲ့ ဗီဒီယိုအစမ်းကြည့်ပုံ၏ အများသူငှာ HTTPS URL။
video.size_mb ကိန်းပြည့် ဟုတ်ကဲ့ ခန့်မှန်းခြေ ဗီဒီယိုဖိုင်အရွယ်အစား မီဂါဘိုက်။
video.duration_sec ကိန်းပြည့် ဟုတ်ကဲ့ ဗီဒီယိုကြာချိန် စက္ကန့်ပိုင်းအတွင်း။
txt string မရှိ ရွေးချယ်နိုင်သော ဖော်ပြချက် စာသား။
button_text string မရှိ ရွေးချယ်နိုင်သော ခလုတ်စာသား (စာတန်း သို့မဟုတ် လင့်ခ်အဖြစ် လုပ်ဆောင်နိုင်သည်)။
button_link string မရှိ ရွေးချယ်နိုင်သော ခလုတ် လင့်ခ် URL။

** Payload နမူနာ တောင်းဆိုရန်-** 

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` | string | **ဟုတ်ကဲ့** | ကြိုတင်အတည်ပြုထားသော Viber OTP နမူနာပုံစံ ID။ |
| `template.lang` | string | **ဟုတ်ကဲ့** | နမူနာပုံစံ ဘာသာစကားကုဒ် (ဥပမာ၊ `en`၊ `uk`)။ |
| `template.params.pin` | string | **ဟုတ်ကဲ့** | ပုံစံခွက်ထဲသို့ ထိုးသွင်းရန် OTP ပင်နံပါတ်တန်ဖိုး။ |
| `template.params.business_platform_name` | string | **ဟုတ်ကဲ့** | နမူနာပုံစံရှိ လုပ်ငန်းအမည်နေရာယူသူ။ |
| `template.params.code_validity_time` | string | **ဟုတ်ကဲ့** | မိနစ်ပိုင်းအတွင်း PIN တရားဝင်သက်တမ်း။ |

** Payload နမူနာ တောင်းဆိုရန်-**
```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 string ဟုတ်ကဲ့ အဝိုင်းလေး၏ ခေါင်းစဉ် စာသား။
carousel[N].title string ဟုတ်ကဲ့ ကတ်၏ခေါင်းစဉ် N (0 မှစတင်သည်)။
carousel[N].image_url string ဟုတ်ကဲ့ ကတ် N ၏ အများသူငှာ HTTPS ပုံ URL
carousel[N].primary_label string ဟုတ်ကဲ့ ကတ် N ၏ ပင်မခလုတ်စာတန်း။
carousel[N].primary_url string ဟုတ်ကဲ့ ကတ် N ၏ ပင်မခလုတ်လင့်ခ် URL။
carousel[N].secondary_label string မရှိ ကတ် N ၏ အလယ်တန်းခလုတ် စာတန်း။
carousel[N].secondary_url string မရှိ ကတ် N ၏ ဒုတိယခလုတ် လင့်ခ် URL။

** Payload နမူနာ တောင်းဆိုရန်-** 

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 string ဟုတ်ကဲ့ စစ်တမ်းမေးခွန်းစာသား။
survey_options[N] string ဟုတ်ကဲ့ N အကြောင်းအရာအတွက် စစ်တမ်းရွေးချယ်မှုစာသား (အညွှန်းကိန်း 0)။ အနည်းဆုံး ရွေးချယ်စရာ 2 ခု လိုအပ်ပါသည်။
option_type ကိန်းပြည့် ဟုတ်ကဲ့ ရွေးချယ်မှုအမျိုးအစား- 1 (ရေဒီယိုခလုတ်များ) သို့မဟုတ် 2 (ပုံမှန်ခလုတ်များ)။

** Payload နမူနာ တောင်းဆိုရန်-** 

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 လိုက်ဖက်ညီသော အဆုံးမှတ်သည် HTTP 200 OK အခြေအနေကုဒ်ဖြင့် တုံ့ပြန်မှုများကို XML ဖော်မတ် ဖြင့် ပြန်ပေးသည်။

လက်ခံ (အောင်မြင်) တုံ့ပြန်မှု

<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>

ပြန်လည်ခေါ်ဆိုမှုများ

Callback URL များကို သင့်ပလက်ဖောင်းပေါ်တွင် အကောင်အထည်ဖော်ပြီး လက်ခံဆောင်ရွက်ပေးရပါမည်။ SMSBAT သည် ပေးပို့မှုဖြစ်ရပ်များ၊ စစ်တမ်းတုံ့ပြန်မှုများနှင့် အသုံးပြုသူပြန်ကြားမှုများနှင့်ပတ်သက်၍ သင့်စနစ်အား အပ်ဒိတ်လုပ်ရန် HTTP ဖုန်းခေါ်ဆိုမှုများကို ပေးပို့ပါသည်။

1. ပေးပို့မှုအခြေအနေ ပြန်ခေါ်ပါ။

မက်ဆေ့ဂျ်တစ်ခုသည် အကူးအပြောင်းအခြေအနေ (ပေးပို့၊ ဖတ်၊ မအောင်မြင်) ပေးပို့သည့်အခါ

  • အကြောင်းအရာ-အမျိုးအစား- application/x-www-form-urlencoded
  • နည်းလမ်း- POST

** Payload ဖော်မတ်များ တောင်းဆိုရန်-**

** ပို့ဆောင်ပေးနေပါပြီ ** 

msg_id=MESSAGE_GUID&status=delivered
မြင်/ဖတ် 
msg_id=MESSAGE_GUID&status=delivered&type=seen
* ** မပေးပို့ရသေး / မအောင်မြင်ပါ :** 
msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

** Fields ဖော်ပြချက်-**

  • msg_id- SMSBAT သီးသန့်မက်ဆေ့ချ် ID (GUID) ကို SendMessage တုံ့ပြန်မှုတွင် ပြန်ပေးသည်။
  • အခြေအနေ- ပေးပို့မှုရလဒ် (ပေးပို့သည်၊ မပေးပို့ရသေးသော´ သို့မဟုတ်မသိရှိရသော အခြေအနေ`)။
  • type- မက်ဆေ့ချ်ကို လက်ခံသူမှ ကြည့်ရှုသောအခါတွင် မြင်သည် ဟု သတ်မှတ်သည်။
  • status_extended- မပေးပို့ရသေးသော အခြေအနေအတွက် အထူးနည်းပညာဆိုင်ရာ အကြောင်းပြချက် (ဥပမာ VIBER_EXPIRED၊ VIBER_BLOCKED_BY_USER၊ VIBER_USER_NOT_FOUND၊ VIBER_NO_DEVICE)။

2. စစ်တမ်းဖြေဆိုပြီး ပြန်ခေါ်ပါ။

Viber Survey မက်ဆေ့ဂျ်တွင် အသုံးပြုသူတစ်ဦးမှ တုံ့ပြန်မှုရွေးချယ်ခွင့်ကို ရွေးချယ်သည့်အခါ အစပျိုးသည်။

  • အကြောင်းအရာ-အမျိုးအစား- application/x-www-form-urlencoded
  • နည်းလမ်း- POST

** ပေးချေမှုပုံစံကို တောင်းဆိုရန်-** 

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Inbound User Message ကို ပြန်ခေါ်ပါ။

အသုံးပြုသူတစ်ဦးက သင်၏ Viber Business ဝန်ဆောင်မှုသို့ စာတို သို့မဟုတ် မီဒီယာအကြောင်းပြန်ကြားချက်ကို ပေးပို့သည့်အခါ အစပျိုးသည်။

  • အကြောင်းအရာ-အမျိုးအစား- application/json
  • နည်းလမ်း- POST

** ပေးချေမှုပုံစံကို တောင်းဆိုရန်-** 

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

** Fields ဖော်ပြချက်-**

  • msg_id- အဝင်စာပြန်ကြားမှုအတွက် ထုတ်လုပ်ထားသော သီးသန့်မက်ဆေ့ချ် ID။
  • text- အသုံးပြုသူမှ ပေးပို့သော စာသားအကြောင်းအရာ (မီဒီယာကိုသာ ပေးပို့ပါက null ဖြစ်နိုင်ပါသည်။
  • မီဒီယာ- အသုံးပြုသူမှပေးပို့သော မည်သည့်မီဒီယာ ပူးတွဲပါဖိုင်များကို ဒေါင်းလုဒ်လုပ်ရန် တိုက်ရိုက် URL (စာသားသာလျှင် null ဖြစ်နိုင်သည်)။
  • ဖုန်း- နိုင်ငံတကာဖော်မတ်ဖြင့် ပေးပို့သူ၏ဖုန်းနံပါတ်။
  • sender_bm_id: Viber Business ပေးပို့သူ ID။