לדלג לתוכן

ממשק API של Cascade

ה-API של Cascade מאפשר שליחת הודעות על פני מספר פלטפורמות עם בקשה אחת, ניתוב אוטומטי ל- Telegram Bot, Viber Bot, Viber Business Messages, RCS ו-SMS.

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

https://restapi.smsbat.com

אימות

Cascade API משתמש באימות מבוסס כותרות עם שלוש כותרות אימות אפשריות:

שיטה 1: מפתח API של SMSBAT

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Authorization-Key: your-smsbat-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

שיטה 2: Viber Bot Token

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Viber-Auth-Token: your-viber-bot-token" \
  -H "Content-Type: application/json" \
  -d @request.json

שיטה 3: מפתח בוט טלגרם

curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
  -H "X-Tg-Bot-Key: your-telegram-bot-key" \
  -H "Content-Type: application/json" \
  -d @request.json

נקודות קצה זמינות

שיטה נקודת קצה תיאור
פוסט /api/CascadeMessage/send_message/async שליחת הודעות מדורגת כללית
פוסט /api/CascadeMessage/send_message/tg-viber/async מפל בראש סדר העדיפויות של טלגרם

איך זה עובד

עם בקשת API אחת, Cascade מעביר באופן אוטומטי את המסר שלך במספר ערוצים:

Telegram Bot → Viber Bot → Viber Business → RCS → SMS

ההודעה מועברת דרך הערוץ הזמין הראשון, עם חזרה אוטומטית לערוץ הבא אם המסירה נכשלת.

תכונות עיקריות

משלוח רב ערוצים

שלח הודעה אחת, הגיע למשתמשים בכל פלטפורמה:

  • בוט טלגרם
  • Viber Bot
  • Viber Business Messages
  • RCS (שירותי תקשורת עשירים)
  • SMS

החלפה משתנה

השתמש בתוכן דינמי עם מצייני מיקום משתנים:

  • %name=id% - משתני טקסט
  • %url=id% - משתני כתובת אתר
  • %short_url=id% - משתני URL מקוצרים

תזמון הודעות

תזמון הודעות למשלוח עתידי:

{
  "scheduledTime": "2025-01-24T12:00:00Z"
}

זמן חיים (TTL)

הגדר זמן תפוגה עבור הודעות:

{
  "ttl": 3600
}

סוגי הודעות

Cascade API תומך:

  • עסקאות - אישורי הזמנה, הודעות
  • פרומו - מסרים שיווקיים ופרסומיים
  • סקרי Viber - סקרים אינטראקטיביים
  • שיחות פלאש - אימות טלפוני

פורמט תגובה

תגובות מוצלחות חוזרות:

[
  {
    "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trackinId": "tracking-string-id"
  }
]
  • messageId - GUID לזיהוי הודעה
  • trackinId - מחרוזת למעקב אחר מצב מסירה

התחלה מהירה

  1. שלח הודעות - התחל לשלוח הודעות מדורגות
  2. משתני הודעה - השתמש בתוכן דינמי
  3. סוגי הודעות - חקור סוגי הודעות

דוגמה לבקש

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "text": "Hello %name=1%, your order #%url=2% is ready!",
      "variables": [
        {
          "id": 1,
          "value": "John"
        },
        {
          "id": 2,
          "value": "12345"
        }
      ]
    }
  ]
}

טיפול בשגיאות

קודי מצב HTTP:

  • 200 בסדר - הבקשה הצליחה
  • 400 בקשה שגויה - פורמט בקשה לא חוקי
  • 401 לא מורשה - האימות נכשל
  • 429 בקשות רבות מדי - חרגת ממגבלת התעריף
  • 500 שגיאת שרת פנימית - שגיאת שרת

הטבות

אינטגרציה יחידה

שילוב API אחד לכל ערוצי העברת ההודעות - אין צורך להשתלב עם כל פלטפורמה בנפרד.

ניתוב אוטומטי

ניתוב חכם מבטיח העברת הודעות דרך הערוץ הזמין הטוב ביותר עבור כל נמען.

מיטוב עלויות

Cascade מנסה תחילה ערוצים זולים יותר, ונופל אוטומטית לאפשרויות יקרות יותר רק בעת הצורך.

שיעורי משלוח גבוהים יותר

ערוצי הגנה מרובים מבטיחים שההודעה שלך מגיעה לנמען גם אם הערוץ הראשי נכשל.

השלבים הבאים