База знаний

1.2.240312 versiyasi

Ushbu hujjatda HTTP(S) protokoli orqali xabarlarni platformaga uzatish imkonini beruvchi JSONv2 protokoli haqidagi maʼlumotlar mavjud.

Ushbu hujjat tayyorlanish vaqtidagi ma'lumotlarni o'z ichiga oladi. Ishlab chiqaruvchi ushbu hujjatda xatolik yo'qligiga kafolat bermaydi. Ishlab chiqaruvchi hujjatga oldindan ogohlantirmasdan o'zgartirish kiritish huquqini o'zida saqlab qoladi

Ushbu hujjatning hech bir qismini ishlab chiqaruvchiga yozma ravishda ogohlantirmasdan har qanday shaklda yoki biron-bir vosita bilan qayta ishlab chiqarish yoki uzatish mumkin emas

Ishlab chiqaruvchi ushbu hujjatda ko'rsatilgan dasturiy ta'minot xatosiz ekanligiga, o'zboshimchalik bilan tanlangan sharoitlarda ishlashiga va unga qo'yilishi mumkin bo'lgan barcha talablarga javob berishiga kafolat bermaydi.

Ishlab chiqaruvchi noqonuniy olingan dasturiy ta'minotning ishlashiga kafolat bermaydi. Dasturiy ta'minot va unga tegishli hujjatlardan noqonuniy foydalanish qonun bilan taqiqlanadi

1 Platformaga xabar yuborish uchun JSONv2 protokoli tavsifi

JSONv2 protokoli HTTP(S) protokoli orqali platformaga xabar yuborish imkonini beradi.

  • SMPP protokolidan farqlari:
  • Siz bir vaqtning o'zida auditoriyangiz bilan bir nechta aloqa kanallaridan foydalanishingiz mumkin: Push, messenjer ilovalari va SMS (bu o'rnatishda faqat SMS qo'llab-quvvatlanadi). Xabar istalgan kanal orqali muvaffaqiyatli yetkazib berilsa, xabarni boshqa kanallar orqali yuborish to‘xtatiladi.
  • Ommaviy xabarlar qoʻllab-quvvatlanadi.

Platforma server vazifasini bajaradi. Yetkazib berish uchun xabar yuborayotgan mijozlar HTTP mijozlari sifatida ishlaydi.

Ushbu o‘rnatishda JSONv2 protokoli bilan ishlash uchun boshlang‘ich URL manzili: https://mn-smsrlbsvc.vimpelcom.ru:4433/msghub>

 

1.3.2 Translyatsiya SMS xabarlari uchun so'rov yuborish

SMS xabarlarini translyatsiya qilish uchun so'rov namunasi:


{
"qabul qiluvchilar": [
{
"telefon_raqami": 79651111111,
"extra_id": "AD-6640-7006",
 "ism": "Maykl",
 "salom": "janob"
 },
 {
 "telefon_raqami": 79652222222,
 "extra_id": "AD-6640-7007",
 "name": "Zoya",
 "salom": "Xonim"
 }
 ],
 "start_time": "2020-12-12 10:10:10+03:00",
 "teg": "Kampaniya nomi",
 "kanallar": [
 "SMS"
 ],
 "kanal_opsiyalari": {
 "SMS": {
 "text": "Hurmatli %salom% %name%! Mana SMS",
"alpha_name": "Test",
"ttl": 300
}
}
}

Matnda oʻzgaruvchilardan foydalanishingiz mumkin. O'zgaruvchining nomi ixtiyoriy bo'lishi mumkin va "%" belgilari orasida ko'rsatilgan. "Qabul qiluvchilar" bo'limida almashtirish uchun qiymatlari bilan o'zgaruvchilar ko'rsatilishi kerak. Matndagi o'zgaruvchilar soni cheklanmagan. Lekin xabar uzunligida chegara mavjud va u quyidagi parametrlarga javob berishi kerak:


{
"qabul qiluvchilar": [
{
"telefon_raqami": 79651111111,
"extra_id": "AD-6640-7006",
"ism": "Maykl",
"salom": "janob"
 },
 {
 "telefon_raqami": 79652222222,
 "extra_id": "AD-6640-7007",
 "name": "Zoya",
 "salom": "Xonim"
 }
 ],
 "start_time": "2020-12-12 10:10:10+03:00",
 "teg": "Kampaniya nomi",
 "kanallar": [
 "SMS"
 ],
 "kanal_opsiyalari": {
 "SMS": {
 "text": "Hurmatli %salom% %name%! Mana SMS",
"alpha_name": "Test",
"ttl": 300
}
},
"sms_kirill": {
"min": 0,
"maksimal": 1340
},
"sms_latin": {
"min": 0,
"maksimal": 3060
}
}

HTTP holati 200 OK, so‘rovingiz server tomonidan muvaffaqiyatli bajarilganligini bildiradi.

