အော်ပရေတာခွင့်ပြုချက်နှင့် နက်ရှိုင်းသောလင့်ခ်များ
ဤလမ်းညွှန်သည် API မှတစ်ဆင့် စနစ်အတွင်းရှိ အော်ပရေတာများအတွက် တရားဝင်ခွင့်ပြုချက်တိုကင်ကို မည်သို့ရယူရမည်နှင့် ချတ်အကန့်သို့ သွားလာရန် နက်ရှိုင်းသောလင့်ခ်များကို အသုံးပြုနည်းကို ရှင်းပြထားသည်။
API အခြေခံ URL- https://chatapi.smsbat.com/
Swagger- https://chatapi.smsbat.com/index.html
မှတ်ချက်- ကုမ္ပဏီအဆင့် တောင်းဆိုချက်များအတွက်
Bearerခွင့်ပြုချက်အစား သင်၏ တိုကင် (သင့်ပရိုဖိုင်ရှိ ဒက်ရှ်ဘုတ်တွင် ရနိုင်သည်) နှင့်X-Authorization-Keyခေါင်းစီးကို အသုံးပြုနိုင်ပါသည်။
1. ကုမ္ပဏီတိုကင်ရယူပါ။
ကုမ္ပဏီ တိုကင်ကို ရယူရန် ကုမ္ပဏီ၏ အကောင့်ဝင်ခြင်းဆိုင်ရာ အထောက်အထားများ ပါဝင်သော /api/company/get-token သို့ HTTP POST တောင်းဆိုချက်ကို ပေးပို့ပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ပို့စ်
- URL: https://chatapi.smsbat.com/api/company/get-token
- ခေါင်းစီးများ- အကြောင်းအရာ-အမျိုးအစား- application/json
** ခန္ဓာကိုယ် : **
တုံ့ပြန်မှု
- အခြေအနေကုဒ်- 200 (အိုကေ)
- ကိုယ်ထည်- စာကြောင်းတိုကင် ("မင်းရဲ့_တိုကင်_ကြိုး")
မှတ်ချက်- နောက်ဆက်တွဲတောင်းဆိုမှုများအတွက် ရရှိလာသော တိုကင်ကို သိမ်းဆည်းပါ။
2. အဖွဲ့အစည်းစာရင်းကို ရယူပါ။
သင့်အဖွဲ့အစည်းများကိုစာရင်းပြုစုရန် ကုမ္ပဏီတိုကင်ကိုအသုံးပြု၍ /api/company/organization သို့ GET တောင်းဆိုချက်ကို ပေးပို့ပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ရယူပါ။
- URL: https://chatapi.smsbat.com/api/company/organization
- ခေါင်းစီးများ
- ခွင့်ပြုချက်- Bearer {token}
- လက်ခံသည်- စာသား/လွင်ပြင်
တုံ့ပြန်မှု - အခြေအနေကုဒ်- 200 (အိုကေ) ကိုယ်ထည်-
3. အဖွဲ့အစည်းအလိုက် အော်ပရေတာများကို ပြန်လည်ရယူပါ။
organizationId ဘောင်ကို အသုံးပြု၍ /api/operator သို့ GET တောင်းဆိုချက် ပေးပို့ပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ရယူပါ။
- URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
- ခေါင်းစီးများ
- ခွင့်ပြုချက်- Bearer {token}
- လက်ခံသည်- စာသား/လွင်ပြင်
တုံ့ပြန်မှု - အခြေအနေကုဒ်- 200 (အိုကေ) ကိုယ်ထည်-
4. အော်ပရေတာများကို စနစ်ထဲသို့ထည့်ပါ။
ဤအဆုံးမှတ်ကို ဝင်ရောက်ပြီး အော်ပရေတာများကို စနစ်သို့ ထပ်တူပြုရန် ကုမ္ပဏီ တိုကင်ကို အသုံးပြုပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ပို့စ်
- URL: https://chatapi.smsbat.com/api/operator/synchronize
- ခေါင်းစီးများ
- ခွင့်ပြုချက်- Bearer {token}
- အကြောင်းအရာ-အမျိုးအစား- application/json
** ခန္ဓာကိုယ် : **
တုံ့ပြန်မှု - အခြေအနေကုဒ်- 200 (အိုကေ) ကိုယ်ထည်-
ဖြစ်နိုင်သော အော်ပရေတာ အခြေအနေများ-
- Active- 0
- မလှုပ်မရှား- 1
- ဖျက်ထားသည်- 2
5. အော်ပရေတာတိုကင်ရယူပါ။
သီးခြားအော်ပရေတာတစ်ခုအတွက် တိုကင်တစ်ခုရယူရန် ကုမ္ပဏီ တိုကင်ကို လုပ်ပိုင်ခွင့်ပေးပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ပို့စ်
- URL: https://chatapi.smsbat.com/api/operator/get-token
- ခေါင်းစီးများ
- ခွင့်ပြုချက်- Bearer {token}
- အကြောင်းအရာ-အမျိုးအစား- application/json
** ခန္ဓာကိုယ် : **
expiresAt လိုအပ်ပြီး အော်ပရေတာ၏ စက်ရှင်ကြာချိန် (အမြင့်ဆုံး +24 နာရီ) ကို ဆုံးဖြတ်သည်။
တုံ့ပြန်မှု - အခြေအနေကုဒ်- 200 (အိုကေ) - ကိုယ်ထည်- စာကြောင်းတိုကင်
6. အော်ပရေတာတိုကင်ကို အတည်ပြုပါ။
အော်ပရေတာတစ်ခု၏ တိုကင်၏တရားဝင်မှုကို စစ်ဆေးပါ။
တောင်းဆိုချက်
- နည်းလမ်း- ပို့စ်
- URL: https://chatapi.smsbat.com/api/operator/validate-token
- ခေါင်းစီးများ
- ခွင့်ပြုချက်- Bearer {token}
- အကြောင်းအရာ-အမျိုးအစား- application/json
ကိုယ်ထည်- "operator_token_string"
မှန်ကန်သောတုံ့ပြန်မှု (200 OK):
{
"isValid": true,
"operatorId": 0,
"clientId": 0,
"expiresAt": "2024-12-28T14:04:15.861Z",
"error": null
}
7. Operator Chat Panel သို့ နက်ရှိုင်းစွာ ချိတ်ဆက်ခြင်း။
ပြင်ပစနစ်များ (CRM၊ ERP၊ အတွင်းပိုင်း ဝဘ်ဆိုက်များ) သည် JWT အော်ပရေတာ တိုကင်ကို ကန့်သတ်ချက်အဖြစ် ဖြတ်သန်းခြင်းဖြင့် နက်နဲသောလင့်ခ်များကို အသုံးချကာ Chat panel ကို တိုက်ရိုက်ဖွင့်နိုင်သည်။ တိုကင်သည် မမှန်ကန်ပါက သို့မဟုတ် သက်တမ်းကုန်သွားပါက၊ အသုံးပြုသူကို အကောင့်ဝင်သည့် အင်တာဖေ့စ်သို့ ပြန်ညွှန်းပါမည်။
ဖော်မတ် 1- Chat ID ဖြင့်
ပုံစံ 2- ဖုန်းနံပါတ်ဖြင့်
ဖုန်းနံပါတ်သည် E.164 နိုင်ငံတကာဖော်မတ်ဖြစ်ရပါမည်။ဖော်မတ် 3- Alpha အမည်နှင့် ဖုန်းဖြင့်
ဖော်မတ် 4- ပစ်မှတ်အသေးစိတ်များကို အပြီးသတ်ပါ။
မက်ဆေ့ချ်များကို ကြားဖြတ်ရန် မည်သည့်အရင်းအမြစ်ကို တိတိကျကျ သတ်မှတ်ပါ-
ချတ်ရင်းမြစ်များ- -0 - Viber
- 1 - ViberBot
- 2 - TelegramBot
- 3 - Whatsapp
- 4 - ဝစ်ဂျက်
- 5 - Rozetka
- 6 - Facebook
- 7 - Instagram