Ga naar inhoud

SMSBAT-API

SMSBAT is een RESTful API-platform voor het verzenden van verschillende soorten berichten, waaronder Viber-carrousel, Viber-meningsdialoog, Viber-promo (foto's, video), Viber zakelijke chat, OTP-meldingen (Viber OTP, Flash Call) en hun fallback-varianten.

Basis-URL

Verzoeken aan de SMSBAT API worden verzonden naar een eindpunt met lokalisatie. Vraag het adres vooraf op bij uw leidinggevende.

Voorbeeld: https://restapi.smsbat.com (werkelijke URL kan variëren, afhankelijk van uw regio)

Authenticatie

SMSBAT API ondersteunt drie authenticatiemethoden:

Methode 1: HTTP-basisverificatie

Gebruik uw gebruikersnaam en wachtwoord:

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

Methode 2: API-sleutelheader

Gebruik de header '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

Methode 3: API-sleutel als wachtwoord

Gebruik @ als gebruikersnaam en uw API-sleutel als wachtwoord:

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

Beschikbare eindpunten

Werkwijze Eindpunt Beschrijving
POST /bat/berichtenlijst Berichten verzenden
KRIJG /bat/message/{messageId} Berichtstatus controleren

Berichttypen

SMSBAT API ondersteunt de volgende berichttypen:

  • SMS - Standaard sms-berichten
  • Viber Promo - Promotionele berichten met rich media
  • Viber Transactioneel - Transactiemeldingen
  • Viber Carrousel - Interactieve carrouselberichten
  • Viber Survey - Berichten in opiniedialoogvensters
  • Viber OTP - Eenmalige wachtwoordmeldingen
  • RCS - Rich Communication Services-berichten
  • Flash Call - Stille oproepverificatie

Belangrijkste kenmerken

Terugvalberichten

Wanneer de primaire bezorging mislukt, valt SMSBAT automatisch terug op alternatieve kanalen:

Viber → SMS → Email

Rich Media-ondersteuning

Stuur berichten met:

-Afbeeldingen (JPG, PNG) - Video's (MP4) - PDF's - Knoppen en actielinks

Berichtstatus volgen

Volg de bezorgstatus in realtime:

  • Verzonden
  • Geleverd
  • Lees
  • Mislukt
  • Verlopen

Terugbelgesprekken

Ontvang inkomende Viber-berichtterugbelverzoeken voor tweerichtingscommunicatie.

Snelle start

  1. Een bericht verzenden - Leer hoe u uw eerste bericht verzendt
  2. Status controleren - Volg de bezorgingsstatus van berichten
  3. Berichttypen - Ontdek verschillende berichttypen

Verzoekformaat

Alle verzoeken gebruiken het JSON-formaat met de volgende structuur:

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

Antwoordformaat

Succesvolle reacties retourneren:

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

Foutafhandeling

HTTP-statuscodes:

  • 200 OK - Verzoek succesvol
  • 400 Bad Request - Ongeldig verzoekformaat
  • 401 Niet geautoriseerd - Authenticatie mislukt
  • 429 Te veel verzoeken - Tarieflimiet overschreden
  • 500 Interne serverfout - Serverfout

Volgende stappen