MindCRM - שינויים אחרונים [he]

שליחת סמס ב-API

מנהל — Tue, 23 Jun 2026 12:54:35 GMT

יצירת דף שליחת סמס ב-API בעברית

דף חדש

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

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

----

== נקודת קצה ==

<syntaxhighlight lang="text">
GET /api/send_sms.php
</syntaxhighlight>

----

== אימות ==

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

----

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

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

=== פרמטרים חובה ===

{| class="wikitable"
! פרמטר !! סוג !! תיאור
|-
| <code>source_number</code> || מחרוזת || שם השולח או המספר שמוצג אצל הנמען. תווים אלפאנומריים בלבד, עד 12 תווים.
|-
| <code>message</code> || מחרוזת || תוכן ההודעה לשליחה. עד 500 תווים.
|-
| <code>phone</code> || מחרוזת || מספר הנייד הישראלי של הנמען בפורמט <code>05X-XXXXXXX</code> או <code>05XXXXXXXX</code>.
|}

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

{| class="wikitable"
! פרמטר !! סוג !! תיאור
|-
| <code>user_id</code> || מספר שלם || מזהה העובד שלך. משמש לאיתור הלקוח ולרישום.
|-
| <code>from_phone</code> || מחרוזת || חלופה ל־<code>phone</code>. יוחל אם <code>phone</code> לא סופק.
|-
| <code>date</code> || מחרוזת || תאריך שליחה מתוזמנת בפורמט <code>YYYY-MM-DD</code>. ברירת מחדל: היום.
|-
| <code>time</code> || מחרוזת || שעת שליחה מתוזמנת בפורמט <code>HH:MM:SS</code>. ברירת מחדל: עכשיו.
|-
| <code>repository_assign_id</code> || מספר שלם || אם מזהה השיוך של הלקוח כבר ידוע, יש להעבירו כאן כדי לדלג על שלב האיתור.
|}

=== דוגמת בקשה ===

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

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

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

----

== מצב 2 — תבנית SMS ==

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

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

=== פרמטרים חובה ===

{| class="wikitable"
! פרמטר !! סוג !! תיאור
|-
| <code>sms_template_id</code> || מספר שלם || מזהה תבנית ה־SMS לשימוש.
|-
| <code>phone</code> || מחרוזת || מספר הנייד הישראלי של הנמען בפורמט <code>05X-XXXXXXX</code> או <code>05XXXXXXXX</code>.
|}

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

{| class="wikitable"
! פרמטר !! סוג !! תיאור
|-
| <code>user_id</code> || מספר שלם || מזהה העובד שלך. משמש לאיתור נתוני הלקוח ולהחלפת המשתנים.
|-
| <code>from_phone</code> || מחרוזת || חלופה ל־<code>phone</code>. יוחל אם <code>phone</code> לא סופק.
|-
| <code>source_number</code> || מחרוזת || דורס את שם השולח המוגדר בתבנית.
|-
| <code>message</code> || מחרוזת || דורס את תוכן ההודעה המוגדר בתבנית לחלוטין.
|-
| <code>date</code> || מחרוזת || תאריך שליחה מתוזמנת בפורמט <code>YYYY-MM-DD</code>. ברירת מחדל: עכשיו.
|-
| <code>time</code> || מחרוזת || שעת שליחה מתוזמנת בפורמט <code>HH:MM:SS</code>. ברירת מחדל: עכשיו.
|-
| <code>repository_assign_id</code> || מספר שלם || אם מזהה השיוך של הלקוח כבר ידוע, יש להעבירו כאן כדי לדלג על שלב האיתור.
|}

=== דוגמת בקשה ===

<syntaxhighlight lang="text">
GET /api/send_sms.php
?sms_template_id=7
&phone=0501234567
&user_id=42
</syntaxhighlight>

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

<syntaxhighlight lang="text">
GET /api/send_sms.php
?sms_template_id=7
&phone=0501234567
&user_id=42
&source_number=MyBrand
</syntaxhighlight>

----

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

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

* <code>0501234567</code> — 10 ספרות, ללא מפריד
* <code>050-1234567</code> — עם מקף כמפריד

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

