Preskočiť na obsah

SMSBAT API

SMSBAT je platforma RESTful API na odosielanie rôznych typov správ vrátane kolotoča Viber, dialógu názorov Viber, propagácie Viber (obrázky, video), obchodného chatu Viber, oznámení OTP (Viber OTP, Flash Call) a ich záložných variantov.

Základná adresa URL

Požiadavky na SMSBAT API sa prenášajú do koncového bodu s lokalizáciou. Vopred si vyžiadajte adresu od svojho manažéra.

Príklad: https://restapi.smsbat.com (skutočná adresa URL sa môže líšiť v závislosti od oblasti)

Autentifikácia

SMSBAT API podporuje tri metódy autentifikácie:

Metóda 1: HTTP Basic Auth

Použite svoje používateľské meno a heslo:

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

Metóda 2: Hlavička kľúča API

Použite hlavičku „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

Metóda 3: Kľúč API ako heslo

Použite @ ako používateľské meno a váš kľúč API ako heslo:

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

Dostupné koncové body

Metóda Koncový bod Popis
Zverejniť /bat/messagelist Posielať správy
ZÍSKAJTE /bat/message/{messageId} Skontrolujte stav správy

Typy správ

SMSBAT API podporuje nasledujúce typy správ:

  • SMS - Štandardné textové správy
  • Viber Promo - Propagačné správy s multimediálnymi údajmi
  • Viber Transactional - Oznámenia o transakciách
  • Viber Carousel - Interaktívne správy karuselu
  • Viber Survey - Dialógové správy s názormi
  • Viber OTP - Jednorazové upozornenia na heslo
  • RCS - Správy bohatých komunikačných služieb
  • Flash Call - Overenie tichého hovoru

Kľúčové vlastnosti

Záložné správy

Keď primárne doručenie zlyhá, SMSBAT sa automaticky vráti späť na alternatívne kanály:

Viber → SMS → Email

Podpora multimédií

Posielajte správy pomocou:

  • obrázky (JPG, PNG)
  • videá (MP4)
  • súbory PDF
  • Tlačidlá a akčné odkazy

Sledovanie stavu správy

Sledujte stav doručenia v reálnom čase:

  • Odoslané
  • Doručené
  • Čítaj
  • Nepodarilo sa
  • Platnosť vypršala

Spätné volanie

Prijímajte prichádzajúce spätné volania správ Viber pre obojsmernú komunikáciu.

Rýchly štart

  1. Odoslať správu – Zistite, ako odoslať prvú správu
  2. Skontrolovať stav – Sledujte stav doručenia správy
  3. Typy správ – Preskúmajte rôzne typy správ

Formát žiadosti

Všetky požiadavky používajú formát JSON s nasledujúcou štruktúrou:

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

Formát odpovede

Úspešné odpovede sa vrátia:

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

Spracovanie chýb

Stavové kódy HTTP:

  • 200 OK - Žiadosť bola úspešná
  • 400 Bad Request - Neplatný formát požiadavky
  • 401 Unauthorized - Autentifikácia zlyhala
  • 429 Too Many Requests - Prekročený limit sadzby
  • 500 Interná chyba servera - Chyba servera

Ďalšie kroky