Pāriet uz saturu

Sūtīt ziņu

Sūtiet ziņojumus, izmantojot SMSBAT API, izmantojot galapunktu /bat/messagelist.

Galapunkts

POST /bat/messagelist

Pieprasījuma struktūra

Pieprasījuma pamatteksts ir ziņojumu objektu JSON masīvs:

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

Parametri

Nepieciešamie parametri

Parametrs Tips Apraksts
no stīga Burtciparu sūtītāja ID
uz stīga Saņēmēja tālruņa numurs E.164 formātā (piemēram, +380XXXXXXXXX)
"tips" stīga Ziņojuma veids: "sms", "viber_promo", "viber_trans", "viber_carousel", "viber_survey", "viber_otp", "rcs", "flashcall"
teksts stīga Ziņojuma saturs (nepieciešams lielākajai daļai veidu, neobligāts dažiem)

Izvēles parametri

Parametrs Tips Apraksts
customerMessageId stīga Jūsu iekšējais identifikators izsekošanai
ttl vesels skaitlis Izdzīvošanas laiks sekundēs
messageData objekts Tipam raksturīga konfigurācija (atšķiras atkarībā no ziņojuma veida)

Autentifikācija

Izvēlieties vienu no trim autentifikācijas metodēm:

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

Atbilde

Veiksmīga atbilde

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

Atbildes lauki

Lauks Tips Apraksts
messagelistId vesels skaitlis Unikāls ziņojumu saraksta identifikators
messageId stīga Katra ziņojuma unikāls identifikators
statuss stīga Ziņojuma statuss: "pieņemts", "noraidīts", "neizdevās"
"daļas" vesels skaitlis Ziņojumu daļu skaits (īsziņām)
customerMessageId stīga Jūsu iekšējais identifikators (ja tāds ir)
uz stīga Saņēmēja tālruņa numurs

Ziņojumu veidi

SMS

Vienkāršas īsziņas:

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

Viber Promo

Reklāmas ziņojumi ar bagātinātu multividi:

{
  "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 darījums

Paziņojumi par darījumiem:

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

Viber OTP

Vienreizēji paziņojumi par paroli:

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

Kļūdu apstrāde

HTTP statusa kodi

Kods Apraksts
200 Pieprasījums veiksmīgs
400 Nederīgs pieprasījums — nederīgi parametri
401 Neautorizēts — autentifikācija neizdevās
429 Pārāk daudz pieprasījumu — pārsniegts ātruma ierobežojums
500 Iekšējā servera kļūda

Atbilde uz kļūdu

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

Labākā prakse

Tālruņa numura formāts

Tālruņa numuriem vienmēr izmantojiet E.164 formātu:

  • ✅ Pareizi: +380XXXXXXXXX - ❌ Nepareizi: "380XXXXXXXXX", "0XXXXXXXXX".

Ziņas teksts

  • Saglabājiet SMS, kas nepārsniedz 160 rakstzīmes, lai izvairītos no vairākām daļām
  • Izmantojiet UTF-8 kodējumu starptautiskajām rakstzīmēm
  • Pirms lielapjoma sūtīšanas pārbaudiet īpašās rakstzīmes

TTL (dzīves laiks)

  • Iestatiet atbilstošu TTL ziņojumiem, kas ir jutīgi pret laiku
  • OTP ziņojumi: 300–600 sekundes (5–10 minūtes)
  • Reklāmas ziņojumi: 3600-86400 sekundes (1-24 stundas)

Klienta ziņojuma ID

  • Katram ziņojumam izmantojiet unikālus identifikatorus
  • Palīdz ar izsekošanu un atkļūdošanu
  • Noderīga korelācijai ar jūsu sistēmas ierakstiem

Likmes ierobežojumi

Sazinieties ar sava konta pārzini, lai iegūtu informāciju par:

  • Ziņojumi sekundē
  • Ziņojumi dienā
  • Vienlaicīgi savienojumi

Nākamie soļi