База знаний

Umumiy tavsif

Ushbu REST API () mijozlar va bildirishnoma serveri o'rtasidagi o'zaro aloqa uchun mo'ljallangan. API () ga barcha soʻrovlar HTTP orqali amalga oshiriladi. So‘rovning asosiy qismi JSON formatida uzatiladi. Bunday holda, Content-type: application/json ni o'rnatishingiz kerak. Bundan tashqari, charset parametrida kodlash qiymatini o'tkazishingiz kerak - UTF-8. Sana va vaqtni yuborish formati ISO 8601. Vaqt UTC

vaqt mintaqasida uzatiladi.

Autentifikatsiya

Asosiy autentifikatsiyadan foydalanish. Asosiy autentifikatsiya bilan mijoz so'rov bilan birga serverga login va parolni yuboradi. Ushbu ma'lumotlar avtorizatsiya so'rovi sarlavhasida base64 kodi sifatida yuboriladi. Avtorizatsiya: Basic base64_encode(login:password) Masalan, login va parol admin bo'lsa, quyidagi sarlavhani qo'shishingiz kerak: Avtorizatsiya: Asosiy YWRtaW46YWRtaW4=

Umumiy javob formati

Tegishli kodlar bilan HTTP javoblaridan foydalaniladi. Har qanday javob o'zgaruvchisi bir nechta qiymatga ega bo'lsa, ular massiv sifatida shakllantiriladi. Agar so'rovda biron bir o'zgaruvchi uchun bir nechta qiymat bo'lsa, javobdagi qiymatlar bir xil tartibda bo'ladi.

Agar so'rovda xatolik bo'lsa (kod 400), javob matnida quyidagi maydonlarga ega JSON obyekti bo'lishi kerak.

Ism Tur Majburiyat Tavsif
xato_kodi string ha Xato kodi
xato_ta'rifi string ha Xato tavsifi

Xato kodlari

Ushbu kodlar 400-kodli HTTP javobi qabul qilinganda qaytariladi. Ular yuqorida tavsiflangan "xato_kodi" maydonining qiymatlaridir.

Kod Tavsif Tarjima
100 ta ichki server xatosi Ichki server xatosi
101 Sintaksis xatosi Sintaksis xatosi
102 Hisobni bloklash Mijoz hisobi bloklandi
103 bo'sh kanal Xabar yuborish uchun kanal o‘rnatilmagan
104 ustuvorlik noto'g'ri Ustuvorlik parametri uchun notoʻgʻri qiymat koʻrsatilgan
105 ta juda ko'p identifikator Juda ko'p xabar identifikatorlari o'tkazildi
202 bo'sh qabul qiluvchi Qabul qiluvchi manzili sozlanmagan (elektron pochta kanalidan tashqari)
204 Bo'sh elektron pochta manzili Qabul qiluvchining elektron pochta manzili sozlanmagan (elektron pochta kanali uchun)
205 bo'sh xabar identifikatori Xabar identifikatori sozlanmagan
206 noto'g'ri o'zgaruvchilar Oʻzgaruvchilar parametri uchun notoʻgʻri qiymat koʻrsatilgan
301 mahalliy vaqt noto'g'ri Lokal vaqt parametri uchun notoʻgʻri qiymat koʻrsatilgan
302 noto'g'ri start-datetime Start-datetime parametri uchun notoʻgʻri qiymat koʻrsatilgan
303 tugash sanasi noto'g'ri End-datetime parametri uchun noto‘g‘ri qiymat ko‘rsatilgan
304 ruxsat etilgan theadlash vaqti noto'g'ri Izohlangan theadlash vaqti parametri uchun notoʻgʻri qiymat koʻrsatilgan
305 Ruxsat berilgan vaqt noto'g'ri Roseedendtime parametri uchun notoʻgʻri qiymat koʻrsatilgan
306 noto'g'ri yuborish Yo'llash parametri uchun noto'g'ri qiymat ko'rsatilgan
401 bo'sh yaratuvchi Yuborish manzili ko'rsatilmagan
402 Bo'sh ilova Ilova ko'rsatilmagan
403 bo'sh ttl ttl qiymati ko'rsatilmagan (agar bir nechta yuborish kanallari ko'rsatilgan bo'lsa)
404 Bo'sh kontent Xabar mazmuni belgilanmagan
405 Kontent xatosi Noto'g'ri kontent formati
406 noto'g'ri kontent Ko'rsatilgan kanal uchun kontent qiymati noto'g'ri
407 noto'g'ri ttl Yetkazib berish muddati tugashi uchun noto‘g‘ri qiymat
408 Yaroqsiz biriktirilgan fayllar Biriktirilgan fayllar juda katta
410 ta noto'g'ri qayta urinish Terishga urinishlar sonining qiymati noto'g'ri
411 Qayta urinish muddati noto'g'ri Qayta terish vaqti qiymati noto'g'ri ko'rsatilgan

