Keri sisuni

Saada sõnum

Saatke sõnumeid SMSBAT API kaudu, kasutades lõpp-punkti `/bat/messagelist'.

Lõpp-punkt

POST /bat/messagelist

Taotluse struktuur

Päringu sisu on sõnumiobjektide JSON-massiivi:

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

Parameetrid

Nõutavad parameetrid

Parameeter Tüüp Kirjeldus
"alates" string Tähtnumbriline saatja ID
kuni string Saaja telefoninumber vormingus E.164 (nt +380XXXXXXXXX)
"tüüp" string Sõnumi tüüp: "sms", "viber_promo", "viber_trans", "viber_carousel", "viber_survey", "viber_otp", "rcs", "flashcall"
tekst string Sõnumi sisu (nõutav enamiku tüüpide jaoks, mõne jaoks valikuline)

Valikulised parameetrid

Parameeter Tüüp Kirjeldus
customerMessageId string Teie sisemine identifikaator jälgimiseks
ttl täisarv Eluaeg sekundites
messageData objekt Tüübispetsiifiline konfiguratsioon (muutub olenevalt teate tüübist)

Autentimine

Valige üks kolmest autentimismeetodist:

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

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

Vastus

Edukas vastus

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

Vastuseväljad

Väli Tüüp Kirjeldus
messagelistId täisarv Sõnumiloendi kordumatu identifikaator
messageId string Iga sõnumi kordumatu identifikaator
olek string Sõnumi olek: "vastu võetud", "tagasi lükatud", "ebaõnnestus"
osad täisarv Sõnumi osade arv (SMS jaoks)
customerMessageId string Teie sisemine identifikaator (kui see on olemas)
kuni string Saaja telefoninumber

Sõnumitüübid

SMS

Lihtsad tekstisõnumid:

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

Viber Promo

Reklaamsõnumid rikasmeediaga:

{
  "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"
    }
  }
}

Viberi tehing

Tehingu teatised:

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

Viber OTP

Ühekordsed parooliteatised:

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

Vigade käsitlemine

HTTP olekukoodid

Kood Kirjeldus
200 Taotlus õnnestus
400 Halb taotlus – kehtetud parameetrid
401 Volitamata – autentimine ebaõnnestus
429 Liiga palju taotlusi – määra limiit ületatud
500 Siseserveri viga

Vastus veale

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

Parimad tavad

Telefoninumbri vorming

Kasutage telefoninumbrite jaoks alati vormingut E.164:

  • ✅ Õige: +380XXXXXXXXX
  • ❌ Vale: "380XXXXXXXXX", "0XXXXXXXXX".

Sõnumi tekst

  • Hoidke SMS-id alla 160 tähemärgi, et vältida mitut osa
  • Kasutage rahvusvaheliste märkide jaoks UTF-8 kodeeringut
  • Enne hulgi saatmist testige erimärke

TTL (eluaeg)

  • Määrake ajatundlike sõnumite jaoks sobiv TTL
  • OTP-sõnumid: 300–600 sekundit (5–10 minutit)
  • Reklaamsõnumid: 3600–86400 sekundit (1–24 tundi)

Kliendi sõnumi ID

  • Kasutage iga sõnumi jaoks kordumatut identifikaatorit
  • Aitab jälgimisel ja silumisel
  • Kasulik teie süsteemi kirjetega korreleerimiseks

Hindade piirangud

Võtke ühendust oma kontohalduriga järgmise teabe saamiseks:

  • Sõnumeid sekundis
  • Sõnumid päevas
  • Samaaegsed ühendused

Järgmised sammud