Gå til indholdet

Send besked

Send beskeder via SMSBAT API ved hjælp af /bat/messagelist-slutpunktet.

Slutpunkt

POST /bat/messagelist

Anmodningsstruktur

Anmodningsteksten er en JSON-array af meddelelsesobjekter:

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

Parametre

Nødvendige parametre

Parameter Skriv Beskrivelse
fra streng Alfanumerisk afsender-id
til streng Modtagerens telefonnummer i E.164-format (f.eks. +380XXXXXXXXX)
type streng Meddelelsestype: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
tekst streng Beskedindhold (påkrævet for de fleste typer, valgfrit for nogle)

Valgfri parametre

Parameter Skriv Beskrivelse
customerMessageId streng Din interne identifikator til sporing
ttl heltal Tid til at leve på få sekunder
messageData objekt Typespecifik konfiguration (varierer efter meddelelsestype)

Godkendelse

Vælg en af tre godkendelsesmetoder:

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

Svar

Successvar

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

Svarfelter

Felt Skriv Beskrivelse
messagelistId heltal Unik identifikator for meddelelseslisten
messageId streng Unik identifikator for hver besked
status streng Meddelelsesstatus: accepteret, afvist, mislykkedes
dele heltal Antal meddelelsesdele (for SMS)
customerMessageId streng Din interne identifikator (hvis angivet)
til streng Modtagerens telefonnummer

Meddelelsestyper

SMS

Simple tekstbeskeder:

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

Viber-kampagne

Salgsfremmende meddelelser med 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"
    }
  }
}

Viber Transactional

Transaktionsmeddelelser:

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

Viber OTP

Engangsadgangskodemeddelelser:

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

Fejlhåndtering

HTTP-statuskoder

Kode Beskrivelse
200 Forespørgsel lykkedes
400 Dårlig anmodning - ugyldige parametre
401 Uautoriseret - godkendelse mislykkedes
429 For mange anmodninger - takstgrænse overskredet
500 Intern serverfejl

Fejlreaktion

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

Bedste praksis

Telefonnummerformat

Brug altid E.164-format til telefonnumre:

  • ✅ Korrekt: +380XXXXXXXXX
  • ❌ Forkert: 380XXXXXXXXX, 0XXXXXXXXX

Meddelelsestekst

  • Hold SMS under 160 tegn for at undgå flere dele
  • Brug UTF-8-kodning til internationale tegn
  • Test specialtegn før masseafsendelse

TTL (Time-to-Live)

  • Indstil passende TTL for tidsfølsomme beskeder
  • OTP-beskeder: 300-600 sekunder (5-10 minutter)
  • Salgsfremmende beskeder: 3600-86400 sekunder (1-24 timer)

Kundemeddelelses-id

  • Brug unikke identifikatorer for hver besked
  • Hjælper med sporing og fejlretning
  • Nyttig til at korrelere med dit systems registreringer

Satsgrænser

Kontakt din account manager for information om:

  • Beskeder per sekund
  • Beskeder om dagen
  • Samtidige forbindelser

Næste trin