----

== פורמט תגובה ==

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

<syntaxhighlight lang="json">
{
"stat_code": 0,
"description": "SMS sent successfully",
"data": "SMS sent successfully"
}
</syntaxhighlight>

{| class="wikitable"
! שדה !! סוג !! תיאור
|-
| <code>stat_code</code> || מספר שלם || <code>0</code> = הצלחה. כל ערך אחר = שגיאה (ראה טבלה להלן).
|-
| <code>description</code> || מחרוזת || הודעת תוצאה קריאה לאדם.
|-
| <code>data</code> || מחרוזת || זהה ל־<code>description</code>.
|}

----

== קודי שגיאה ==

{| class="wikitable"
! קוד !! משמעות !! כיצד לתקן
|-
| <code>0</code> || הצלחה || —
|-
| <code>1</code> || פרמטר חובה חסר || יש לוודא שכל הפרמטרים הנדרשים נכללים בבקשה.
|-
| <code>2</code> || פורמט מספר טלפון שגוי || יש לוודא שמספר הטלפון מתחיל ב־<code>05</code> ומכיל בדיוק 10 ספרות.
|-
| <code>3</code> || הודעה ארוכה מדי || יש לשמור על הודעה עד 500 תווים.
|-
| <code>4</code> || <code>source_number</code> לא תקין || יש להשתמש באותיות ומספרים בלבד, עד 12 תווים. ללא תווים מיוחדים.
|-
| <code>5</code> || תבנית SMS לא נמצאה || יש לוודא שה־<code>sms_template_id</code> קיים ופעיל במערכת.
|}

----

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

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

{| class="wikitable"
! ערך !! מקור
|-
| <code>message</code> || פרמטר מפורש ← טקסט התבנית (עם החלפת משתנים)
|-
| <code>source_number</code> || פרמטר מפורש ← שם השולח מהתבנית
|}

----

== הערות ==

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

Send SMS API

מנהל — Tue, 23 Jun 2026 12:49:14 GMT

יצירת דף שליחת סמס ב-API באנגלית

דף חדש

= Send SMS API =

Send an SMS message to a customer phone number via a simple HTTP request.
The API supports two modes: sending a '''raw message''' you compose yourself, or using a pre-configured '''SMS template''' stored in the system.

----

== Endpoint ==

<syntaxhighlight lang="text">
GET /api/send_sms.php
</syntaxhighlight>

----

== Authentication ==

Pass your worker ID via the <code>user_id</code> parameter. The API uses it to look up the customer record and to log the outgoing message against your account.

----

== Mode 1 — Raw Message ==

Send a message you write directly in the request.

=== Required Parameters ===

{| class="wikitable"
! Parameter !! Type !! Description
|-
| <code>source_number</code> || string || The sender name or number shown to the recipient. Alphanumeric only, max 12 characters.
|-
| <code>message</code> || string || The message text to send. Max 500 characters.
|-
| <code>phone</code> || string || Recipient's Israeli mobile number in <code>05X-XXXXXXX</code> or <code>05XXXXXXXX</code> format.
|}

=== Optional Parameters ===

{| class="wikitable"
! Parameter !! Type !! Description
|-
| <code>user_id</code> || integer || Your worker ID. Used for customer lookup and logging.
|-
| <code>from_phone</code> || string || Alternative to <code>phone</code>. Used if <code>phone</code> is not provided.
|-
| <code>date</code> || string || Scheduled send date in <code>YYYY-MM-DD</code> format. Defaults to today.
|-
| <code>time</code> || string || Scheduled send time in <code>HH:MM:SS</code> format. Defaults to now.
|-
| <code>repository_assign_id</code> || integer || If you already know the customer's assignment ID, pass it here to skip the lookup step.
|}

=== Example Request ===

<syntaxhighlight lang="text">
GET /api/send_sms.php
?source_number=MindCRM
&message=Hello, your appointment is confirmed.
&phone=0501234567
&user_id=42
</syntaxhighlight>

=== Scheduled Send Example ===

