Pereiti prie turinio

SMSBAT API

SMSBAT yra RESTful API platforma, skirta siųsti įvairių tipų pranešimus, įskaitant Viber karuselę, Viber nuomonės dialogą, Viber reklamą (nuotraukas, vaizdo įrašus), Viber verslo pokalbius, OTP pranešimus (Viber OTP, Flash Call) ir jų atsarginius variantus.

Bazinis URL

Užklausos SMSBAT API perduodamos į galutinį tašką su lokalizacija. Iš anksto paprašykite adreso iš savo vadybininko.

Pavyzdys: „https://restapi.smsbat.com“ (tikrasis URL gali skirtis atsižvelgiant į jūsų regioną)

Autentifikavimas

SMSBAT API palaiko tris autentifikavimo būdus:

1 būdas: HTTP pagrindinis autentifikavimas

Naudokite savo vartotojo vardą ir slaptažodį:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d @request.json

2 būdas: API rakto antraštė

Naudokite antraštę „X-Authorization-Key“:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

3 būdas: API raktas kaip slaptažodis

Naudokite „@“ kaip vartotojo vardą ir API raktą kaip slaptažodį:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Galimi galutiniai taškai

Metodas Galutinis taškas Aprašymas
POST „/šikšnosparnis/pranešimų sąrašas“ Siųsti žinutes
GAUTI /bat/message/{messageId} Patikrinkite pranešimo būseną

Pranešimų tipai

SMSBAT API palaiko šiuos pranešimų tipus:

  • SMS - standartinės tekstinės žinutės
  • Viber Promo - Reklaminiai pranešimai su raiškiąja medija
  • Viber Transactional - Sandorių pranešimai – Viber Carousel – interaktyvūs karuselės pranešimai – Viber Survey – Nuomonių dialogo pranešimai – Viber OTP – vienkartiniai slaptažodžio pranešimai – RCS – gausūs komunikacijos paslaugų pranešimai – Flash Call – tylus skambučio patvirtinimas

Pagrindinės savybės

Atsarginiai pranešimai

Kai pirminis pristatymas nepavyksta, SMSBAT automatiškai grįžta į alternatyvius kanalus:

Viber → SMS → Email

Raiškiosios medijos palaikymas

Siųsti žinutes su:

  • Vaizdai (JPG, PNG)
  • Vaizdo įrašai (MP4)
  • PDF
  • Mygtukai ir veiksmų nuorodos

Pranešimo būsenos stebėjimas

Stebėkite pristatymo būseną realiuoju laiku:

  • Išsiųstas
  • Pristatyta
  • Skaityk – Nepavyko
  • Pasibaigė

Atgaliniai skambučiai

Gaukite „Viber“ pranešimų atgalinius skambučius abipusiam ryšiui.

Greita pradžia

  1. Siųsti žinutę – sužinokite, kaip išsiųsti pirmąjį pranešimą
  2. Patikrinti būseną – stebėti pranešimo pristatymo būseną
  3. Pranešimų tipai – tyrinėkite skirtingus pranešimų tipus

Užklausos formatas

Visos užklausos naudoja JSON formatą su tokia struktūra:

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "type": "viber",
      "text": "Your message here",
      // ... additional parameters
    }
  ]
}

Atsakymo formatas

Sėkmingi atsakymai grąžinami:

{
  "messages": [
    {
      "messageId": "unique-message-id",
      "recipient": "+380XXXXXXXXX",
      "status": "sent"
    }
  ]
}

Klaidų tvarkymas

HTTP būsenos kodai:

– „200 gerai“ – užklausa įvykdyta – „400 netinkama užklausa“ – netinkamas užklausos formatas – „401 Neteisėtas“ – Autentifikavimas nepavyko – „429 per daug užklausų“ – viršytas normos limitas - „500 vidinė serverio klaida“ – serverio klaida

Kiti žingsniai