1.5.2 Batafsil yetkazib berish hisobotini so'rash

Xabarni yetkazib berish boʻyicha batafsil hisobotni xabar identifikatori (platforma tomonidan yaratilgan “message_id” parametri) yoki qoʻshimcha identifikator (mijoz ilovasi tomonidan belgilangan “extra_id” parametri) orqali soʻrash mumkin.

Xabar identifikatori boʻyicha hisobot olish uchun quyidagi URL manzilidan foydalaning:


[JSONv2_URL]/{client_id}/dr/{message_id}/advanced

Qo'shimcha identifikator yordamida hisobot olish uchun quyidagi URL manzilidan foydalaning:


[JSONv2_URL]/{client_id}/dr/external/{extra_id}/advanced

Batafsil yetkazib berish hisobotiga misol:


{
"hisobotlar": [
{
"telefon_raqami": "79651111111",
"message_id": "9f60ac8f-e721-5027-b838-e6fcb95fcd7a",
"extra_id": "AD-6640-7006",
"vaqt": 1477417294667,
 "last_partner": "sms",
 "holat": 3,
 "substatus": 35,
 "msghub_status": 35015
 },
 {
 "telefon_raqami": "79651111111",
 "message_id": "9f60ac8f-e721-5027-b838-e6fcb95fcd7a",
 "extra_id": "AD-6640-7006",
 "vaqt": 1477417294667,
 "last_partner": "sms",
 "holat": 2,
 "substatus": 23,
 "msghub_status": 23011,
 "total_sms_parts": 1,
 "delivered_sms_parts": 1
 }
],
"boshlandi": rost,
"qayta ishlash": noto'g'ri,
"delivered_via": "sms",
"kanallar": [
{
"kanal": "sms",
"ttl": 300
}
]
}

Agar xabar hech qanday aloqa kanaliga yuborilmagan bo'lsa yoki hali yakuniy yetkazib berish holatiga ega bo'lmasa, xabar holati -1.

HTTP holati 200 OK, so‘rovingiz server tomonidan muvaffaqiyatli bajarilganligini bildiradi

Hisobot parametrlari tavsifi uchun quyida koʻring

1.7 So'rov va javob parametrlarining tavsifi

Ta'rif so'rovi parametrlari:

siz taqdim etilgan uchun
Sarlavha Majburiy Tavsif
Asosiy
telefon_raqami Ha Foydalanuvchining telefon raqami. Xalqaro formatda “+” belgisi
kanallar Ha Xabar yetkazib berish kanallari roʻyxati.
kanal_opsiyalari Ha Har bir aloqa kanali uchun belgilanishi kerak
xabarlar Ha Barcha aloqa kanallari uchun foydalaniladigan qabul qiluvchilarning telefon raqamlari va xabar matnlari roʻyxati. To‘plamli pochta so‘rovi
qabul qiluvchilar Ha Moslashtirilgan kampaniya uchun parametrlar roʻyxati. Translyatsiya so'rovi uchun
qo'shimcha_id Yo'q Tashqi xabar identifikatori (mijoz ilovasi tomonidan o'rnatiladi). Maksimal uzunlik: 64 belgi
callback_url Yo'q Xabar hisobotlari ushbu URL manziliga yuboriladi. Maksimal uzunlik: 256 belgi
boshlanish_vaqti Yo'q Aksiyaning rejalashtirilgan boshlanish sanasi. Quyidagi formatda ko'rsatilishi kerak: “YYYY-MM-DD hs:dd:ss±ss:dd”. Agar Grinvich vaqti bilan farq (+03:00 formatida) ko'rsatilmagan bo'lsa, u holda farq mahalliy provayder vaqtiga qarab hisoblanadi
teg Yo'q Kampaniya nomi. Maksimal uzunlik: 64 belgi
reklama Yo'q Mantiqiy qiymat (to'g'ri/noto'g'ri). Reklama xabari bayrog'i. Qiymat rost, xabar reklama. Qiymat noto'g'ri, xabar reklama emas.
ctr Yo'q Mantiqiy qiymat (to'g'ri/noto'g'ri). Agar bayroq yoqilgan bo'lsa, havolalar xabardagi havolalarni bosish sonini hisoblash uchun almashtiriladi. Agar rost bo'lsa, havolalar almashtiriladi. Agar noto'g'ri bo'lsa, havolalar almashtirilmaydi.
Kanal parametrlari
SMS
Sarlavha Majburiy Tavsif
matn Ha SMS xabar matni. Matnga qo'yiladigan talablar - kirill harflari (1005 belgigacha), lotin harflari (2295 belgigacha)
ttl Ha Xabarning soniyalarda ishlash muddati: SMS: 300..259200
alfa_nomi Ha Alfanumerik ism. Maksimal uzunlik - 11 belgi, raqam bilan boshlanishi mumkin. Alfanumerik nom faqat standart GSM alifbosi jadvalidagi 7 bitli belgilardan iborat bo'lishi mumkin

Javob parametrlarining tavsifi:

belgilangan bo'limida sozlangan. tomonidan rad etilsa, noto'g'ri
Ism Tavsif
message_id Xabar identifikatori. UUID formatida ko'rsatilgan
telefon_raqami Foydalanuvchining telefon raqami. Xalqaro formatda “+” belgisiz
qo'shimcha_id Tashqi xabar identifikatori (mijoz ilovasi tomonidan belgilangan parametr)
job_id Kampaniya identifikatori. UUID formatida sozlang
xato_kodi Xato kodi. Qiymatlar platforma veb-interfeysida "Ma'muriyat" → "Modul sozlamalari" → "Kirish" yorlig'idagi (to'liq holat ustuni) "Xato kodlari"
xato_matn Xato kodining qisqacha tavsifi
qayta ishlangan Mantiqiy qiymat (to'g'ri/noto'g'ri). Faqat xabar qayta ishlanayotgan bo'lsa, rost. Xabarni qayta ishlash boshlanmagan bo'lsa, noto'g'ri
qabul qilingan Mantiqiy qiymat (to'g'ri/noto'g'ri). Xabar platforma tomonidan qabul qilingan taqdirdagina rost. Agar xabar platforma

