שליחת סמס ב-API

מתוך MindCRM
קפיצה לניווט קפיצה לחיפוש

ממשק API לשליחת SMS

שליחת הודעת SMS למספר טלפון של לקוח באמצעות בקשת HTTP פשוטה. הממשק תומך בשני מצבי פעולה: שליחת הודעה ישירה שאתה מנסח בעצמך, או שימוש בתבנית SMS מוגדרת מראש השמורה במערכת.


נקודת קצה

GET /api/send_sms.php

אימות

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


מצב 1 — הודעה ישירה

שליחת הודעה שאתה מנסח ישירות בבקשה.

פרמטרים חובה

פרמטר סוג תיאור
source_number מחרוזת שם השולח או המספר שמוצג אצל הנמען. תווים אלפאנומריים בלבד, עד 12 תווים.
message מחרוזת תוכן ההודעה לשליחה. עד 500 תווים.
phone מחרוזת מספר הנייד הישראלי של הנמען בפורמט 05X-XXXXXXX או 05XXXXXXXX.

פרמטרים אופציונליים

פרמטר סוג תיאור
user_id מספר שלם מזהה העובד שלך. משמש לאיתור הלקוח ולרישום.
from_phone מחרוזת חלופה ל־phone. יוחל אם phone לא סופק.
date מחרוזת תאריך שליחה מתוזמנת בפורמט YYYY-MM-DD. ברירת מחדל: היום.
time מחרוזת שעת שליחה מתוזמנת בפורמט HH:MM:SS. ברירת מחדל: עכשיו.
repository_assign_id מספר שלם אם מזהה השיוך של הלקוח כבר ידוע, יש להעבירו כאן כדי לדלג על שלב האיתור.

דוגמת בקשה

GET /api/send_sms.php
  ?source_number=MindCRM
  &message=שלום, התור שלך אושר.
  &phone=0501234567
  &user_id=42

דוגמת שליחה מתוזמנת

GET /api/send_sms.php
  ?source_number=MindCRM
  &message=תזכורת: הפגישה שלך מחר בשעה 10:00.
  &phone=0501234567
  &user_id=42
  &date=2025-07-01
  &time=09:00:00

מצב 2 — תבנית SMS

שימוש בתבנית מוכנה מראש השמורה במערכת. תוכן ההודעה נשלף אוטומטית, וכל משתני ה־placeholder (כגון שם הלקוח או מספר הטלפון) מוחלפים בנתונים אמיתיים לפני השליחה.

כל פרמטר שמועבר במפורש דורס את ערך התבנית המתאים.

פרמטרים חובה

פרמטר סוג תיאור
sms_template_id מספר שלם מזהה תבנית ה־SMS לשימוש.
phone מחרוזת מספר הנייד הישראלי של הנמען בפורמט 05X-XXXXXXX או 05XXXXXXXX.

פרמטרים אופציונליים

פרמטר סוג תיאור
user_id מספר שלם מזהה העובד שלך. משמש לאיתור נתוני הלקוח ולהחלפת המשתנים.
from_phone מחרוזת חלופה ל־phone. יוחל אם phone לא סופק.
source_number מחרוזת דורס את שם השולח המוגדר בתבנית.
message מחרוזת דורס את תוכן ההודעה המוגדר בתבנית לחלוטין.
date מחרוזת תאריך שליחה מתוזמנת בפורמט YYYY-MM-DD. ברירת מחדל: עכשיו.
time מחרוזת שעת שליחה מתוזמנת בפורמט HH:MM:SS. ברירת מחדל: עכשיו.
repository_assign_id מספר שלם אם מזהה השיוך של הלקוח כבר ידוע, יש להעבירו כאן כדי לדלג על שלב האיתור.

דוגמת בקשה

GET /api/send_sms.php
  ?sms_template_id=7
  &phone=0501234567
  &user_id=42

דוגמה לדריסת שם השולח מהתבנית

GET /api/send_sms.php
  ?sms_template_id=7
  &phone=0501234567
  &user_id=42
  &source_number=MyBrand

פורמט מספר טלפון

מספר הטלפון של הנמען חייב להיות מספר נייד ישראלי התואם לאחד מהפורמטים הבאים:

  • 0501234567 — 10 ספרות, ללא מפריד
  • 050-1234567 — עם מקף כמפריד

קידומות תקינות: 050, 051, 052, 053, 054, 055, 058, 059


פורמט תגובה

כל התגובות מוחזרות בפורמט JSON.

{
  "stat_code": 0,
  "description": "SMS sent successfully",
  "data": "SMS sent successfully"
}
שדה סוג תיאור
stat_code מספר שלם 0 = הצלחה. כל ערך אחר = שגיאה (ראה טבלה להלן).
description מחרוזת הודעת תוצאה קריאה לאדם.
data מחרוזת זהה ל־description.

קודי שגיאה

קוד משמעות כיצד לתקן
0 הצלחה
1 פרמטר חובה חסר יש לוודא שכל הפרמטרים הנדרשים נכללים בבקשה.
2 פורמט מספר טלפון שגוי יש לוודא שמספר הטלפון מתחיל ב־05 ומכיל בדיוק 10 ספרות.
3 הודעה ארוכה מדי יש לשמור על הודעה עד 500 תווים.
4 source_number לא תקין יש להשתמש באותיות ומספרים בלבד, עד 12 תווים. ללא תווים מיוחדים.
5 תבנית SMS לא נמצאה יש לוודא שה־sms_template_id קיים ופעיל במערכת.

כללי עדיפות (מצב 2)

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

ערך מקור
message פרמטר מפורש ← טקסט התבנית (עם החלפת משתנים)
source_number פרמטר מפורש ← שם השולח מהתבנית

הערות

  • הודעות נרשמות אוטומטית בהיסטוריית ה־SMS של הלקוח.
  • הודעות מתוזמנות (באמצעות date/time) שזמנן עבר — נשלחות מיידית.
  • משתני התבנית מוחלפים בנתוני הלקוח החיים בזמן הבקשה.