Help Center Siųsti žinutę

Siųsti žinutę

Siųskite pranešimus per SMSBAT API naudodami „/bat/messagelist“ galinį tašką.

Galutinis taškas

POST /bat/messagelist

Užklausos struktūra

Užklausos turinys yra JSON pranešimų objektų masyvas:

{
  "messages": [
    {
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Your message text",
      "customerMessageId": "your-internal-id",
      "ttl": 3600
    }
  ]
}

Parametrai

Reikalingi parametrai

ParametrasTipasAprašymas
”nuo”stygaRaidinis ir skaitinis siuntėjo ID
”į”stygaGavėjo telefono numeris E.164 formatu (pvz., +380XXXXXXXXX)
“tipas”stygaPranešimo tipas: „sms“, „viber_promo“, „viber_trans“, „viber_carousel“, „viber_survey“, „viber_otp“, „rcs“, „flashcall“
“tekstas”stygaPranešimo turinys (būtinas daugeliui tipų, neprivalomas kai kuriems)

Pasirenkami parametrai

ParametrasTipasAprašymas
„customerMessageId“stygaJūsų vidinis stebėjimo identifikatorius
ttlsveikasis skaičiusLaikas gyventi sekundėmis
messageDataobjektasTipui būdinga konfigūracija (kinta priklausomai nuo pranešimo tipo)

Autentifikavimas

Pasirinkite vieną iš trijų autentifikavimo būdų:

=== “API rakto antraštė”

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -H "X-Authorization-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

=== „HTTP pagrindinis autentifikavimas“

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

=== “API raktas kaip slaptažodis”

```bash
curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "from": "YourSender",
      "to": "+380XXXXXXXXX",
      "type": "sms",
      "text": "Hello from SMSBAT!"
    }]
  }'
```

Atsakymas

Sėkmės atsakas

{
  "messagelistId": 123456,
  "messages": [
    {
      "messageId": "abc123def456",
      "status": "accepted",
      "parts": 1,
      "customerMessageId": "your-internal-id",
      "to": "+380XXXXXXXXX"
    }
  ]
}

Atsakymo laukai

LaukasTipasAprašymas
messagelistIdsveikasis skaičiusUnikalus pranešimų sąrašo identifikatorius
messageIdstygaUnikalus kiekvieno pranešimo identifikatorius
”būsena”stygaPranešimo būsena: „priimta“, „atmesta“, „nepavyko“
“detalės”sveikasis skaičiusPranešimų dalių skaičius (SMS)
„customerMessageId“stygaJūsų vidinis identifikatorius (jei pateiktas)
“į”stygaGavėjo telefono numeris

Pranešimų tipai

SMS

Paprasti tekstiniai pranešimai:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "sms",
  "text": "Your SMS message text"
}

Viber reklama

Reklaminiai pranešimai su raiškiąja medija:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_promo",
  "text": "Check out our new product!",
  "messageData": {
    "image": "https://example.com/image.jpg",
    "button": {
      "text": "View Product",
      "url": "https://example.com/product"
    }
  }
}

Viber sandoris

Pranešimai apie sandorį:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_trans",
  "text": "Your order #12345 has been confirmed"
}

Viber OTP

Vienkartiniai slaptažodžio pranešimai:

{
  "from": "YourSender",
  "to": "+380XXXXXXXXX",
  "type": "viber_otp",
  "messageData": {
    "code": "123456",
    "validity": 300
  }
}

Klaidų tvarkymas

HTTP būsenos kodai

KodasAprašymas
200Užklausa sėkminga
400Netinkama užklausa – neteisingi parametrai
401Neteisėta – autentifikavimas nepavyko
429Per daug užklausų – viršytas normos limitas
500Vidinė serverio klaida

Atsakymas į klaidą

{
  "error": {
    "code": "INVALID_RECIPIENT",
    "message": "Invalid phone number format"
  }
}

Geriausia praktika

Telefono numerio formatas

Telefonų numeriams visada naudokite E.164 formatą:

  • ✅ Teisingai: +380XXXXXXXXX – ❌ Neteisinga: „380XXXXXXXXX“, „0XXXXXXXXX“.

Pranešimo tekstas

  • Laikykite SMS iki 160 simbolių, kad išvengtumėte kelių dalių
  • Naudokite UTF-8 kodavimą tarptautiniams simboliams
  • Išbandykite specialiuosius simbolius prieš masinį siuntimą

TTL (gyvenimo laikas)

  • Nustatykite atitinkamą TTL laiko jautriems pranešimams – Vienkartiniai pranešimai: 300–600 sekundžių (5–10 minučių) – Reklaminiai pranešimai: 3600–86400 sekundžių (1–24 val.)

Kliento pranešimo ID

  • Kiekvienam pranešimui naudokite unikalius identifikatorius
  • Padeda sekti ir derinti
  • Naudinga koreliuojant su jūsų sistemos įrašais

Kainos ribos

Susisiekite su savo paskyros valdytoju dėl informacijos apie:

  • Žinutės per sekundę
  • Žinutės per dieną
  • Lygiagreti ryšiai

Kiti žingsniai