Help Center Wyślij wiadomość

Wyślij wiadomość

Wysyłaj wiadomości poprzez API SMSBAT używając punktu końcowego /bat/messagelist.

Punkt końcowy

POST /bat/messagelist

Struktura żądania

Treść żądania to tablica JSON zawierająca obiekty komunikatów:

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

Parametry

Wymagane parametry

ParametrWpiszOpis
odciągAlfanumeryczny identyfikator nadawcy
dociągNumer telefonu odbiorcy w formacie E.164 (np. +380XXXXXXXXX)
typciągTyp wiadomości: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
tekstciągTreść wiadomości (wymagana dla większości typów, opcjonalna dla niektórych)

Parametry opcjonalne

ParametrWpiszOpis
Identyfikator wiadomości klientaciągTwój wewnętrzny identyfikator do śledzenia
ttlliczba całkowitaCzas życia w sekundach
Dane wiadomościobiektKonfiguracja specyficzna dla typu (różni się w zależności od typu komunikatu)

Uwierzytelnianie

Wybierz jedną z trzech metod uwierzytelniania:

=== „Nagłówek klucza API”

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

=== „Podstawowe uwierzytelnianie HTTP”

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

=== „Klucz API jako hasło”

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

Odpowiedź

Odpowiedź pomyślna

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

Pola odpowiedzi

PoleWpiszOpis
Identyfikator listy wiadomościliczba całkowitaUnikalny identyfikator listy wiadomości
Identyfikator wiadomościciągUnikalny identyfikator każdej wiadomości
stanciągStatus wiadomości: „zaakceptowana”, „odrzucona”, „nieudana”
częściliczba całkowitaLiczba części wiadomości (dla wiadomości SMS)
Identyfikator wiadomości klientaciągTwój wewnętrzny identyfikator (jeśli został podany)
dociągNumer telefonu odbiorcy

Typy wiadomości

SMS-y

Proste wiadomości tekstowe:

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

Promocja Vibera

Przekazy promocyjne z rich media:

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

Transakcje Vibera

Powiadomienia o transakcjach:

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

Viber OTP

Jednorazowe powiadomienia o hasłach:

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

Obsługa błędów

Kody stanu HTTP

KodOpis
200Żądanie powiodło się
400Złe żądanie - nieprawidłowe parametry
401Nieautoryzowane - uwierzytelnienie nie powiodło się
429Zbyt wiele żądań - przekroczono limit szybkości
500Wewnętrzny błąd serwera

Odpowiedź na błąd

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

Najlepsze praktyki

Format numeru telefonu

Zawsze używaj formatu E.164 dla numerów telefonów:

  • ✅ Poprawnie: +380XXXXXXXXX
  • ❌ Niepoprawnie: 380XXXXXXXXX, 0XXXXXXXXX

Tekst wiadomości

  • Trzymaj SMS-y o długości poniżej 160 znaków, aby uniknąć wielu części
  • Używaj kodowania UTF-8 dla znaków międzynarodowych
  • Przetestuj znaki specjalne przed wysłaniem zbiorczym

TTL (czas życia)

  • Ustaw odpowiedni TTL dla wiadomości wrażliwych na upływ czasu
  • Wiadomości OTP: 300-600 sekund (5-10 minut)
  • Wiadomości promocyjne: 3600-86400 sekund (1-24 godziny)

Identyfikator wiadomości klienta

  • Używaj unikalnych identyfikatorów dla każdej wiadomości
  • Pomaga w śledzeniu i debugowaniu
  • Przydatne do korelacji z zapisami systemu

Limity stawek

Skontaktuj się ze swoim menedżerem konta, aby uzyskać informacje na temat:

  • Wiadomości na sekundę
  • Wiadomości dziennie
  • Równoczesne połączenia

Następne kroki

Wiadomości Viber – Poznaj typy wiadomości Viber