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

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

SMSBAT သည် GMS API နှင့် တွဲဖက်အသုံးပြုနိုင်သော အလွှာတစ်ခုကို ပံ့ပိုးပေးပါသည်။ ၎င်းသည် သင့်အား GMS အတွက် ဒီဇိုင်းရေးဆွဲထားသော လက်ရှိပေါင်းစပ်မှုများကို SMSBAT သို့ တိုက်ရိုက်ပြောင်းရွှေ့နိုင်စေမည့် သင်၏မက်ဆေ့ချ်လမ်းကြောင်းအစီအစဉ်များ၊ payload တည်ဆောက်ပုံများ၊ သို့မဟုတ် ပြန်ခေါ်သည့်နားထောင်သူများကို မွမ်းမံပြင်ဆင်ရန် မလိုအပ်ပါ။

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

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

  • အခြေခံ URL- https://restapi.smsbat.com
  • အဆုံးမှတ်- POST /api/GMSMessage/send_message
  • တောင်းဆိုမှုပုံစံ- application/json
  • ** စစ်မှန်ကြောင်းအထောက်အထားပြခြင်း-** HTTP အခြေခံစစ်မှန်ကြောင်းအထောက်အထားပြခြင်း (သင်၏ SMSBAT API အထောက်အထားများကိုအသုံးပြုသည်)

တောင်းဆိုမှု ကန့်သတ်ချက်များ

