Help Center Skicka meddelande

Skicka meddelande

Skicka meddelanden via SMSBAT API med “/bat/messagelist”-slutpunkten.

Slutpunkt

POST /bat/messagelist

Begärans struktur

Begäran är en JSON-array med meddelandeobjekt:

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

Parametrar

Nödvändiga parametrar

ParameterSkrivBeskrivning
frånsträngAlfanumeriskt avsändar-ID
tillsträngMottagarens telefonnummer i E.164-format (t.ex. +380XXXXXXXXX)
typsträngMeddelandetyp: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
textsträngMeddelandeinnehåll (krävs för de flesta typer, valfritt för vissa)

Valfria parametrar

ParameterSkrivBeskrivning
customerMessageIdsträngDin interna identifierare för spårning
ttlheltalTid att leva på några sekunder
meddelandeDataobjektTypspecifik konfiguration (varierar beroende på meddelandetyp)

Autentisering

Välj en av tre autentiseringsmetoder:

=== “API Key Header”

```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 Basic Auth”

```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-nyckel som lösenord”

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

Svar

Framgångssvar

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

Svarsfält

FältSkrivBeskrivning
meddelandelistIdheltalUnik identifierare för meddelandelistan
meddelande-IDsträngUnik identifierare för varje meddelande
statussträngMeddelandestatus: accepterat, avvisad, misslyckades
delarheltalAntal meddelandedelar (för SMS)
customerMessageIdsträngDin interna identifierare (om tillhandahållen)
tillsträngMottagarens telefonnummer

Meddelandetyper

SMS

Enkla textmeddelanden:

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

Viber-kampanj

Reklammeddelanden med multimedia:

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

Transaktionsmeddelanden:

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

Viber OTP

Engångslösenordsaviseringar:

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

Felhantering

HTTP-statuskoder

KodBeskrivning
200Begäran lyckades
400Felaktig begäran - ogiltiga parametrar
401Obehörig - autentisering misslyckades
429För många förfrågningar - hastighetsgränsen har överskridits
500Internt serverfel

Felsvar

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

Bästa metoder

Telefonnummerformat

Använd alltid formatet E.164 för telefonnummer:

  • ✅ Rätt: +380XXXXXXXXX
  • ❌ Felaktigt: “380XXXXXXXXX”, “0XXXXXXXXX”.

Meddelandetext

  • Håll SMS under 160 tecken för att undvika flera delar
  • Använd UTF-8-kodning för internationella tecken
  • Testa specialtecken innan masssändning

TTL (Time-to-Live)

  • Ställ in lämplig TTL för tidskänsliga meddelanden
  • OTP-meddelanden: 300-600 sekunder (5-10 minuter)
  • Kampanjmeddelanden: 3600-86400 sekunder (1-24 timmar)

Kundmeddelande-ID

  • Använd unika identifierare för varje meddelande
  • Hjälper till med spårning och felsökning
  • Användbar för att korrelera med ditt systems register

Prisgränser

Kontakta din kontoansvariga för information om:

  • Meddelanden per sekund
  • Meddelanden per dag
  • Samtidiga anslutningar

Nästa steg