Skip to content

Ibgħat Messaġġ

Ibgħat messaġġi permezz ta' SMSBAT API billi tuża l-endpoint /bat/messagelist.

Endpoint

POST /bat/messagelist

Talba Struttura

Il-korp tat-talba huwa firxa JSON ta' oġġetti tal-messaġġ:

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

Parametri

Parametri Meħtieġa

Parametru Tip Deskrizzjoni
"minn" spag ID alfanumeriku tal-mittent
"għal" spag Numru tat-telefon tar-riċevitur fil-format E.164 (eż., +380XXXXXXXXX)
"tip" spag Tip ta' messaġġ: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
"test" spag Kontenut tal-messaġġ (meħtieġa għal ħafna tipi, mhux obbligatorju għal xi wħud)

Parametri Fakultattivi

Parametru Tip Deskrizzjoni
customerMessageId spag L-identifikatur intern tiegħek għat-traċċar
ttl numru sħiħ Ħin għall-ħajja f'sekondi
MessageData oġġett Konfigurazzjoni speċifika għat-tip (tvarja skond it-tip ta' messaġġ)

Awtentikazzjoni

Agħżel wieħed mit-tliet metodi ta' awtentikazzjoni:

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

Rispons

Rispons ta’ Suċċess

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

Oqsma ta’ Rispons

Qasam Tip Deskrizzjoni
MessagelistId numru sħiħ Identifikatur uniku għal-lista tal-messaġġi
MessageId spag Identifikatur uniku għal kull messaġġ
"status" spag Status tal-messaġġ: aċċettat, miċħud, `falla'
"partijiet" numru sħiħ Numru ta' partijiet tal-messaġġ (għall-SMS)
customerMessageId spag L-identifikatur intern tiegħek (jekk ipprovdut)
"għal" spag Numru tat-telefon tar-riċevitur

Tipi ta' Messaġġi

SMS

Messaġġi sempliċi:

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

Viber Promo

Messaġġi promozzjonali b'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 Transazzjonali

Notifiki ta' tranżazzjoni:

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

Viber OTP

Notifiki ta' password ta' darba:

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

Immaniġġjar ta' Żbalji

Kodiċijiet tal-Istat HTTP

Kodiċi Deskrizzjoni
200 Talba b'suċċess
400 Talba ħażina - parametri invalidi
401 Mhux awtorizzat - awtentikazzjoni falliet
429 Wisq talbiet - limitu tar-rata inqabeż
500 Żball intern tas-server

Rispons għal Żball

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

L-Aħjar Prattiċi

Format tan-Numru tat-Telefon

Dejjem uża l-format E.164 għan-numri tat-telefon:

  • ✅ Ikkoreġi: +380XXXXXXXXX
  • ❌ Żbaljata: 380XXXXXXXXX, 0XXXXXXXXX

Test tal-Messaġġ

  • Żomm SMS taħt 160 karattru biex tevita partijiet multipli
  • Uża kodifikazzjoni UTF-8 għal karattri internazzjonali
  • Ittestja karattri speċjali qabel ma jintbagħtu bl-ingrossa

TTL (Time-to-Live)

  • Issettja TTL xierqa għal messaġġi sensittivi għall-ħin
  • Messaġġi OTP: 300-600 sekonda (5-10 minuti)
  • Messaġġi promozzjonali: 3600-86400 sekondi (1-24 siegħa)

ID tal-Messaġġ tal-Klijent

  • Uża identifikaturi uniċi għal kull messaġġ
  • Jgħin fl-intraċċar u l-debugging
  • Utli biex tikkorrelata mar-rekords tas-sistema tiegħek

Limiti tar-Rata

Ikkuntattja lill-maniġer tal-kont tiegħek għal informazzjoni dwar:

  • Messaġġi kull sekonda
  • Messaġġi kuljum
  • Konnessjonijiet konkorrenti

Il-passi li jmiss