Xabar yetkazib berish hisoboti parametrlarining tavsifi:

belgilangan boʻladi tomonidan rad etilsa, qiymat noto'g'ri bo'ladi bilan boshlangan bo'lsa, qiymat noto'g'ri hisoblanadi
Sarlavha Tavsif
telefon_raqami Foydalanuvchining telefon raqami. Xalqaro formatda “+” belgisiz
message_id Xabar identifikatori
qo'shimcha_id Tashqi xabar identifikatori (mijoz ilovasi tomonidan belgilangan parametr)
holat ProMessage holati. Quyidagi statuslar roʻyxatini koʻring.
substatus Kengaytirilgan xabar holati. Quyidagi statuslar roʻyxatini koʻring.
msghub_status Batafsil xabar holati. Qiymatlar platforma veb-interfeysida "Ma'muriyat" → "Modul sozlamalari" → "Kirish" yorlig'idagi (to'liq holat ustuni) "Xato kodlari" bo'limida sozlangan.
sent_via Oxirgi xabarni yetkazib berish kanali. Agar xabar platforma tomonidan bloklangan boʻlsa, maydon qiymati “msghub”
jami_sms_parts SMS xabar qismlarining umumiy soni
delivered_sms_parts Etkazib berilgan SMS xabar qismlari soni. Agar SMS kanaliga hech qanday xabar yuborilmagan bo'lsa, bu parametr yo'q
status_text Xabar holatining qisqacha tavsifi
xato_matn Xatoning qisqacha tavsifi
xato_kodi Xato kodi. Qiymatlar platforma veb-interfeysida "Ma'muriyat" → "Modul sozlamalari" → "Kirish" yorlig'idagi (to'liq holat ustuni) "Xato kodlari" bo'limida sozlangan.
qayta ishlangan Mantiqiy qiymat (to'g'ri/noto'g'ri). Xabar qayta ishlanayotgan bo'lsa, qiymat haqiqiy hisoblanadi. Xabarni qayta ishlash boshlanmagan bo'lsa, qiymat noto'g'ri hisoblanadi
qabul qilingan Mantiqiy qiymat (to'g'ri/noto'g'ri). Xabar platforma tomonidan qabul qilingan taqdirdagina qiymat haqiqiy hisoblanadi. Xabar platforma
oxirgi_hamkor Xabarni yetkazib berish uchun oxirgi kanal. Agar xabar platforma tomonidan bloklangan bo'lsa, maydonning qiymati "msghub" dir. Batafsil (kengaytirilgan) hisobot uchun ushbu parametr har bir aloqa kanali uchun o'rnatiladi
etkazib berildi Xabarni yetkazib berish uchun oxirgi kanal. Agar xabar qabul qilingan bo'lsa, lekin yakuniy holatni olmagan bo'lsa yoki platforma tomonidan bloklangan bo'lsa, "msghub" maydonining qiymati
boshlandi Mantiqiy qiymat (to'g'ri/noto'g'ri). Xabarni qayta ishlash boshlanmagan yoki kechikish
qayta ishlash Mantiqiy qiymat (to'g'ri/noto'g'ri). Xabar qayta ishlanayotgan bo'lsa, qiymat haqiqiy hisoblanadi. Agar xabarni qayta ishlash boshlanmagan yoki allaqachon tugallangan bo'lsa, qiymat noto'g'ri
kanal Xabar yuborish kanali
ttl Har bir kanal uchun soniyalardagi xabarning ishlash muddati