Ana içeriğe geç

Mesaj Gönder

/bat/messagelist uç noktasını kullanarak SMSBAT API aracılığıyla mesaj gönderin.

Uç nokta

POST /bat/messagelist

İstek Yapısı

İstek gövdesi, mesaj nesnelerinden oluşan bir JSON dizisidir:

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

Parametreler

Gerekli Parametreler

Parametre Tür Açıklama
'dan' dize Alfasayısal gönderen kimliği
'e' dize E.164 biçiminde alıcının telefon numarası (ör. +380XXXXXXXXX)
'tür' dize Mesaj türü: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
'metin' dize Mesaj içeriği (çoğu tür için gerekli, bazıları için isteğe bağlı)

İsteğe Bağlı Parametreler

Parametre Tür Açıklama
'müşteriMesajId' dize İzleme için dahili tanımlayıcınız
'ttl' tamsayı Saniye cinsinden yaşam süresi
'mesajVerileri' nesne Tipe özel konfigürasyon (mesaj tipine göre değişir)

Kimlik Doğrulama

Üç kimlik doğrulama yönteminden birini seçin:

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

Yanıt

Başarılı Yanıt

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

Yanıt Alanları

Alan Tür Açıklama
'mesaj listesi kimliği' tamsayı Mesaj listesi için benzersiz tanımlayıcı
'mesaj Kimliği' dize Her mesaj için benzersiz tanımlayıcı
'durum' dize Mesaj durumu: 'kabul edildi', 'reddedildi', 'başarısız'
'parçalar' tamsayı Mesaj parçası sayısı (SMS için)
'müşteriMesajId' dize Dahili tanımlayıcınız (varsa)
'e' dize Alıcının telefon numarası

Mesaj Türleri

SMS

Basit metin mesajları:

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

Viber Promosyonu

Zengin medya içeren tanıtım mesajları:

{
  "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 İşlemsel

İşlem bildirimleri:

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

Viber OTP

Tek kullanımlık şifre bildirimleri:

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

Hata İşleme

HTTP Durum Kodları

Kod Açıklama
200 İstek başarılı
400 Hatalı istek - geçersiz parametreler
401 Yetkisiz - kimlik doğrulama başarısız oldu
429 Çok fazla istek - oran sınırı aşıldı
500 Dahili sunucu hatası

Hata Yanıtı

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

En İyi Uygulamalar

Telefon Numarası Formatı

Telefon numaraları için her zaman E.164 biçimini kullanın:

  • ✅ Doğru: '+380XXXXXXXXXX'
  • ❌ Yanlış: '380XXXXXXXXXX', '0XXXXXXXXX'

Mesaj Metni

  • Birden fazla bölümden kaçınmak için SMS'i 160 karakterin altında tutun
  • Uluslararası karakterler için UTF-8 kodlamasını kullanın
  • Toplu göndermeden önce özel karakterleri test edin

TTL (Yaşam Süresi)

  • Zamana duyarlı mesajlar için uygun TTL'yi ayarlayın
  • OTP mesajları: 300-600 saniye (5-10 dakika)
  • Promosyon mesajları: 3600-86400 saniye (1-24 saat)

Müşteri Mesaj Kimliği

  • Her mesaj için benzersiz tanımlayıcılar kullanın
  • İzleme ve hata ayıklamaya yardımcı olur
  • Sisteminizin kayıtlarıyla ilişkilendirmek için kullanışlıdır

Hız Limitleri

Aşağıdakilerle ilgili bilgi için hesap yöneticinizle iletişime geçin:

  • Saniyedeki mesajlar
  • Günlük mesajlar
  • Eşzamanlı bağlantılar

Sonraki Adımlar