Xabar yuborish

Play Mobile serveri https://127.0.0.1/brokerapi/send URL manzilidagi mijoz serveridan so'rovlarni qabul qiladi

So'rov parametrlari

Umumiy parametrlar.

Sarlavha Tur Majburiyat Tavsif
shablon identifikatori string yo'q Xabar yuborish uchun shablon identifikatori
ustuvorlik string yo'q Ustuvorlik: 2 - past, 4 - normal, 6 - yuqori, 8 - eng yuqori. Agar ko'rsatilmagan bo'lsa, 4 ishlatiladi
vaqt ob'ekt yo'q Vaqtinchalik sozlamalar
sms ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari
qo'ng'iroq ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari
xabarlar massiv yo'q Tegishli kanal orqali yuborish parametrlari

Vaqtni belgilash obyekti parametrlari.

Sarlavha Tur Majburiyat Tavsif
shablon identifikatori string yo'q Xabar yuborish uchun shablon identifikatori
ustuvorlik string yo'q Ustuvorlik: 2 - past, 4 - normal, 6 - yuqori, 8 - eng yuqori. Agar ko'rsatilmagan bo'lsa, 4 ishlatiladi
vaqt ob'ekt yo'q Vaqtinchalik sozlamalar
sms ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari
qo'ng'iroq ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari
xabarlar massiv yo'q Tegishli kanal orqali yuborish parametrlari

SMS uchun kontent obyekti parametrlari

Sarlavha Tur Majburiyat Tavsif
oluvchi string yo'q Yuborish manzili

Qo'ng'iroq uchun kontent obyekti parametrlari

Sarlavha Tur Majburiyat Tavsif
matn string yo'q TTS sintezi uchun xabar matni, 2000 baytgacha (1000 belgi). Uch parametrdan biri ishlatiladi: matn, fayl, ivrmenu. Bir nechta parametrga ega bo'lgan so'rov noto'g'ri hisoblanadi
ustuvorlik string yo'q Ustuvorlik: 2 - past, 4 - normal, 6 - yuqori, 8 - eng yuqori. Agar ko'rsatilmagan bo'lsa, 4 ishlatiladi
fayl string yo'q Audio fayl nomi. Uch parametrdan biri ishlatiladi: matn, fayl, ivrmenu. Bir nechta parametrga ega boʻlgan soʻrov haqiqiy emas deb hisoblanadi.
menyu string yo'q IVR menyu nomi. Uch parametrdan biri ishlatiladi: matn, fayl, ivrmenu. Bir nechta parametrga ega boʻlgan soʻrov haqiqiy emas deb hisoblanadi.
qayta urinish Raqam yo'q Qayta urinishlar soni. Faqat manfiy bo'lmagan raqamlarga ruxsat beriladi.
qayta urinish- Raqam yo'q Millisekundlarda qayta qo'ng'iroq qilish vaqti tugashi uchun interval

Xabarlar massivi elementi parametrlari.

