Přeskočit obsah

SMSBAT API

SMSBAT je platforma RESTful API pro odesílání různých typů zpráv včetně karuselu Viber, dialogu názoru Viber, promo akce Viber (obrázky, video), obchodního chatu Viber, oznámení OTP (Viber OTP, Flash Call) a jejich záložních variant.

Základní URL

Požadavky na SMSBAT API jsou přenášeny do koncového bodu s lokalizací. Adresu si předem vyžádejte od svého manažera.

Příklad: „https://restapi.smsbat.com“ (skutečná adresa URL se může lišit v závislosti na vaší oblasti)

Autentizace

SMSBAT API podporuje tři metody ověřování:

Metoda 1: Základní ověření HTTP

Použijte své uživatelské jméno a heslo:

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

Metoda 2: Záhlaví klíče API

Použijte záhlaví „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

Metoda 3: Klíč API jako heslo

Jako uživatelské jméno použijte @ a jako heslo svůj klíč API:

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

Dostupné koncové body

Metoda Koncový bod Popis
PŘÍSPĚVEK /bat/messagelist Odesílat zprávy
ZÍSKEJTE /bat/message/{messageId} Zkontrolujte stav zprávy

Typy zpráv

SMSBAT API podporuje následující typy zpráv:

  • SMS - Standardní textové zprávy
  • Viber Promo - Propagační zprávy s bohatými médii
  • Viber Transakční - Oznámení o transakcích
  • Viber Carousel - Interaktivní zprávy karuselu
  • Viber Survey - Dialogové zprávy názorů
  • Viber OTP - Jednorázová upozornění na heslo
  • RCS - Zprávy Rich Communication Services
  • Flash Call - Ověření tichého hovoru

Klíčové vlastnosti

Záložní zprávy

Když primární doručení selže, SMSBAT se automaticky vrátí k alternativním kanálům:

Viber → SMS → Email

Podpora multimédií

Odesílejte zprávy pomocí:

  • obrázky (JPG, PNG)
  • Videa (MP4)
  • soubory PDF
  • Tlačítka a akční odkazy

Sledování stavu zpráv

Sledujte stav doručení v reálném čase:

  • Odesláno
  • Doručeno
  • Čtěte
  • Nepodařilo se
  • Platnost vypršela

Zpětná volání

Přijímejte zpětná volání příchozích zpráv Viber pro obousměrnou komunikaci.

Rychlý start

  1. Odeslat zprávu – Přečtěte si, jak odeslat první zprávu
  2. Kontrola stavu – Sledujte stav doručení zprávy
  3. Typy zpráv – Prozkoumejte různé typy zpráv

Formát požadavku

Všechny požadavky používají formát JSON s následující strukturou:

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

Formát odpovědi

Úspěšné odpovědi se vrátí:

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

Zpracování chyb

Stavové kódy HTTP:

  • 200 OK - Žádost byla úspěšná
  • 400 Bad Request - Neplatný formát požadavku
  • 401 Unauthorized - Autentizace se nezdařila
  • 429 Příliš mnoho požadavků - Překročen limit sazby
  • 500 Internal Server Error - Chyba serveru

Další kroky