<syntaxhighlight lang="text">
GET /api/send_sms.php
?source_number=MindCRM
&message=Reminder: your meeting is tomorrow at 10:00.
&phone=0501234567
&user_id=42
&date=2025-07-01
&time=09:00:00
</syntaxhighlight>

----

== Mode 2 — SMS Template ==

Use a pre-built template stored in the system. The template text is fetched automatically, and any '''placeholder variables''' (such as the customer's name or phone number) are replaced with real data before sending.

Any parameter you pass explicitly '''overrides''' the value from the template.

=== Required Parameters ===

{| class="wikitable"
! Parameter !! Type !! Description
|-
| <code>sms_template_id</code> || integer || The ID of the SMS template to use.
|-
| <code>phone</code> || string || Recipient's Israeli mobile number in <code>05X-XXXXXXX</code> or <code>05XXXXXXXX</code> format.
|}

=== Optional Parameters ===

{| class="wikitable"
! Parameter !! Type !! Description
|-
| <code>user_id</code> || integer || Your worker ID. Used for customer data lookup and variable substitution.
|-
| <code>from_phone</code> || string || Alternative to <code>phone</code>. Used if <code>phone</code> is not provided.
|-
| <code>source_number</code> || string || Overrides the template's sender name/number.
|-
| <code>message</code> || string || Overrides the template's message text entirely.
|-
| <code>date</code> || string || Scheduled send date in <code>YYYY-MM-DD</code> format. Defaults to now.
|-
| <code>time</code> || string || Scheduled send time in <code>HH:MM:SS</code> format. Defaults to now.
|-
| <code>repository_assign_id</code> || integer || If you already know the customer's assignment ID, pass it here to skip the lookup step.
|}

=== Example Request ===

<syntaxhighlight lang="text">
GET /api/send_sms.php
?sms_template_id=7
&phone=0501234567
&user_id=42
</syntaxhighlight>

=== Override Template Sender Example ===

<syntaxhighlight lang="text">
GET /api/send_sms.php
?sms_template_id=7
&phone=0501234567
&user_id=42
&source_number=MyBrand
</syntaxhighlight>

----

== Phone Number Format ==

The recipient phone number must be an Israeli mobile number matching one of these formats:

* <code>0501234567</code> — 10 digits, no separator
* <code>050-1234567</code> — with a dash separator

Valid prefixes: <code>050</code>, <code>051</code>, <code>052</code>, <code>053</code>, <code>054</code>, <code>055</code>, <code>058</code>, <code>059</code>

----

== Response Format ==

All responses are returned as JSON.

<syntaxhighlight lang="json">
{
"stat_code": 0,
"description": "SMS sent successfully",
"data": "SMS sent successfully"
}
</syntaxhighlight>

{| class="wikitable"
! Field !! Type !! Description
|-
| <code>stat_code</code> || integer || <code>0</code> = success. Any other value = error (see table below).
|-
| <code>description</code> || string || Human-readable result message.
|-
| <code>data</code> || string || Same as <code>description</code>.
|}

----

== Error Codes ==

{| class="wikitable"
! Code !! Meaning !! How to Fix
|-
| <code>0</code> || Success || —
|-
| <code>1</code> || Missing mandatory parameter || Check that all required parameters are included in your request.
|-
| <code>2</code> || Invalid phone number format || Ensure the phone number starts with <code>05</code> and contains exactly 10 digits.
|-
| <code>3</code> || Message too long || Keep the message under 500 characters.
|-
| <code>4</code> || Invalid <code>source_number</code> || Use only letters and numbers, max 12 characters. No special characters.
|-
| <code>5</code> || SMS template not found || Verify the <code>sms_template_id</code> exists and is active in the system.
|}

----

== Priority Rules (Mode 2) ==

When both a template and explicit parameters are provided, '''explicit parameters always win''':

{| class="wikitable"
! Value !! Source
|-
| <code>message</code> || Explicit param → Template text (with variables replaced)
|-
| <code>source_number</code> || Explicit param → Template's source number
|}

----

== Notes ==

* Messages are logged automatically in the customer's SMS history.
* Scheduled messages (using <code>date</code>/<code>time</code>) that are set in the past are sent immediately.
* Template variables are replaced with live customer data at the time of the request.