Pereiti prie turinio

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

Parametras Tipas Aprašymas
"nuo" styga Raidinis ir skaitinis siuntėjo ID
"į" styga Gavėjo telefono numeris E.164 formatu (pvz., +380XXXXXXXXX)
"tipas" styga Pranešimo tipas: „sms“, „viber_promo“, „viber_trans“, „viber_carousel“, „viber_survey“, „viber_otp“, „rcs“, „flashcall“
"tekstas" styga Pranešimo turinys (būtinas daugeliui tipų, neprivalomas kai kuriems)

Pasirenkami parametrai

Parametras Tipas Aprašymas
„customerMessageId“ styga Jūsų vidinis stebėjimo identifikatorius
ttl sveikasis skaičius Laikas gyventi sekundėmis
messageData objektas Tipui būdinga konfigūracija (kinta priklausomai nuo pranešimo tipo)

Autentifikavimas

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

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!"
    }]
  }'
```

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

Laukas Tipas Aprašymas
messagelistId sveikasis skaičius Unikalus pranešimų sąrašo identifikatorius
messageId styga Unikalus kiekvieno pranešimo identifikatorius
"būsena" styga Pranešimo būsena: „priimta“, „atmesta“, „nepavyko“
"detalės" sveikasis skaičius Pranešimų dalių skaičius (SMS)
„customerMessageId“ styga Jūsų vidinis identifikatorius (jei pateiktas)
"į" styga Gavė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

Kodas Aprašymas
200 Užklausa sėkminga
400 Netinkama užklausa – neteisingi parametrai
401 Neteisėta – autentifikavimas nepavyko
429 Per daug užklausų – viršytas normos limitas
500 Vidinė 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