Sarlavha Tur Majburiyat Tavsif
qabul qiluvchi string yo'q Qabul qiluvchining manzili (odatda MSISDN) qat'iy ravishda 9989xxxxxxx formatida, bo'sh joysiz va + belgisiz ko'rsatilgan
xabar identifikatori string yo'q Yuborish tizimiga xos bo'lgan xabar identifikatori yuborilgan yoki yo'naltirilgan har bir xabar uchun yagona bo'lishi kerak. Misol “abc0000001” abc = tashkilot nomi. Maydon hajmi 40 belgidan oshmasligi kerak
shablon identifikatori string yo'q Xabar yuborish uchun shablon identifikatori
ustuvorlik string yo'q Ustuvorlik: past - past, normal - normal, yuqori - yuqori, real vaqt - eng yuqori. Agar ko'rsatilmagan bo'lsa, u holda shaxsiy hisobingizda konfiguratsiya qilingan.
vaqt ob'ekt yo'q Vaqtinchalik sozlamalar
o'zgaruvchilar massiv yo'q Xabarda almashtiriladigan parametrlar ob'ekti va ularning qiymatlari (har bir element PARAMETER:VALUE yozuvi sifatida taqdim etiladi, masalan, {“PARAM1”:”VALUE1”,”PARAM2”:”VALUE2”} ).
sms ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari
qo'ng'iroq ob'ekt yo'q Tegishli kanal orqali yuborish parametrlari

Vaqtni belgilash va kanal ob'ektlari parametrlari so'rovning umumiy qismi bilan bir xil

Javob parametrlari: Muvaffaqiyatli so'rov 200/OK holatiga ega va so'rovning javob qismi olinadi

Xabarni yuborish holatlari

Hamkorning URL manzili (): sherikning /status URL () SMSC "Play Mobile" dan yuborilgan xabarlarning holatini olishga majburlash uchun ishlatiladi. Holat mobil operatordan olishimiz bilan hamkorning URL manziliga () yuboriladi.

Yagona status status.json yuborilmoqda

    {
     "xabarlar": [
     {
     "message-id": "",
     "kanal": "",
     "status": "",
     "status-date": "",
     "tavsif": ""
     }
     ]
    }

Status.jsonni ommaviy yuborish

    {
     "xabarlar": [
     {
     "message-id": "",
     "kanal": "",
     "status": "",
     "status-date": "",
     "tavsif": ""
     },
     {
     "message-id": "",
     "kanal": "",
     "status": "",
     "status-date": "",
     "tavsif": ""
     }
     ]
    }

Holat so'rovi quyidagi xabar holatlarini qaytaradi:

Etkazib berildi - yetkazib berildi; Uzatildi - operatorga yuborildi, sizning SMS-xabaringiz qabul qilindi va operatorga yuborildi, operator uni hali qayta ishlamagan, sababi abonent tarmoq hududidan tashqarida yoki o'chirilgan bo'lishi mumkin. 24 soatdan keyin holat Yetkazib berildi ga o'zgaradi.; NotDelivered - yetkazib berilmagan, odatda sabab abonent operator tomonidan bloklangan bo'lishi mumkin (etarlicha mablag' yoki qarz); Rad etilgan - asosiy sabablardan biri bu raqam qora ro'yxatda bo'lishi; Muvaffaqiyatsiz - so'rovni yuborishda xatolik yuz berdi (masalan, jo'natuvchining manzili noto'g'ri bo'lsa); Muddati tugadi - SMS muddati tugadi (abonent 24 soat davomida aloqa qilmaganida. Beeline uchun, agar bir soat ichida bo'lsa).

Misollar

Yagona xabar yuborish

    {
     "xabarlar": [
     {
     "recipient": "998900000000",
     "message-id": "abc000000001",
     "SMS": {
     "originator": "3700",
     "tarkib": {
     "text": "Test xabari"
     }
     }
     }
     ]
    }

Yagona xabar yuborish

    {
     "xabarlar": [
     {
     "recipient": "9989xxxxxxxx",
     "message-id": "abc00000001",
     "SMS": {
     "originator": "3700",
     "tarkib": {
     "text": "Test matni"
     }
     }
     },
     {
     "recipient": "9989xxxxxxxx",
     "message-id": "abc00000002",
     "SMS": {
     "originator": "3700",
     "tarkib": {
     "text": "Test matni 1"
     }
     }
     },
     {
     "recipient": "ivr70000000",
     "message-id": "abc00000003",
     "SMS": {
     "ishlab chiqaruvchi": 3700,
     "tarkib": {
     "text": "Test matni2"
     }
     }
     }
     ]
    }