Help Center Sūtīt ziņu

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

ParametrsTipsApraksts
nostīgaBurtciparu sūtītāja ID
uzstīgaSaņēmēja tālruņa numurs E.164 formātā (piemēram, +380XXXXXXXXX)
“tips”stīgaZiņojuma veids: “sms”, “viber_promo”, “viber_trans”, “viber_carousel”, “viber_survey”, “viber_otp”, “rcs”, “flashcall”
tekstsstīgaZiņojuma saturs (nepieciešams lielākajai daļai veidu, neobligāts dažiem)

Izvēles parametri

ParametrsTipsApraksts
customerMessageIdstīgaJūsu iekšējais identifikators izsekošanai
ttlvesels skaitlisIzdzīvošanas laiks sekundēs
messageDataobjektsTipam raksturīga konfigurācija (atšķiras atkarībā no ziņojuma veida)

Autentifikācija

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

=== “API atslēgas galvene”

```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 pamata autentifikācija”

```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 atslēga kā parole”

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

Atbilde

Veiksmīga atbilde

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

Atbildes lauki

LauksTipsApraksts
messagelistIdvesels skaitlisUnikāls ziņojumu saraksta identifikators
messageIdstīgaKatra ziņojuma unikāls identifikators
statussstīgaZiņojuma statuss: “pieņemts”, “noraidīts”, “neizdevās"
"daļas”vesels skaitlisZiņojumu daļu skaits (īsziņām)
customerMessageIdstīgaJūsu iekšējais identifikators (ja tāds ir)
uzstīgaSaņē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

KodsApraksts
200Pieprasījums veiksmīgs
400Nederīgs pieprasījums — nederīgi parametri
401Neautorizēts — autentifikācija neizdevās
429Pārāk daudz pieprasījumu — pārsniegts ātruma ierobežojums
500Iekšē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