შიგთავსზე გადასვლა

გაგზავნეთ შეტყობინება

გაგზავნეთ შეტყობინებები SMSBAT API-ის საშუალებით /bat/messagelist საბოლოო წერტილის გამოყენებით.

დასასრული

POST /bat/messagelist

მოთხოვნის სტრუქტურა

მოთხოვნის სხეული არის შეტყობინების ობიექტების JSON მასივი:

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

პარამეტრები

საჭირო პარამეტრები

პარამეტრი ტიპი აღწერა
დან სიმებიანი ალფანუმერული გამგზავნის ID
მდე სიმებიანი მიმღების ტელეფონის ნომერი E.164 ფორმატში (მაგ., +380XXXXXXXXX)
ტიპი სიმებიანი შეტყობინების ტიპი: sms, viber_promo, viber_trans, viber_carousel, viber_survey, viber_otp, rcs, flashcall
ტექსტი სიმებიანი შეტყობინების შინაარსი (აუცილებელია უმეტესი ტიპისთვის, ზოგიერთისთვის სურვილისამებრ)

არჩევითი პარამეტრები

პარამეტრი ტიპი აღწერა
customerMessageId სიმებიანი თქვენი შიდა იდენტიფიკატორი თვალთვალისათვის
ttl მთელი რიცხვი სიცოცხლის დრო წამებში
messageData ობიექტი ტიპის სპეციფიკური კონფიგურაცია (იცვლება შეტყობინების ტიპის მიხედვით)

ავტორიზაცია

აირჩიეთ ავთენტიფიკაციის სამი მეთოდიდან ერთი:

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

პასუხი

წარმატებული პასუხი

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

რეაგირების ველები

ველი ტიპი აღწერა
messagelistId მთელი რიცხვი უნიკალური იდენტიფიკატორი შეტყობინებების სიისთვის
messageId სიმებიანი უნიკალური იდენტიფიკატორი თითოეული შეტყობინებისთვის
სტატუსს სიმებიანი შეტყობინების სტატუსი: მიღებული, უარყოფილი, შეუძლებელი
ნაწილები მთელი რიცხვი შეტყობინების ნაწილების რაოდენობა (SMS-ისთვის)
customerMessageId სიმებიანი თქვენი შიდა იდენტიფიკატორი (თუ მოწოდებულია)
მდე სიმებიანი მიმღების ტელეფონის ნომერი

შეტყობინების ტიპები

SMS

მარტივი ტექსტური შეტყობინებები:

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

Viber-ის პრომო

სარეკლამო შეტყობინებები მდიდარი მედიით:

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

ტრანზაქციის შეტყობინებები:

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

Viber OTP

პაროლის ერთჯერადი შეტყობინებები:

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

შეცდომის დამუშავება

HTTP სტატუსის კოდები

კოდი აღწერა
200 მოთხოვნა წარმატებულია
400 არასწორი მოთხოვნა - არასწორი პარამეტრები
401 არაავტორიზებული - ავტორიზაცია ვერ მოხერხდა
429 ძალიან ბევრი მოთხოვნა - განაკვეთის ლიმიტი გადააჭარბა
500 შიდა სერვერის შეცდომა

შეცდომის პასუხი

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

საუკეთესო პრაქტიკა

ტელეფონის ნომრის ფორმატი

ტელეფონის ნომრებისთვის ყოველთვის გამოიყენეთ E.164 ფორმატი:

  • ✅ სწორია: +380XXXXXXXXX
  • ❌ არასწორია: 380XXXXXXXXX, 0XXXXXXXXX

შეტყობინების ტექსტი

  • შეინახეთ SMS 160 სიმბოლოზე ნაკლები, რათა თავიდან აიცილოთ მრავალი ნაწილი
  • გამოიყენეთ UTF-8 კოდირება საერთაშორისო სიმბოლოებისთვის
  • შეამოწმეთ სპეციალური სიმბოლოები ნაყარი გაგზავნამდე

TTL (სიცოცხლის დრო)

  • დააყენეთ შესაბამისი TTL დროზე მგრძნობიარე შეტყობინებებისთვის
  • OTP შეტყობინებები: 300-600 წამი (5-10 წუთი)
  • სარეკლამო შეტყობინებები: 3600-86400 წამი (1-24 საათი)

კლიენტის შეტყობინების ID

  • გამოიყენეთ უნიკალური იდენტიფიკატორები თითოეული შეტყობინებისთვის
  • ეხმარება თვალყურის დევნებასა და გამართვას
  • სასარგებლოა თქვენი სისტემის ჩანაწერებთან კორელაციისთვის

შეფასების ლიმიტები

დაუკავშირდით თქვენი ანგარიშის მენეჯერს ინფორმაციისთვის:

  • შეტყობინებები წამში
  • შეტყობინებები დღეში
  • თანმხლები კავშირები

შემდეგი ნაბიჯები