GMS လိုက်ဖက်ညီသော API သည် အောက်ပါအဆင့်သတ်မှတ်ချက်များဖြင့် JSON အရာတစ်ခုကို လက်ခံသည်-

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
ဖုန်း_နံပါတ် string ဟုတ်ကဲ့ လက်ခံသူဖုန်းနံပါတ် (ဥပမာ၊ 380501234567)။
tag string ဟုတ်ကဲ့ မှတ်ပုံတင်ထားသော ပေးပို့သူအမည် / အယ်လ်ဖာအမည်။
ချန်နယ် ခင်းကျင်း ဟုတ်ကဲ့ ဦးစားပေးအစီအစဉ်ဖြင့် ကြိုးစားရန် ချန်နယ်များစာရင်း။ ပံ့ပိုးထားသော တန်ဖိုးများ- viber၊ sms၊ push။ ဥပမာ၊ ["viber", "sms"]။
channel_options အရာဝတ္ထု ဟုတ်ကဲ့ အသုံးပြုနေသောချန်နယ်တစ်ခုစီအတွက် ရွေးချယ်စရာများပါဝင်သောမြေပုံ (အောက်တွင်ကြည့်ပါ)။
extra_id string မရှိ သင့်အတွင်းပိုင်း ဖောက်သည်ဘက်မှ မက်ဆေ့ဂျ် ID။
callback_url string မရှိ ပေးပို့မှုအခြေအနေ ပြန်ခေါ်မှုများကို လက်ခံရန် သင့်စနစ်ရှိ Endpoint URL
division_code string မရှိ ရွေးချယ်နိုင်သော အပိုင်းခွဲကုဒ် သတ်မှတ်သူ ( `ပင်မ´ သို့ ပုံသေများ)။

ချန်နယ်ရွေးချယ်မှုများ ဆက်တင်များ

channel_options အရာဝတ္ထုတွင် ချန်နယ်ဆိုင်ရာ သီးခြားဖွဲ့စည်းပုံများ ပါရှိသည်။

channels အခင်းအကျင်းတွင် viber ကို စာရင်းသွင်းသောအခါတွင် သုံးသည်။

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
စာသား string ဟုတ်ကဲ့ စာကိုယ်စာသား။
ttl ကိန်းပြည့် ဟုတ်ကဲ့ Time-To-Live စက္ကန့်ပိုင်းအတွင်း။
img string မရှိ ပြသရန် ပုံ၏ အများသူငှာ HTTPS URL
စာတန်း string မရှိ ခလုတ်စာသားအညွှန်း။
လုပ်ဆောင်ချက် string မရှိ ခလုတ်ကိုနှိပ်လိုက်သောအခါ ဦးတည်ရာ URL။
survey_options ခင်းကျင်း မရှိ စစ်တမ်းရွေးချယ်စရာများအဖြစ် ပြသရန် ကြိုးတန်းများ (၂ ခုမှ ၅ ခု)။
carousel_items ခင်းကျင်း မရှိ Viber အဝိုင်းလေးအဖြစ်ပြသရန် ဆလိုက်အရာဝတ္ထုများ၏ အခင်းအကျင်း (ဖွဲ့စည်းပုံကို tab တွင်ကြည့်ပါ)။

** Viber တောင်းဆိုမှု ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Hello from SMSBAT!",
      "ttl": 60,
      "img": "https://www.example.com/image.png",
      "caption": "Open",
      "action": "https://www.example.com"
    }
  }
}

TTL အတွင်း Viber ပေးပို့မှု မအောင်မြင်ပါက အလိုအလျောက် SMS ပေးပို့မှုဖြင့် Viber စာတိုပေးပို့ခြင်းကို ဖွင့်ပါ။

** တုံ့ပြန်တောင်းဆိုမှု ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber", "sms"],
  "channel_options": {
    "viber": {
      "text": "Your order is ready!",
      "ttl": 60,
      "caption": "Details",
      "action": "https://www.example.com/order"
    },
    "sms": {
      "text": "Your order is ready: https://www.example.com/order",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}

sms ကို channels အခင်းအကျင်းတွင် စာရင်းသွင်းသောအခါတွင် အသုံးပြုသည်။

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
စာသား string ဟုတ်ကဲ့ စာကိုယ်စာသား။
alpha_name string ဟုတ်ကဲ့ ပေးပို့သူ အယ်လ်ဖာအမည်။
ttl ကိန်းပြည့် ဟုတ်ကဲ့ Time-To-Live စက္ကန့်ပိုင်းအတွင်း။
ctr ဘူလီယံ မရှိ စာသားရှိ လင့်ခ်များပေါ်တွင် CTR ကလစ်ခြေရာခံခြင်းကို ဖွင့်ပါ (true/false)။

** SMS တောင်းဆိုမှု ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["sms"],
  "channel_options": {
    "sms": {
      "text": "Your verification code is 1234",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}

Viber စစ်တမ်းများနှင့် စစ်တမ်းများ ဖန်တီးရန် အသုံးပြုသည်။

!!! သတိပေးချက် Viber စစ်တမ်းဖွဲ့စည်းပုံသည် survey_options အတွင်းရှိ 2 နှင့် 5 ရွေးစရာများ အကြားရှိရပါမည်။

** စစ်တမ်းတောင်းဆိုမှု ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Please rate our service:",
      "ttl": 60,
      "survey_options": [
        "Excellent",
        "Good",
        "Bad"
      ]
    }
  }
}

ပွတ်ဆွဲနိုင်သော ရုပ်ပုံဆလိုက်ကတ်များ ပေးပို့ရန် အသုံးပြုသည်။ ဆလိုက်တစ်ခုစီသည် ပုံ၊ ခေါင်းစဉ်နှင့် ခလုတ်များကို ပံ့ပိုးပေးသည်။

** အဝိုင်းလေး တောင်းဆိုမှု ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Choose an offer",
      "ttl": 60,
      "carousel_items": [
        {
          "title": "Offer 1",
          "image_url": "https://www.example.com/offer-1.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-1",
          "secondary_label": "More",
          "secondary_url": "https://www.example.com/offers"
        },
        {
          "title": "Offer 2",
          "image_url": "https://www.example.com/offer-2.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-2"
        }
      ]
    }
  }
}

push ကို channels ခင်းကျင်းတွင် စာရင်းသွင်းသောအခါတွင် အသုံးပြုသည်။

ကန့်သတ်ချက် ရိုက် လိုအပ်သည် ဖော်ပြချက်
ခေါင်းစဉ် string ဟုတ်ကဲ့ အသိပေးချက်၏ ခေါင်းစဉ်စာသား။
စာသား string ဟုတ်ကဲ့ စာကိုယ်စာသား။
ttl ကိန်းပြည့် ဟုတ်ကဲ့ Time-To-Live စက္ကန့်ပိုင်းအတွင်း။
img string မရှိ ပြသရန် ပုံ၏ အများသူငှာ HTTPS URL
စာတန်း string မရှိ ခလုတ်စာသားအညွှန်း။
လုပ်ဆောင်ချက် string မရှိ ခလုတ်ကိုနှိပ်လိုက်သောအခါ ဦးတည်ရာ URL။
ctr ဘူလီယံ မရှိ ကလစ်ခြေရာခံခြင်းကို ဖွင့်ပါ။

** Push Request ဥပမာ-** 

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["push"],
  "channel_options": {
    "push": {
      "title": "Order update",
      "text": "Your order is ready for pickup!",
      "ttl": 60,
      "img": "https://www.example.com/push.png",
      "caption": "Open",
      "action": "https://www.example.com/order",
      "ctr": false
    }
  }
}

တုံ့ပြန်မှုပုံစံ

အဆုံးမှတ်သည် HTTP 200 OK အခြေအနေကုဒ်ဖြင့် JSON ဖော်မတ် တွင် တုံ့ပြန်မှုများကို ပြန်ပေးသည်။

အောင်မြင်သော တုံ့ပြန်မှု

{
  "MessageId": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "ErrorCode": null,
  "ErrorText": null
}

အမှားတုံ့ပြန်မှုများ

အတည်ပြုခြင်း သို့မဟုတ် လုပ်ဆောင်ခြင်း မအောင်မြင်ပါက၊ အချည်းနှီးမဟုတ်သော ErrorCode နှင့် အသေးစိတ် ErrorText ပါရှိသော အမှားအယွင်းတစ်ခု တုံ့ပြန်မှုကို ပြန်ပေးပါမည်။

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "This type of Message is not supported by the system"
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "There can be from 2 to 5 survey options."
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 400,
  "ErrorText": "Cannot send to international number: alpha name 'ALPHA' is not registered."
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 500,
  "ErrorText": "Internal server error."
}

ပြန်လည်ခေါ်ဆိုမှု ပေးပို့မှုပုံစံ

တောင်းဆိုချက်တွင် callback_url ကိုသတ်မှတ်ထားပါက၊ SMSBAT သည် JSON POST payload တစ်ခုအနေဖြင့် သင်၏အဆုံးမှတ်သို့ ပေးပို့မှုအခြေအနေအပ်ဒိတ်များကို ပေးပို့ပါသည်။

ပြန်ခေါ်ရန် တောင်းဆိုမှု ဥပမာ

POST /your-callback-endpoint HTTP/1.1
Host: yoursystem.com
Content-Type: application/json

{
  "number": "380501234567",
  "time": 1719237600000,
  "status": 2,
  "substatus": 23,
  "hyber_status": 23033,
  "message_id": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "extra_id": "ORDER-12345",
  "sent_via": "viber",
  "matching_template_id": 0
}

ပြန်ခေါ်ရန် အကွက်များ ဖော်ပြချက်

လယ် ရိုက် ဖော်ပြချက်
နံပါတ် string လက်ခံသူဖုန်းနံပါတ်။
အချိန် နံပါတ် Unix မီလီစက္ကန့်များတွင် ဖြစ်ရပ်အချိန်တံဆိပ်
အဆင့်အတန်း နံပါတ် ရိုးရှင်းသော အခြေအနေသတ်မှတ်မှု (အခြေအနေကုဒ်ဇယားကိုကြည့်ပါ)။
substatus နံပါတ် အသေးစိတ်အခြေအနေသတ်မှတ်သူ (အသေးစိတ်အခြေအနေကုဒ်ဇယားကိုကြည့်ပါ)။
hyber_status နံပါတ် အသေးစိတ် SMSBAT အတွင်းပိုင်းအခြေအနေကုဒ် (Hyber အဆင့်အတန်းဇယားကိုကြည့်ပါ)။
message_id string ပေးပို့ရာတွင် SMSBAT မက်ဆေ့ခ်ျ ID (GUID) ကိုထုတ်ပေးသည်။
extra_id string မူရင်းတောင်းဆိုမှုတွင် ဖောက်သည်ဘက်မှ ID ပေးထားသည်။
sent_via string မက်ဆေ့ဂျ်ကို လုပ်ဆောင်သည့် ချန်နယ်- viber၊ sms သို့မဟုတ် rcs။
matching_template_id နံပါတ် Viber နမူနာပုံစံ ကိုက်ညီမှုအခြေအနေ (အသုံးပြုနိုင်သည့်နေရာတွင်)။

အခြေအနေမြေပုံများ

1. ရိုးရှင်းသော အခြေအနေ (အခြေအနေ)

ကုတ် အဓိပ္ပါယ်
1 မက်ဆေ့ချ်လက်ခံသည် သို့မဟုတ် ပေးပို့လျက်ရှိသည်။
2 မက်ဆေ့ချ်ပေးပို့ခဲ့သည်။
3 လုပ်ဆောင်ခြင်း သို့မဟုတ် ပေးပို့မှု မှားယွင်းခြင်း။

2. အသေးစိတ်အခြေအနေ (substatus)

ကုတ် အဓိပ္ပါယ်
12 စီမံဆောင်ရွက်ပေးရန် လက်ခံထားသည်။
23 ပေးပို့ခဲ့သည်။
24 မြင်/ဖတ်။
35 TTL (သက်တမ်းကုန်) အတွင်း မပို့ပေးပါ။
36 ပေးပို့မှု အမှားအယွင်း

3. ချန်နယ်အမျိုးအစား (sent_via)

လက်ပံ ဖော်ပြချက်
viber Viber ချန်နယ်မှ ထုတ်လုပ်သည့် အခြေအနေ။
sms SMS ချန်နယ်မှ ထုတ်လုပ်သည့် အခြေအနေ။
rcs RCS ချန်နယ်မှ ထုတ်လုပ်သည့် အခြေအနေ။

4. အသေးစိတ် SMSBAT အခြေအနေ (hyber_status)

ကုတ် လက်ပံ အဆင့်အတန်း အဆင့်အတန်းခွဲ အဓိပ္ပါယ်
23033 viber 2 23 Viber မှ Message ပေးပို့ထားပါသည်။
24013 viber 2 24 Viber မက်ဆေ့ခ်ျကို လက်ခံသူ (မြင်သည်) က ဖတ်သည်။
36013 viber 3 36 Viber စက်တွင်း အမှား။
36023 viber 3 36 Viber ဝန်ဆောင်မှု ID မမှန်ကန်ပါ သို့မဟုတ် မရရှိနိုင်ပါ။
36033 viber 3 36 Viber payload data မမှန်ကန်ပါ။
36037 viber 3 36 Viber ပုံ URL ရှည်လွန်းသည်။
36038 viber 3 36 Viber ပုံ URL မမှန်ကန်ပါ။
36039 viber 3 36 Viber က စာတိုရှည်လွန်းတယ်။
36044 viber 3 36 Viber စာသားဗလာ။
36053 viber 3 36 Viber မက်ဆေ့ခ်ျအမျိုးအစားကို ပံ့ပိုးမထားပါ။
36063 viber 3 36 Viber ကန့်သတ်ချက်များ မမှန်ကန်ပါ။
36073 viber 3 36 Viber ဝန်ဆောင်မှုပေးသူ အချိန်ကုန်သွားပါပြီ။
36083 viber 3 36 Viber ပေးပို့သူကို လက်ခံသူက ပိတ်ဆို့ထားသည်။
36093 viber 3 36 လက်ခံသူသည် Viber အသုံးပြုသူအဖြစ် မှတ်ပုံတင်ထားခြင်းမရှိပါ။
36103 viber 3 36 Viber ပံ့ပိုးမှုရှိသော Android/iOS စက်ပစ္စည်းကို ရှာမတွေ့ပါ။
36113 viber 3 36 Viber ပေးပို့ခြင်းအတွက် ခွင့်ပြုချက်မရှိဘဲ IP လိပ်စာ။
36123 viber 3 36 Viber မက်ဆေ့ဂျ်ကို မိတ္တူပွားနေကြောင်း တွေ့ရှိခဲ့သည်။
36143 viber 3 36 Viber ငွေတောင်းခံမှုအမှား။
36153 viber 3 36 ပလက်ဖောင်းအမည်ပျက်စာရင်းဖြင့် ပိတ်ဆို့ထားသော မက်ဆေ့ချ်။
36163 viber 3 36 Viber ပလပ်ဖောင်းအတွင်းပိုင်း လုပ်ဆောင်ခြင်း အမှားအယွင်း။
36173 viber 3 36 Viber တံဆိပ် မှားနေသည် သို့မဟုတ် ပျောက်ဆုံးနေပါသည်။
36183 viber 3 36 Viber TTL တန်ဖိုး မမှန်ကန်ပါ။
12011 sms / rcs 1 12 SMS/RCS လက်ခံပါသည်။
36011 sms / rcs 1 12 SMS/RCS လမ်းကြောင်း။
23011 sms / rcs 2 23 SMS/RCS ပေးပို့ပြီးပါပြီ။
35015 sms / rcs 3 35 SMS/RCS သက်တမ်းကုန်သွားပါပြီ (TTL အတွင်း မပေးပို့ပါ)။
36021 sms / rcs 3 36 SMS/RCS မက်ဆေ့ဂျ်ကို ဖျက်လိုက်ပါပြီ။
36031 sms / rcs 3 36 SMS/RCS ပေးပို့၍မရပါ။
36041 sms / rcs 3 36 အမည်မသိ SMS/RCS ပေးပို့မှုအခြေအနေ။
36051 sms / rcs 3 36 SMS/RCS မက်ဆေ့ဂျ်ကို ငြင်းပယ်ထားသည်။