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

2026-06-23T12:49:14Z

יצירת דף שליחת סמס ב-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.

Send SMS API - היסטוריית גרסאות

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