Hyppää sisältöön

SMSBAT API

SMSBAT on RESTful API-alusta erityyppisten viestien lähettämiseen, mukaan lukien Viber-karuselli, Viber-mielipidedialogi, Viber-promo (kuvat, video), Viber-yrityskeskustelu, OTP-ilmoitukset (Viber OTP, Flash Call) ja niiden varaversiot.

Perus-URL-osoite

Pyynnöt SMSBAT API:lle lähetetään lokalisoituun päätepisteeseen. Pyydä osoite etukäteen esimieheltäsi.

Esimerkki: https://restapi.smsbat.com (todellinen URL-osoite voi vaihdella alueesi mukaan)

Todennus

SMSBAT API tukee kolmea todennusmenetelmää:

Tapa 1: HTTP-perustodennus

Käytä käyttäjätunnustasi ja salasanaasi:

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

Tapa 2: API-avaimen otsikko

Käytä X-Authorization-Key-otsikkoa:

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

Tapa 3: API-avain salasanana

Käytä @-kirjainta käyttäjätunnuksena ja API-avainta salasanana:

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

Saatavilla olevat päätepisteet

Menetelmä Päätepiste Kuvaus
POST /lepakko/viestilista Lähetä viestejä
HANKI /bat/message/{messageId} Tarkista viestin tila

Viestityypit

SMSBAT API tukee seuraavia viestityyppejä:

  • SMS - Normaalit tekstiviestit
  • Viber Promo - Mainosviestit multimedialla
  • Viber Transactional - Tapahtumailmoitukset
  • Viber Carousel - Interaktiiviset karuselliviestit
  • Viber Survey - Mielipidevalintaikkunat
  • Viber OTP - Kertaluonteiset salasanailmoitukset
  • RCS - Rich Communication Services -viestit
  • Flash Call - Äänetön puhelun vahvistus

Tärkeimmät ominaisuudet

Varaviestit

Kun ensisijainen toimitus epäonnistuu, SMSBAT palaa automaattisesti vaihtoehtoisille kanaville:

Viber → SMS → Email

Rich Media -tuki

Lähetä viestejä seuraavilla tavoilla:

  • Kuvat (JPG, PNG)
  • Videot (MP4)
  • PDF-tiedostoja
  • Painikkeet ja toimintalinkit

Viestin tilan seuranta

Seuraa toimituksen tilaa reaaliajassa:

  • Lähetetty
  • Toimitettu
  • Lue
  • Epäonnistui
  • Vanhentunut

Takaisinsoittoja

Vastaanota saapuvia Viber-viestien takaisinsoittoja kaksisuuntaista viestintää varten.

Pika-aloitus

  1. Lähetä viesti - Opi lähettämään ensimmäinen viestisi
  2. Tarkista tila - Seuraa viestin toimituksen tilaa
  3. Viestityypit - Tutustu eri viestityyppeihin

Pyydä muotoa

Kaikki pyynnöt käyttävät JSON-muotoa seuraavalla rakenteella:

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

Vastausmuoto

Onnistuneet vastaukset palautuvat:

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

Virheiden käsittely

HTTP-tilakoodit:

  • "200 OK" - Pyyntö onnistui
  • "400 virheellinen pyyntö" - Virheellinen pyyntömuoto
  • 401 Luvaton - Todennus epäonnistui
  • "429 liian monta pyyntöä" - Raja ylitetty
  • "500 Sisäinen palvelinvirhe" - Palvelinvirhe

Seuraavat vaiheet