Help Center תאימות TurboSMS API

תאימות TurboSMS API

SMSBAT תומך באופן מלא בשכבת תאימות עם TurboSMS API. זה מאפשר לך להעביר את האינטגרציות הקיימות שלך שתוכננו עבור TurboSMS ישירות ל-SMSBAT מבלי שתצטרך לשכתב את מבני ההודעות או עומסי נקודות הקצה.

אנו תומכים בשליחת הודעות SMS ו-Viber (כולל תכונות מתקדמות כמו קרוסלות וסקרים), שליפת סטטוסים והבאת פרטי הודעה באמצעות אותם מבני גוף של בקשה בדיוק שאתה כבר מכיר.

אימות

ההבדל היחיד מממשק ה-API המקורי של TurboSMS הוא מנגנון האימות. בעוד TurboSMS משתמש בפרמטר שאילתה ‘אסימון’ מותאם אישית או בכותרת אימות ספציפית, SMSBAT דורש ** Token Bearer** סטנדרטי.

עליך לכלול את אסימון ה-SMSBAT API שלך בכותרת ‘הרשאה’ עבור כל הבקשות:

Authorization: Bearer YOUR_SMSBAT_TOKEN

כתובת האתר הבסיסית

יש להפנות את כל נקודות הקצה לכתובת ה-URL הבסיסית של SMSBAT API:

https://restapi.smsbat.com

שלח הודעה בודדת

נקודת קצה: POST /api/tsms/message/send

מאפשר שליחת הודעות SMS ו-Viber עם תמיכה במסירה היברידית (Viber עם SMS fallback). הוא מעבד בקשת שליחה אחת ומחזיר את תוצאות המשלוח עבור כל נמען.

יכולות מפתח

  • פרמטרים גמישים: ניתן לעקוף פרמטרים גלובליים על ידי פרמטרים ספציפיים של SMS/Viber.
  • תוכן: תומך בקרוסלות Viber, סקרים, קבצים מצורפים וכפתורים אינטראקטיביים.
  • טיפול בשגיאות: מחזירה HTTP 200 גם עבור שגיאות (תגובות שגיאה מובנות). response_code: 999 עם הסטטוס FATAL_ERROR עבור שגיאות מערכת.
  • שגיאות נמענים: שגיאות נמענים ספציפיות מוחזרות במערך response_result. לנמענים שנכשלו יש ‘message_id: null’ וקודי שגיאה ספציפיים.

דוגמה לבקשה (הודעה היברידית)

{
  "sender": "GlobalSender",
  "text": "Test message",
  "recipients": ["380951111111", "380952222222"],
  "start_time": "2025-09-29T10:00:00Z",
  "sequence_id": "seq_12345",
  "sms": {
    "sender": "SMSSender",
    "text": "SMS version of message",
    "is_flash": false
  },
  "viber": {
    "sender": "ViberSender",
    "text": "Viber version of message",
    "ttl": 3600,
    "image_url": "https://example.com/image.png",
    "caption": "Button text",
    "action": "https://google.com",
    "count_clicks": true,
    "is_transactional": false
  }
}

{
  "sender": "GlobalSender",
  "text": "Check out our products",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Check out our products",
    "is_transactional": false,
    "carousel": [
      {
        "title": "Product 1",
        "image_url": "https://example.com/product1.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product1",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product1"
      },
      {
        "title": "Product 2",
        "image_url": "https://example.com/product2.jpg",
        "button_caption": "Buy Now",
        "button_url": "https://example.com/buy/product2",
        "link_caption": "Learn More",
        "link_url": "https://example.com/product2"
      }
    ]
  }
}

דוגמה לבקשה (סקר Viber)

{
  "sender": "GlobalSender",
  "text": "Please rate our service",
  "recipients": ["380951111111"],
  "viber": {
    "sender": "ViberSender",
    "text": "Please rate our service",
    "is_transactional": true,
    "survey": [
      "Excellent",
      "Good",
      "Average",
      "Poor"
    ]
  }
}

שלח מספר הודעות (אצווה)

נקודת קצה: POST /api/tsms/message/sendmulti

שיטה זו מאפשרת לך לשלוח בקשות ‘שלח’ מרובות בבקשת HTTP אחת, וחוסכת תקורה של חיבור. קריאה ל’sendmulti’ עם נתונים עבור 100 בקשות תהיה מהירה יותר מביצוע 100 בקשות ‘שלח’ בודדות.

בקשה לדוגמא

{
  "batch_1": {
    "sender": "GlobalSender",
    "text": "Test message",
    "recipients": ["380982462128", "380501111111"],    
    "sms": {
        "sender": "SMSSender",
        "text": "SMS version of message"
    }
  },
  "batch_2": {
    "sender": "GlobalSender",
    "text": "Second message",
    "recipients": ["380501111111"],
    "viber": {
      "sender": "ViberSender",
      "text": "Viber message",
      "is_transactional": true
    }
  }
}

דוגמה לתגובה

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": {
        "batch_1": {
            "response_code": 800,
            "response_status": "SUCCESS_MESSAGE_ACCEPTED",
            "response_result": [
                {
                    "phone": "380982462128",
                    "response_code": 0,
                    "message_id": "f1640579-ea75-4bc1-b708-1c3858bf222d",
                    "response_status": "OK"
                }
            ]
        },
        "batch_2": { ... }
    }
}

קבל סטטוס הודעה

נקודת קצה: POST /api/tsms/message/status

אחזר את סטטוס המסירה של הודעות שנשלחו על ידי מתן ‘מזהה_הודעה’ שלהן.

בקשה לדוגמא

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "6b7f9ff5-28c8-4f38-913b-31af6021fbea"
  ]
}

קבל פרטי הודעה

נקודת קצה: POST /api/tsms/message/details

מאפשר לך לאחזר מידע מפורט על הודעות שנוצרו, כולל פרטי מטען מלא עבור ערוצי SMS ו-Viber, תמחור וחותמות זמן מדויקות.

בקשה לדוגמא

{
  "messages": [
      "573dcb46-7851-4e16-bb1f-721c13ef5f38", 
      "f1640579-ea75-4bc1-b708-1c3858bf222d"
  ]
}

דוגמה לתגובה

{
    "response_code": 0,
    "response_status": "OK",
    "response_result": [
        {
            "message_id": "573dcb46-7851-4e16-bb1f-721c13ef5f38",
            "sms": null,
            "viber": {
                "added": "2025-09-29T14:17:02.577Z",
                "start": "2025-09-29T10:00:00Z",
                "sent": "2025-09-29T14:17:02.577Z",
                "updated": "2025-09-29T14:17:02.577Z",
                "sender": "ViberSender",
                "text": "Viber version of message",
                "recipient": "380982462128",
                "message_type": "promotional",
                "status": "Queued",
                "price": 0,
                "ttl": 3600,
                "caption": "Button text",
                "action": "https://google.com"
            },
            "response_code": 0,
            "response_status": "OK"
        }
    ]
}