מבוא

ה-API של iLeads מאפשר לשלוח הודעות SMS, לקבל דוחות מסירה, לנהל רשימות תפוצה ולשלוח קודי אימות – ישירות מהמערכות שלכם. כל הפעולות נשלחות כבקשת POST לכתובת אחת, ומה שקובע את הפעולה הוא אלמנט הבסיס של הבקשה.

כתובות

Productionhttps://app.ileads.co.il/api

Testhttps://app.ileads.co.il/api/test

כתובת ה-Test מחזירה תשובה זהה לבקשה אמיתית, אבל לא מבצעת את הפעולה. מתאים לבדיקת תקינות הבקשה בזמן פיתוח.

פורמט

אפשר לשלוח XML או JSON, והתשובה תחזור באותו פורמט. הגדירו את הכותרת בהתאם: Content-Type: application/xml או Content-Type: application/json.

מבנה התשובה

כל תשובה כוללת את השדה status – ‏0 פירושו הצלחה, וכל ערך אחר הוא קוד שגיאה (ראו קודי שגיאה). השדה message מסביר את התוצאה. שם אלמנט הבסיס בתשובה משתנה לפי הפעולה.

מוסכמות

מספרי טלפון: בפורמט 5xxxxxxxx או 05xxxxxxxx.
תאריכים: בפורמט dd/mm/yy hh:mm.
מאפיינים ב-JSON: מאפיין XML (למשל id של phone) נכתב ב-JSON תחת "$", והערך עצמו תחת "_". ראו את הדוגמה בשליחת SMS.

אבטחה

החיבור חייב להיות ב-TLS 1.2 ומעלה.

מומלץ להגביל את הגישה לכתובות IP מורשות: בממשק המערכת, בלשונית "הגדרות" ← "החשבון שלי", הפעילו "בדיקת כתובות IP מורשות" והגדירו לפחות כתובת אחת.

Postman

כל הפעולות מוכנות לבדיקה ב-Postman: הורדת ה-Collection. אחרי הייבוא, הגדירו את המשתנים token ו-username.

בדיקה מהירה

curl -X POST "https://app.ileads.co.il/api/test" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"balance":{"user":{"username":"my_username"}}}'

תשובה לדוגמה

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>12345678</shipment_id>
</sms>

אימות (API Token)

כל בקשה נשלחת עם API Token בכותרת Authorization, בשיטת Bearer.

יצירת הטוקן הראשון

היכנסו למערכת, ללשונית "הגדרות", ובחרו "ניהול Token API".
לחצו "יצירת טוקן חדש".
הטוקן מוצג פעם אחת בלבד – שמרו אותו במקום מאובטח. לא ניתן לשחזר אותו בהמשך.

כללים

עד 5 טוקנים פעילים לכל משתמש, וכולם פועלים במקביל. לכל טוקן שם ייחודי.
כל טוקן תקף ל-24 חודשים ממועד יצירתו. תאריך התפוגה חוזר בשדה expiration_date ואינו מתארך.
טוקנים נוספים אפשר ליצור גם דרך ה-API, עם טוקן תקף קיים – ראו יצירת API Token.
מחיקת טוקן בממשק מבטלת אותו מיד.

יצירת טוקן באמצעות שם משתמש וסיסמה אינה נתמכת. טוקן נוצר רק דרך הממשק, או דרך ה-API עם טוקן קיים.

יצירת API Token

POSThttps://app.ileads.co.il/api<getApiToken>

יצירת טוקן חדש, או שליפת הטוקן העדכני, באמצעות טוקן תקף קיים. חשבון אב יכול ליצור טוקן עבור חשבון משנה שלו.

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

פרמטרים

שם	סוג	תיאור
`getApiToken`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user → username`חובה	string	שם המשתמש של חשבון האב (החשבון שהטוקן שלו נשלח בבקשה).
`username`חובה	string	שם המשתמש שעבורו נוצר הטוקן.
`action`חובה	string	"new" – יצירת טוקן חדש. "current" – שליפת הטוקן העדכני ביותר.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version='1.0' encoding='UTF-8'?>
<getApiToken>
    <user>
        <username>admin_username</username>
    </user>
    <username>username_for_token</username>
    <action>new</action>
</getApiToken>

JSON

{
  "getApiToken": {
    "user": {
      "username": "admin_username"
    },
    "username": "username_for_token",
    "action": "new"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<getApiToken>
    <status>0</status>
    <message>0zrjDjZ26Dll5dqdTBmuwwtQg8</message>
    <expiration_date>07/06/2025 09:17:34</expiration_date>
</getApiToken>

JSON

{
  "status": 0,
  "message": "0zrjDjZ26Dll5dqdTBmuwwtQg8",
  "expiration_date": "07/06/2025 09:19:14"
}

אימות מספר שולח

POSThttps://app.ileads.co.il/api<verify_phone>

אימות מספר טלפון לשימוש כמקור (שולח) של הודעות. לנייד יישלח קישור אימות; לקווי – הנחיות לשיחת אימות.

פרמטרים

שם	סוג	תיאור
`verify_phone`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`phone`חובה	string	מספר נייד או קווי תקין לאימות. ניתן כמה שדות.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<verify_phone>
    <user>
        <username>my_username</username>
    </user>
    <phone>5xxxxxxxx</phone>
    <phone>3xxxxxxx</phone>
</verify_phone>

JSON

{
  "verify_phone": {
    "user": {
      "username": "my_username"
    },
    "phone": [
      "5xxxxxxxx",
      "3xxxxxxx"
    ]
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<verify_phone>
    <status>0</status>
    <verify_message>
        verification link will be send to 5********
        in order to complete the verification of 3******* call to 0552458888
    </verify_message>
</verify_phone>

JSON

{
  "status": 0,
  "verify_message": "verification link will be send to 5******** in order to complete the verification of 3******* call to 0552458888"
}

מספרים מאומתים

POSThttps://app.ileads.co.il/api<getVerifiedPhones>

שליפת כל המספרים המאומתים בחשבון.

פרמטרים

שם	סוג	תיאור
`getVerifiedPhones`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`is_subs`	int	1 – כולל המספרים המאומתים של חשבונות המשנה. אחרת – לא לשלוח את השדה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getVerifiedPhones>
    <user>
        <username>my_username</username>
    </user>
    <is_subs>1</is_subs>
</getVerifiedPhones>

JSON

{
  "getVerifiedPhones": {
    "user": {
      "username": "my_username"
    },
    "is_subs": "1"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getVerifiedPhones>
    <status>0</status>
    <message></message>
    <verified_phones>
        <verified_phone>
            <PHONE>xxxxxxxxxx</PHONE>
            <USER_ID>xxx</USER_ID>
            <ASSIGNMENT_DATE>03/12/14 12:33</ASSIGNMENT_DATE>
            <LAST_UPDATE>03/12/14 12:33</LAST_UPDATE>
        </verified_phone>
    </verified_phones>
</getVerifiedPhones>

JSON

{
  "status": 0,
  "message": "",
  "verified_phones": [
    {
      "PHONE": "xxxxxxxxxx",
      "USER_ID": "XXXX",
      "ASSIGNMENT_DATE": "03/12/14 12:33",
      "LAST_UPDATE": "03/12/14 12:33"
    },
    {
      "PHONE": " xxxxxxxxxx ",
      "USER_ID": "XXXX",
      "ASSIGNMENT_DATE": "03/12/14 12:33",
      "LAST_UPDATE": "03/12/14 12:33"
    }
  ]
}

שליחת SMS

POSThttps://app.ileads.co.il/api<sms>

שליחת הודעה אחת לנמען אחד או לרבים – מספרים בודדים, רשימות תפוצה, או שילוב של שניהם.

פרמטרים

שם	סוג	תיאור
`sms`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`source`חובה	string	שם או מספר השולח. עד 11 תווים – ספרות (ללא +) ואותיות באנגלית. המקור חייב להיות מאומת.
`destinations`חובה	object	מכיל את הנמענים. ניתן לשלב כמה שדות phone ו-cl_id.
`phone`חובה	string	מספר הנמען. בפורמט 5xxxxxxxx או 05xxxxxxxx.
`phone@id`	string	מאפיין של phone – מזהה חיצוני משלכם, לשליפת דוח מסירה (DLR) בהמשך. השאירו ריק אם אין צורך.
`cl_id`	string	מזהה רשימת תפוצה לשליחה אליה.
`message`חובה	string	תוכן ההודעה. עד 1005 תווים.
`timing`	string	מועד שליחה עתידי. ללא שדה זה ההודעה נשלחת מיד. פורמט: dd/mm/yy hh:mm
`tag`	string	למשתמשי אימות SMS אוטומטי של Google – מוסיף תגית לתחילת ההודעה. למשל: tag=# ו-message=Hello world יישלח כ-"<#>Hello world".
`add_dynamic`	string	1 – שליחה עם השדות הדינמיים של רשימת התפוצה. בשימוש זה מותר cl_id אחד בלבד וללא phone בודדים. בתוכן ההודעה: [DYNAMIC_FIELD1], [DYNAMIC_FIELD2] וכו'.
`add_unsubscribe`	int	אפשרות הסרה: 3 – הסרה בקישור, 2 – הסרה בהודעה חוזרת. כל ערך אחר – ללא.
`temp_bl`	string	סינון נמענים שקיבלו הודעה ב-X הימים האחרונים (1–14).
`includes_international`	int	1 – הנמענים כוללים מספרים בינלאומיים, 0 – לא.
`campaign_name`	string	שם הקמפיין שיוצג בדוחות המערכת. עד 50 תווים.
`links`	object	מכיל קישורים לקיצור בתוך ההודעה. ניתן כמה שדות link.
`link`	string	קישור לקיצור. חייב מאפיין id. בתוכן ההודעה כתבו [link-id] במקום שבו יופיע הקישור המקוצר.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <user>
        <username>my_username</username>
    </user>
    <source>DemoAPI</source>
    <destinations>
        <cl_id>21518</cl_id>
        <cl_id>21500</cl_id>
        <phone id="external id1">5xxxxxxxx</phone>
        <phone id="external id2">5xxxxxxxx</phone>
        <phone>5xxxxxxxx</phone>
        <phone id="">5xxxxxxxx</phone>
    </destinations>
    <tag>#</tag>
    <message>This is a sample message. [link-a1]</message>
    <add_dynamic>0</add_dynamic>
    <timing>30/03/14 10:10</timing>
    <add_unsubscribe>0</add_unsubscribe>
    <temp_bl>2</temp_bl>
    <includes_international>1</includes_international>
    <campaign_name>Sample Campaign</campaign_name>
    <links>
        <link id="a1">https://www.example.com/path/to/resource</link>
    </links>
</sms>

JSON

{
  "sms": {
    "user": {
      "username": "my_username"
    },
    "source": "DemoAPI",
    "destinations": {
      "cl_id": [
        "21518",
        "21500"
      ],
      "phone": [
        {
          "$": {
            "id": "external id1"
          },
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": "external id2"
          },
          "_": "5xxxxxxxx"
        },
        {
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": ""
          },
          "_": "5xxxxxxxx"
        }
      ]
    },
    "tag": "#",
    "message": "This is a sample message. [link-a1]",
    "add_dynamic": "0",
    "timing": "30/03/14 10:10",
    "add_unsubscribe": "0",
    "temp_bl": "2",
    "includes_international": "1",
    "campaign_name": "Sample Campaign",
    "links": {
      "link": [
        {
          "$": {
            "id": "a1"
          },
          "_": "https://www.example.com/path/to/resource"
        }
      ]
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

שליחה מרובה (Bulk)

POSThttps://app.ileads.co.il/api<bulk>

שליחת הודעות שונות לנמענים שונים בבקשה אחת – למשל הודעה אישית לכל לקוח.

פרמטרים

שם	סוג	תיאור
`bulk`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`messages`חובה	array	מערך של אובייקטי sms. עד 2500 הודעות בבקשה.
`sms → source`חובה	string	שם או מספר השולח. עד 11 תווים – ספרות ואותיות באנגלית.
`sms → destinations`חובה	object	הנמענים של ההודעה הזו.
`sms → phone`חובה	string	מספר הנמען. בפורמט 5xxxxxxxx או 05xxxxxxxx. מאפיין id אופציונלי לדוח מסירה.
`sms → message`חובה	string	תוכן ההודעה. עד 1005 תווים.
`sms → links`	object	קישורים לקיצור בהודעה הזו (link עם מאפיין id, ובהודעה [link-id]).
`cl_id`	string	מזהה רשימת תפוצה.
`timing`	string	מועד שליחה עתידי. פורמט: dd/mm/yy hh:mm
`add_unsubscribe`	int	3 – הסרה בקישור, 2 – הסרה בהודעה חוזרת.
`temp_bl`	string	סינון נמענים שקיבלו הודעה ב-X הימים האחרונים (1–14).
`includes_international`	int	1 – כולל מספרים בינלאומיים.
`campaign_name`	string	שם הקמפיין בדוחות. עד 50 תווים.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<bulk>
    <user>
        <username>my_username</username>
    </user>
    <messages>
        <sms>
            <source>DemoAPI</source>
            <destinations>
                <phone id="external id1">5xxxxxxxx</phone>
                <phone id="external id2">5xxxxxxxx</phone>
                <phone>5xxxxxxxx</phone>
                <phone id="">5xxxxxxxx</phone>
            </destinations>
            <message>This is a sample message</message>
        </sms>
        <sms>
            <source>DemoAPI</source>
            <destinations>
                <phone id="">5xxxxxxxx</phone>
            </destinations>
            <message>This is a different message sent. [link-a1]</message>
            <links>
                <link id="a1">https://www.example.com/path/to/resource</link>
            </links>
        </sms>
    </messages>
    <timing>10/10/17 10:10</timing>
    <temp_bl>2</temp_bl>
    <includes_international>1</includes_international>
    <campaign_name>Sample Bulk Campaign</campaign_name>
</bulk>

JSON

{
  "bulk": {
    "user": {
      "username": "my_username"
    },
    "messages": {
      "sms": [
        {
          "source": "DemoAPI",
          "destinations": {
            "phone": [
              {
                "$": {
                  "id": "external id1"
                },
                "_": "5xxxxxxxx"
              },
              {
                "$": {
                  "id": "external id2"
                },
                "_": "5xxxxxxxx"
              },
              {
                "_": "5xxxxxxxx"
              },
              {
                "$": {
                  "id": ""
                },
                "_": "5xxxxxxxx"
              }
            ]
          },
          "message": "This is a sample message"
        },
        {
          "source": "DemoAPI",
          "destinations": {
            "phone": {
              "_": "5xxxxxxxx",
              "$": {
                "id": ""
              }
            }
          },
          "message": "This is a different message sent. [link-a1]",
          "links": {
            "link": [
              {
                "$": {
                  "id": "a1"
                },
                "_": "https://www.example.com/path/to/resource"
              }
            ]
          }
        }
      ]
    },
    "timing": "10/10/17 10:10",
    "temp_bl": "2",
    "includes_international": "1",
    "campaign_name": "Sample Bulk Campaign"

  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?> <sms>
    <status>0</status>
    <message>SMS bulk will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

בדיקת יתרה

POSThttps://app.ileads.co.il/api<balance>

בדיקת יתרת ההודעות בחשבון.

פרמטרים

שם	סוג	תיאור
`balance`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<balance>
    <user>
        <username>my_username</username>
    </user>
</balance>

JSON

{
  "balance": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<balance>
    <status>0</status>
    <message>Your balance is : 42 and international balance: 40.5 nis</message>
    <balance>42</balance>
    <interantional_balance>40.5</interantional_balance>
</balance>

JSON

{
  "status": 0,
  "message": "Your balance is : 42 and international balance: 40.5 nis",
  "balance": "42",
  "international_balance": "40.5"
}

שליחת קוד אימות

POSThttps://app.ileads.co.il/api<send_otp>

שליחת קוד אימות חד-פעמי בן 6 ספרות ב-SMS. הקוד נוצר ונשמר במערכת לבדיקה בהמשך.

פרמטרים

שם	סוג	תיאור
`send_otp`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.
`source`חובה	string	שם או מספר השולח שיופיע לנמען.
`app_id`	int	להבחנה בין כמה אפליקציות שמשתמשות בשירות. ברירת מחדל: 1.
`max_tries`	int	מספר ניסיונות להזנת הקוד, 3–5. ברירת מחדל: 3.
`valid_time`	int	תוקף הקוד בדקות, 1–15. ברירת מחדל: 5.
`text`	string	נוסח מותאם – חייב לכלול [code]. ברירת מחדל: "the code is [code]".

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<send_otp>
    <user>
        <username>my_username</username>
    </user>
    <phone>05XXXXXXXX</phone>
    <app_id>1000</app_id>
    <source>MyBrand</source>
    <max_tries>4</max_tries>
    <text>the code is [code]</text>
</send_otp>

JSON

{
  "send_otp": {
    "user": {
      "username": "my_username"
    },
    "phone": "05XXXXXXXX",
    "app_id": "1000",
    "source": "MyBrand",
    "max_tries": "4",
    "text": "the code is [code]"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <code>494036</code>
    <message>The code is : 494036 and is valid for 5 minutes</message>
</sms>

JSON

{
  "status": 0,
  "code": "494036",
  "message": "The code is : 494036 and is valid for 5 minutes"
}

בדיקת קוד אימות

POSThttps://app.ileads.co.il/api<validate_otp>

בדיקה אם הקוד שהמשתמש הזין תקף עבור המספר.

קוד שגוי מחזיר status 12 (Unverified code).

פרמטרים

שם	סוג	תיאור
`validate_otp`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.
`code`חובה	int	הקוד בן 6 הספרות לבדיקה.
`app_id`	int	אותו app_id שנשלח בשליחת הקוד. ברירת מחדל: 1.
`service_type`	string	sms או whatsapp. ברירת מחדל: sms.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<validate_otp>
    <user>
        <username>my_username</username>
    </user>
    <phone>05XXXXXXXX</phone>
    <app_id>1000</app_id>
    <code>494036</code>
</validate_otp>

JSON

{
  "validate_otp": {
    "user": {
      "username": "my_username"
    },
    "phone": "05XXXXXXXX",
    "app_id": "1000",
    "code": "494036"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>The code successfully validated</message>
</sms>

JSON

{
  "status": 0,
  "message": "The code successfully validated"
}

קבלת עדכונים (Push)

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

העדכונים נשלחים כבקשת POST בפורמט application/x-www-form-urlencoded, עם אותם שמות שדות כמו בתשובות ה-API.
החזירו 200 OK. תשובה אחרת תעכב את השליחות, ואחרי כמה כישלונות השליחה תיפסק.
הגדרת הכתובת: בממשק המערכת, או דרך הגדרת כתובת Push.

דוח מסירה (dlr)

השדות: external_id, status (ראו סטטוסי מסירה), he_message, en_message, date, phone, operaor (כך נכתב שם השדה), shipment_id.

HTTP

POST https://your-site.com/ileads/dlr
Content-Type: application/x-www-form-urlencoded

external_id=1234&status=102&he_message=הגיע+ליעד&en_message=Delivered
&date=01/04/26 16:05:05&phone=9725xxxxxxxx&operaor=Cellcom&shipment_id=12345678

הודעה נכנסת (incoming_sms)

השדות: message, date, phone (השולח), dest (המספר שלכם).

Text

message=This+is+a+sample+message&date=01/04/26 16:05:05
&phone=9725xxxxxxxx&dest=9725xxxxxxxx

חסימה (blacklist)

השדות: message, date, dest.

Text

message=נחסם+מנוי&date=01/04/26 16:05:05&dest=9725xxxxxxxx

PHP

<?php
// Delivery report (DLR) receiver
$externalId = $_POST['external_id'] ?? '';
$status     = (int) ($_POST['status'] ?? -1);
$phone      = $_POST['phone'] ?? '';
$shipmentId = $_POST['shipment_id'] ?? '';

if ($status === 102) {
    // Delivered – update your records here
}

http_response_code(200);

Node.js

import express from 'express';

const app = express();
app.use(express.urlencoded({ extended: false }));

app.post('/ileads/dlr', (req, res) => {
  const { external_id, status, phone, shipment_id } = req.body;
  if (Number(status) === 102) {
    // Delivered – update your records here
  }
  res.sendStatus(200);
});

app.listen(3000);

הגדרת כתובת Push

POSThttps://app.ileads.co.il/api<push_url>

הגדרת הכתובת שאליה יישלחו עדכונים. ניתן להגדיר גם מתוך ממשק המערכת.

כתובת קיימת לעולם לא מוחלפת. אם כבר מוגדרת כתובת לסוג הזה – יוחזר status 517 ושום דבר לא ישתנה.

פרמטרים

שם	סוג	תיאור
`push_url`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`type`חובה	string	סוג העדכון: dlr, incoming_sms, blacklist, dlr_whatsapp, incoming_whatsapp.
`url`חובה	string	כתובת http/https ציבורית.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version='1.0' encoding='UTF-8'?>
<push_url>
    <user>
        <username>XXXX</username>
    </user>
    <type>dlr</type>
    <url>https://www.example.com/path/to/resource</url>
</push_url>

JSON

{
  "push_url": {
    "user": {
      "username": "my_username"
    },
    "type": "dlr",
    "url": "https://www.example.com/path/to/resource"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>push url has successfully added</message>
</sms>

JSON

{
  "status": 0,
  "message": "push url has successfully added"
}

דוח מסירה לפי מזהה

POSThttps://app.ileads.co.il/api<dlr>

שליפת סטטוס המסירה של הודעות לפי המזהה החיצוני (id) שצירפתם בשליחה.

טווח התאריכים – עד שבוע. עד 1000 מזהים בבקשה.

פרמטרים

שם	סוג	תיאור
`dlr`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`transactions`חובה	object	מכיל את המזהים לבדיקה. ניתן כמה שדות external_id.
`external_id`חובה	string	המזהה ששלחתם כמאפיין id של phone בעת השליחה.
`from`חובה	string	תחילת הטווח. פורמט: dd/mm/yy hh:mm
`to`חובה	string	סוף הטווח. פורמט: dd/mm/yy hh:mm

פירוט כל קודי הסטטוס · סטטוסי מסירה

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <user>
        <username>my_username</username>
    </user>
    <transactions>
        <external_id>some id 1</external_id> <external_id>some id
        2</external_id>
    </transactions>
    <from>01/01/14 00:00</from>
    <to>01/01/14 23:59</to>
</dlr>

JSON

{
  "dlr": {
    "user": {
      "username": "my_username"
    },
    "transactions": {
      "external_id": [
        "some id 1",
        "some id 2"
      ]
    },
    "from": "01/01/14 00:00",
    "to": "01/01/14 23:59"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <external_id>1391438285</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
        <transaction>
            <external_id>1391438286</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:22",
      "operator": "Telzar"
    },
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:23",
      "operator": "Telzar"
    }
  ]
}

דוח מסירה לפי תאריך

POSThttps://app.ileads.co.il/api<dlrByDate>

שליפת דוחות מסירה לפי טווח תאריכים, ללא מזהה חיצוני.

טווח התאריכים – עד שבוע.

פרמטרים

שם	סוג	תיאור
`dlrByDate`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`transactions`חובה	object	מכיל external_id.
`external_id`חובה	string	יכול להכיל את הערך null.
`from`חובה	string	תחילת הטווח. פורמט: dd/mm/yy hh:mm
`to`חובה	string	סוף הטווח. פורמט: dd/mm/yy hh:mm

פירוט כל קודי הסטטוס · סטטוסי מסירה

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlrByDate>
    <user>
        <username>my_username</username>
    </user>
    <transactions>
        <external_id>null</external_id>
    </transactions>
    <from>01/01/14 00:00</from>
    <to>01/01/14 23:59</to>
</dlrByDate>

JSON

{
  "dlrByDate": {
    "user": {
      "username": "my_username"
    },
    "transactions": {
      "external_id": "null"
    },
    "from": "04/09/22 00:00",
    "to": "04/09/22 23:59"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <external_id>1391438285</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
        <transaction>
            <external_id>1391438286</external_id>
            <status>102</status>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>03/02/14 16:38</date>
            <shipment_id>12345678</shipment_id>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:22",
      "operator": "Telzar"
    },
    {
      "external_id": "1391438285",
      "source": "Test",
      "phone": "5XXXXXXXX",
      "status": "102",
      "message_he": "הגיע ליעד",
      "en_message": "Delivered",
      "shipment_id": "XXXXXXX",
      "date": "02/05/23 10:23",
      "operator": "Telzar"
    }
  ]
}

הודעות נכנסות

POSThttps://app.ileads.co.il/api<incoming>

שליפת הודעות SMS שהתקבלו (תגובות של נמענים).

טווח של עד שבוע, ועד שנה אחורה.

פרמטרים

שם	סוג	תיאור
`incoming`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`from`חובה	string	תחילת הטווח. פורמט: dd/mm/yy hh:mm
`to`חובה	string	סוף הטווח. פורמט: dd/mm/yy hh:mm

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<incoming>
    <user>
        <username>my_username</username>
    </user>
    <from>01/01/15 00:00</from>
    <to>01/01/15 23:59</to>
</incoming>

JSON

{
  "incoming": {
    "user": {
      "username": "my_username"
    },
    "from": "01/11/22 00:00",
    "to": "01/11/22 23:59"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<incoming>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <source>05********</source>
            <destination>05********</destination>
            <message> This is a sample message</message>
            <date>03/12/14 16:38</date>
        </transaction>
        <transaction>
            <source>05********</source>
            <destination>05********</destination>
            <message> This is a test message</message>
            <date>03/12/14 12:33</date>
        </transaction>
    </transactions>
</incoming>

JSON

{
  "status": 0,
  "message": "",
  "transactions": [
    {
      "source": "test",
      "destination": "9725XXXXXXX",
      "message": "test ",
      "date": "01/05/23 00:00"
    },
    {
      "source": "test1",
      "destination": "9725XXXXXXX",
      "message": "test",
      "date": "01/05/23 00:00"
    }
  ]
}

יצירת רשימת תפוצה

POSThttps://app.ileads.co.il/api<newCL>

יצירת רשימה אחת או יותר, כולל מספרים ושדות דינמיים.

פרמטרים

שם	סוג	תיאור
`newCL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`cl`חובה	object	פרטי הרשימה ליצירה. ניתן כמה אלמנטי cl.
`cl → name`חובה	string	שם הרשימה.
`destinations`חובה	object	המספרים שיתווספו לרשימה.
`destination`חובה	object	פרטי מספר אחד.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.
`df1 … df6`	string	שדות דינמיים למספר (למשל שם פרטי, משפחה, עיר).

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<newCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <name>name1</name>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
                <df1>Israel</df1>
                <df2>Israeli</df2>
                <df3>Haifa</df3>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
    <cl>
        <name>name2</name>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
</newCL>

JSON

{
  "newCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "name": "name1",
        "destinations": {
          "destination": [
            {
              "phone": "55XXXXXXX",
              "df1": "Israel",
              "df2": "Israeli",
              "df3": "Haifa"
            },
            {"phone": "55XXXXXXX"}
          ]
        }
      },
      {
        "name": "name2",
        "destinations": {
          "destination": [
            {"phone": "55XXXXXXX"},
            {"phone": "55XXXXXXX"}
          ]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<newCL>
    <status>0</status>
    <message>conact list successfully created</message>
    <errors>
        <error>The phone is too long or too short or contain characters
            and therefore not added</error>
    </errors>
    <identifiers>
        <identifier>17419</identifier>
    </identifiers>
</newCL>

JSON

{
  "status": 0,
  "message": "conact list successfully created",
  "errors": ["The phone is too long or too short or contain characters and therefore not added"],
    "identifiers": "17419"
}

מחיקת רשימת תפוצה

POSThttps://app.ileads.co.il/api<removeCL>

מחיקת רשימה אחת או יותר לפי מזהה.

פרמטרים

שם	סוג	תיאור
`removeCL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`cl`חובה	object	מכיל את מזהי הרשימות למחיקה.
`id`חובה	string	מזהה הרשימה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<removeCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <id>21500</id>
    </cl>
</removeCL>

JSON

{
  "removeCL": {
    "user": {
      "username": "my_username"
    },
    "cl": {
      "id": ["21518","21500"]
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<removeCL>
    <status>0</status>
    <message>contact list successfully removed</message>
    <errors>
        <error>contact list id: 21500 does not exist and therefore not removed</error>
    </errors>
</removeCL>

JSON

{
  "status": 0,
  "message": "conact lists successfully removed",
  "errors": ["contact list id: 21500 does not exist and therefore not removed"]
}

הוספת מספרים לרשימה

POSThttps://app.ileads.co.il/api<addNumCL>

הוספת מספרים לרשימה קיימת.

פרמטרים

שם	סוג	תיאור
`addNumCL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`cl`חובה	object	פרטי הרשימה לעדכון. ניתן כמה אלמנטי cl.
`id`חובה	int	מזהה הרשימה.
`destinations`חובה	object	המספרים להוספה.
`destination`חובה	object	פרטי מספר אחד.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.
`df1 … df6`	string	שדות דינמיים למספר ברשימה הזו.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<addNumCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
                <df1>Israel</df1>
                <df2>Israeli</df2>
                <df3>Haifa</df3>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
    <cl>
        <id>21500</id>
        <destinations>
            <destination>
                <phone>055XXXXXXX</phone>
            </destination>
            <destination>
                <phone>55XXXXXXX</phone>
            </destination>
        </destinations>
    </cl>
</addNumCL>

JSON

{
  "addNumCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "id": "21518",
        "destinations": {
          "destination": [
            {
              "phone": "055XXXXXXX",
              "df1": "Israel",
              "df2": "Israeli",
              "df3": "Haifa"
            },
            {
              "phone": "055XXXXXXX"
            }
          ]
        }
      },
      {
        "id": "21500",
        "destinations": {
          "destination": [
            {"phone": "055XXXXXXX"},
            {"phone": "055XXXXXXX"}
          ]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>The phone numbers have been added successfully</message>
    <errors>
        <error>The phone 055XXXXXXX is already on the contact list and therefore not added</error>
        <error>The phone 55XXXXXXX is already on the contact list and therefore not added</error>
    </errors>
</sms>

JSON

{
  "status": 0,
  "message": "The phone numbers have been added successfully",
  "errors": [
    "The phone 05XXXXXXXX is already on the contact list and therefore not added",
    "The phone 55XXXXXXX is already on the contact list and therefore not added"
  ]
}

הסרת מספרים מרשימה

POSThttps://app.ileads.co.il/api<rmNumCL>

הסרת מספרים מרשימה קיימת.

פרמטרים

שם	סוג	תיאור
`rmNumCL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`cl`חובה	object	פרטי הרשימה לעדכון.
`id`חובה	int	מזהה הרשימה.
`destinations`חובה	object	המספרים להסרה.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumCL>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>21518</id>
        <destinations>
            <phone>055XXXXXXX</phone>
        </destinations>
    </cl>
    <cl>
        <id>21500</id>
        <destinations>
            <phone>055XXXXXXX</phone>
            <phone>55XXXXXXX</phone>
        </destinations>
    </cl>
</rmNumCL>

JSON

{
  "rmNumCL": {
    "user": {
      "username": "my_username"
    },
    "cl": [
      {
        "id": "21518",
        "destinations": {
          "phone": "055XXXXXXX"
        }
      },
      {
        "id": "21500",
        "destinations": {
          "phone": ["055XXXXXXX", "055XXXXXXX"]
        }
      }
    ]
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumCL>
    <status>0</status>
    <message>Successfully deleted phone numbers</message>
    <errors>
        <error>contact list id: 21500 does not exist and therefore not removed</error>
    </errors>
</rmNumCL>

JSON

{
  "status": 0,
  "message": "Successfully deleted phone numbers",
  "errors": [
    "contact list id: 21500 does not exist and therefore not removed"
  ]
}

כל רשימות התפוצה

POSThttps://app.ileads.co.il/api<getCL>

שליפת כל הרשימות בחשבון, כולל רשימות ריקות.

פרמטרים

שם	סוג	תיאור
`getCL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCL>
    <user>
        <username>my_username</username>
    </user>
</getCL>

JSON

{
  "getCL": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCL>
    <status>0</status>
    <message></message>
    <contact_lists>
        <contact_list>
            <cl_id>21518</cl_id>
            <phone>55XXXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <cl_id>21518</cl_id>
            <phone>555XXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <cl_id>21500</cl_id>
            <phone>055XXXXXXX</phone>
            <name>name2</name>
        </contact_list>
    </contact_lists>
</getCL>

JSON

{
  "status": 0,
  "message": "",
  "contact_lists": [
    {
      "cl_id": "21518",
      "phone": "55XXXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21518",
      "phone": "555XXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21500",
      "phone": "555XXXXXX",
      "name": "name2"
    }
  ]
}

רשימת תפוצה לפי מזהה

POSThttps://app.ileads.co.il/api<getCLbyID>

שליפת המספרים של רשימה מסוימת.

פרמטרים

שם	סוג	תיאור
`getCLbyID`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`cl`חובה	object	מכיל את מזהה הרשימה.
`id`חובה	int	מזהה הרשימה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCLbyID>
    <user>
        <username>my_username</username>
    </user>
    <cl>
        <id>xxxxx</id>
    </cl>
</getCLbyID>

JSON

{
  "getCLbyID": {
    "user": {
      "username": "my_username"
    },
    "cl": {
      "id": "1234"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getCLbyID>
    <status>0</status>
    <message></message>
    <contact_lists>
        <contact_list>
            <phone>55XXXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <phone>555XXXXXX</phone>
            <name>name1</name>
        </contact_list>
        <contact_list>
            <phone>055XXXXXXX</phone>
            <name>name2</name>
        </contact_list>
    </contact_lists>
</getCLbyID>

JSON

{
  "status": 0,
  "message": "",
  "contact_lists": [
    {
      "cl_id": "21518",
      "phone": "55XXXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21518",
      "phone": "555XXXXXX",
      "name": "name1"
    },
    {
      "cl_id": "21500",
      "phone": "555XXXXXX",
      "name": "name2"
    }
  ]
}

שליפת הרשימה השחורה

POSThttps://app.ileads.co.il/api<blacklist>

שליפת המספרים החסומים לפי טווח תאריכים.

פרמטרים

שם	סוג	תיאור
`blacklist`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`from`חובה	string	תחילת הטווח. פורמט: dd/mm/yy hh:mm
`to`חובה	string	סוף הטווח. פורמט: dd/mm/yy hh:mm

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <user>
        <username>my_username</username>
    </user>
    <from>02/06/15 00:00</from>
    <to>15/12/15 23:59</to>
</blacklist>

JSON

{
  "blacklist": {
    "user": {
      "username": "my_username"
    },
    "from": "02/06/22 00:00",
    "to": "15/12/22 23:59"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 16:38</date>
        </transaction>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 12:33</date>
        </transaction>
    </transactions>
</blacklist>

JSON

{
  "status": 0,
  "message": "",
  "transactions": [
    {
      "phone": "5********",
      "date": "22/08/22 11:00"
    },
    {
      "phone": "5********",
      "date": "23/11/22 12:37"
    }
  ]
}

הסרה מהרשימה השחורה

POSThttps://app.ileads.co.il/api<rmNumBL>

הסרת מספרים מהרשימה השחורה, עם סיבה.

פרמטרים

שם	סוג	תיאור
`rmNumBL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`phones`חובה	object	מכיל את המספרים.
`phone`חובה	string	מספר להסרה.
`reason`חובה	string	סיבת ההסרה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<rmNumBL>
    <user>
        <username>my_username</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
    <reason>Text here</reason>
</rmNumBL>

JSON

{
  "rmNumBL": {
    "user": {
      "username": "my_username"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    },
    "reason": "Text here"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<status>944</status>
<message>X phone numbers Successfully deleted , Y Phone numbers not exist in
blacklist</message>

JSON

{
  "status": 944,
  "message": "X phone numbers Successfully deleted , Y Phone numbers not exist in blacklist"
}

הוספה לרשימה השחורה

POSThttps://app.ileads.co.il/api<addNumBL>

הוספת מספרים לרשימה השחורה – הודעות לא יישלחו אליהם.

פרמטרים

שם	סוג	תיאור
`addNumBL`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`phones`חובה	object	מכיל את המספרים.
`phone`חובה	string	מספר להוספה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<addNumBL>
    <user>
        <username>my_username</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
</addNumBL>

JSON

{
  "addNumBL": {
    "user": {
      "username": "my_username"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<status>946</status>
<message>number has successfully added to blacklist</message>

JSON

{
  "status": 946,
  "message": "number has successfully added to blacklist"
}

ביטול קמפיין

POSThttps://app.ileads.co.il/api<cancel>

ביטול שליחה מתוזמנת לפי מזהה הקמפיין.

פרמטרים

שם	סוג	תיאור
`cancel`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`campaign_id`חובה	int	מזהה הקמפיין.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>my_username</username>
    </user>
    <campaign_id>1234</campaign_id>
</cancel>

JSON

{
  "cancel": {
    "user": {
      "username": "my_username"
    },
    "campaign_id": "1324"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaign successfuly cancel</message>
</cancel>

JSON

{
  "status": 0,
  "message": "Campaign successfuly cancel"
}

ביטול קמפיינים לפי שם

POSThttps://app.ileads.co.il/api<cancel>

ביטול כל הקמפיינים המתוזמנים עם שם מסוים.

פרמטרים

שם	סוג	תיאור
`cancel`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`campaign_name`חובה	string	שם הקמפיין.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <user>
        <username>my_username</username>
    </user>
    <campaign_name>My Campaign</campaign_name>
</cancel>

JSON

{
  "cancel": {
    "user": {
      "username": "my_username"
    },
    "campaign_name": "My Campaign"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<cancel>
    <status>0</status>
    <message>Campaigns successfully cancel</message>
    <count>1</count>
</cancel>

JSON

{
  "status": 0,
  "message": "Campaigns successfully cancel",
  "count": 1
}

הודעה קולית (TTS)דורש הפעלה

POSThttps://app.ileads.co.il/api<sms>

הטקסט מומר לשיחה קולית מוקלטת אצל הנמען. זהה לשליחת SMS, בתוספת אובייקט tts. מקור השיחה יהיה מספר מערכת.

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

פרמטרים

שם	סוג	תיאור
`sms`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`source`חובה	string	שם או מספר השולח (ל-SMS). מקור השיחות – מספר מערכת.
`destinations`חובה	object	הנמענים.
`phone`חובה	string	בפורמט 5xxxxxxxx או 05xxxxxxxx.
`message`חובה	string	הטקסט להקראה. עד 1005 תווים.
`tts`חובה	object	הגדרות השיחה.
`tts → type`חובה	int	2 – SMS לטלפון רגיל ושיחה קולית לטלפון כשר. 3 – גם SMS וגם שיחה לכולם. 4 – שיחה קולית בלבד לכולם.
`tts → rate`	int	מהירות דיבור, ‎-10 עד 10 (0 רגיל).
`tts → repeat`	int	מספר השמעות בשיחה. ברירת מחדל: 2.
`tts → voice`	string	ymMale – קול גבר (ברירת מחדל), ymFemale – קול אישה.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <user>
        <username>my_username</username>
    </user>
    <source>DemoAPI</source>
    <destinations>
        <cl_id>21518</cl_id>
        <cl_id>21500</cl_id>
        <phone id="external id1">5xxxxxxxx</phone>
        <phone id="external id2">5xxxxxxxx</phone>
        <phone>5xxxxxxxx</phone>
        <phone id="">5xxxxxxxx</phone>
    </destinations>
    <message>This is a sample tts message</message>
    <tts>
        <type>4</type>
        <rate>-1</rate>
        <repeat>1</repeat>
        <voice>ymMale</voice>
    </tts>
</sms>

JSON

{
  "sms": {
    "user": {
      "username": "my_username"
    },
    "source": "DemoAPI",
    "destinations": {
      "cl_id": [
        "21518",
        "21500"
      ],
      "phone": [
        {
          "$": {
            "id": "external id1"
          },
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": "external id2"
          },
          "_": "5xxxxxxxx"
        },
        {
          "_": "5xxxxxxxx"
        },
        {
          "$": {
            "id": ""
          },
          "_": "5xxxxxxxx"
        }
      ]
    },
    "message": "This is a sample tts message",
    "tts": {
      "type": 4,
      "rete": -1,
      "repeat": 1,
      "voice": "ymMale"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<sms>
    <status>0</status>
    <message>SMS will be sent</message>
    <shipment_id>xxxxxxx</shipment_id>
</sms>

JSON

{
  "status": 0,
  "message": "SMS will be sent",
  "shipment_id": "XXXXXXX"
}

דוח מסירה קולידורש הפעלה

POSThttps://app.ileads.co.il/api<ttsDlr>

דוחות מסירה של קמפיינים קוליים (TTS).

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

טווח התאריכים – עד שבוע.

פרמטרים

שם	סוג	תיאור
`ttsDlr`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`shipment_id`	string	מזהה הקמפיין. ספרות בלבד.
`from`חובה	string	תחילת הטווח (חובה). פורמט: dd/mm/yy hh:mm
`to`חובה	string	סוף הטווח (חובה). פורמט: dd/mm/yy hh:mm

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<ttsDlr>
    <user>
        <username>my_username</username>
    </user>
    <from>01/05/23 00:00</from>
    <to>01/05/23 23:59</to>
</ttsDlr>

JSON

{
  "ttsDlr": {
    "user": {
      "username": "my_username"
    },
    "from": "01/05/23 00:00",
    "to": "01/05/23 23:59"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<dlr>
    <status>0</status>
    <message>all is well!</message>
    <transactions>
        <transaction>
            <shipment_id>12345678</shipment_id>
             <status>102</status>
            <source>07********</source>
            <phone>5********</phone>
            <he_message>הגיע ליעד</he_message>
            <en_message>Delivered</en_message>
            <date>01/05/23 10:22</date>
        </transaction>
        <transaction>
            <shipment_id>12345678</shipment_id>
            <status>6</status>
            <source>07********</source>
            <phone>5********</phone>
            <he_message>נכשל</he_message>
            <en_message>Failed</en_message>
            <date>01/05/23 10:23</date>
        </transaction>
    </transactions>
</dlr>

JSON

{
  "status": 0,
  "message": "all is well!",
  "transactions": [
    {
      "shipment_id": "12345678",
      "status": "102",
      "source": "07XXXXXXX",
      "phone": "5XXXXXXXX",
      "he_message": "הגיע ליעד",
      "en_message": "Delivered",
      "date": "01/05/23 10:22"
    },
    {
      "shipment_id": "12345678",
      "status": "6",
      "source": "07XXXXXXX",
      "phone": "5XXXXXXXX",
      "he_message": "נכשל",
      "en_message": "Failed",
      "date": "01/05/23 10:23"
    }
  ]
}

הוספת חשבון משנהדורש הפעלה

POSThttps://app.ileads.co.il/api<addSub>

יצירת חשבון משנה תחת החשבון שלכם, עם יתרת הודעות.

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

פרמטרים

שם	סוג	תיאור
`addSub`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`userDetails`חובה	object	פרטי החשבון החדש.
`userDetails → name`חובה	string	שם החשבון.
`userDetails → username`חובה	string	שם המשתמש לחשבון.
`userDetails → password`חובה	string	סיסמה לחשבון.
`userDetails → source`חובה	string	מקור (שולח) ברירת מחדל.
`userDetails → amount`חובה	int	יתרת הודעות להעברה. ספרות בלבד.
`userDetails → otpPhone`	string	מספר טלפון לאימות OTP.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<addSub>
    <user>
        <username>my_username</username>
    </user>
    <userDetails>
        <name>israel israeli</name>
        <username> israelisraeli</username>
        <password> israelisraeli</password>
        <source>055xxxxxxx</source>
        <amount>70000</amount>
        <otpPhone>5xxxxxxxx</otpPhone>
    </userDetails>
</addSub>

JSON

{
  "addSub": {
    "user": {
      "username": "my_username"
    },
    "userDetails": {
      "name": "israel israeli",
      "username": " israelisraeli ",
      "password": " israelisraeli ",
      "source": "055xxxxxxx",
      "amount": "70000",
      "otpPhone": "5xxxxxxxx"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<addSub>
    <status>0</status>
    <message>The user was created successfully</message>
</addSub>

JSON

{
  "status": 0,
  "message": "The user was created successfully"
}

עדכון יתרת חשבון משנהדורש הפעלה

POSThttps://app.ileads.co.il/api<updateAmountSub>

עדכון יתרת ההודעות של חשבון משנה.

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

פרמטרים

שם	סוג	תיאור
`updateAmountSub`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`userDetails`חובה	object	פרטי החשבון לעדכון.
`userDetails → username`חובה	string	שם המשתמש של חשבון המשנה.
`userDetails → amount`חובה	int	יתרת הודעות להעברה.
`userDetails → amount_int`	int	עדכון סכום כספי (יתרה בינלאומית) במקום כמות הודעות.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<updateAmountSub>
    <user>
        <username>my_username</username>
    </user>
    <userDetails>
        <username>username1</username>
        <amount>70000</amount>
        <amount_int>6000</amount_int>
    </userDetails>
</updateAmountSub>

JSON

{
  "updateAmountSub": {
    "user": {
      "username": "my_username"
    },
    "userDetails": {
      "username": "username1",
      "amount": "70000",
      "amount_int": "6000"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<updateAmountSub>
    <status>0</status>
    <message>Wallet successfully updated</message>
</updateAmountSub>

JSON

{
  "status": 0,
  "message": "Wallet successfully updated"
}

יתרות חשבונות המשנהדורש הפעלה

POSThttps://app.ileads.co.il/api<getBlanceSubs>

שליפת היתרה של כל חשבונות המשנה.

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

שם האלמנט getBlanceSubs נכתב כך במכוון – זה השם שהמערכת מצפה לו.

פרמטרים

שם	סוג	תיאור
`getBlanceSubs`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getBlanceSubs>
    <user>
        <username>my_username</username>
    </user>
</getBlanceSubs>

JSON

{
  "getBlanceSubs": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="UTF-8"?>
<getBlanceSubs>
<status>0</status>
<message></message>
<balances> <balance>
    <amount>80</amount>
    <sms_user_id>xxx</sms_user_id>
    <name>name1</name>
</balance> <balance>
    <amount>50</amount>
    <sms_user_id>xxx</sms_user_id>
    <name> name2</name>
</balance> </balances>
</getBlanceSubs>

JSON

{
  "status": 0,
  "message": "",
  "balances": [
    {
      "amount": "80",
      "sms_user_id": "XXXX",
      "name": "name1"
    },
    {
      "amount": "50",
      "sms_user_id": "XXXX",
      "name": "name2"
    }
  ]
}

קמפייני יום הולדתדורש הפעלה

POSThttps://app.ileads.co.il/api<get_birthday_campaigns>

שליפת קמפייני יום ההולדת (הודעות אוטומטיות שנשלחות ביום ההולדת של הנמען).

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

פרמטרים

שם	סוג	תיאור
`get_birthday_campaigns`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version="1.0" encoding="UTF-8"?>
<get_birthday_campaigns>
    <user>
        <username>my_username</username>
    </user>
</get_birthday_campaigns>

JSON

{
  "get_birthday_campaigns": {
    "user": {
      "username": "my_username"
    }
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message></message>
    <birthday_campaigns>
        <birthday_campaign>
            <CAMPAIGN_ID>XXXX</CAMPAIGN_ID>
            <CAMPAIGN_NAME>XXXX</CAMPAIGN_NAME>
            <CREATED_ON>18/10/23 14:40:39</CREATED_ON>
            <ACTIVE_DESTINATIONS>X</ACTIVE_DESTINATIONS>
        </birthday_campaign>
        <birthday_campaign>
            <CAMPAIGN_ID>XXXX</CAMPAIGN_ID>
            <CAMPAIGN_NAME>XXXX</CAMPAIGN_NAME>
            <CREATED_ON>18/10/23 14:40:39</CREATED_ON>
            <ACTIVE_DESTINATIONS>X</ACTIVE_DESTINATIONS>
        </birthday_campaign>
    </birthday_campaigns>
</sms>

JSON

{
  "status": 0,
  "message": "",
  "birthday_campaigns": {
    "birthday_campaign": [
      {
        "CAMPAIGN_ID": "xxxxx",
        "CAMPAIGN_NAME": "xxxxx",
        "CREATED_ON": "",
        "ACTIVE_DESTINATIONS": ""
      },
      {
        "CAMPAIGN_ID": "xxxxx",
        "CAMPAIGN_NAME": "xxxxx",
        "CREATED_ON": "",
        "ACTIVE_DESTINATIONS": ""
      }
    ]
  }
}

עריכת קמפיין יום הולדתדורש הפעלה

POSThttps://app.ileads.co.il/api<edit_birthday_campaign>

עדכון נוסח ההודעה של קמפיין יום הולדת.

הפעולה זמינה לחשבונות שהופעלה אצלם. לפרטים והפעלה – פנו אלינו.

פרמטרים

שם	סוג	תיאור
`edit_birthday_campaign`חובה	object	אלמנט הבסיס – מכיל את כל שאר השדות.
`user`חובה	object	מכיל את פרטי המשתמש.
`username`חובה	string	שם המשתמש של החשבון שלכם במערכת.
`campaign_id`חובה	string	מזהה הקמפיין לעריכה.
`message`חובה	string	הנוסח החדש.

פירוט כל קודי הסטטוס

בקשה

XML

<?xml version='1.0' encoding='UTF-8'?>
<edit_birthday_campaign>
    <user>
        <username>XXXX</username>
    </user>
    <campaign_id>XXXX</campaign_id>
    <message>XXXX</message>
</edit_birthday_campaign>

JSON

{
  "edit_birthday_campaign": {
    "user": {
      "username": "my_username"
    },
    "campaign_id": "XXXX",
    "message": "XXXX"
  }
}

cURL

PHP

Python

Node.js

תשובה

XML

<?xml version="1.0" encoding="utf-8"?>
<sms>
    <status>0</status>
    <message>birthday campaign successfully updated</message>
</sms>

JSON

{
  "status": 0,
  "message": "birthday campaign successfully updated"
}

קודי שגיאה

הערך שחוזר בשדה status של כל תשובה.

קוד	משמעות
`0`	הבקשה הצליחה. ההודעה בשדה message משתנה לפי הפעולה, למשל "SMS will be sent".
`1`	שגיאה בפענוח ה-XML.
`2`	שדה חובה חסר. שדה message יציין איזה שדה.
`3`	שם משתמש או סיסמה שגויים, וה-API Token אינו תקף.
`4`	אין מספיק יתרה.
`5`	אין הרשאה לשלוח SMS בשעה זו.
`6`	כשל בתהליך.
`7`	לא ניתן לשלוח בפורמט זה – יש לשלוח קבוצה ב-bulk. לפרטים פנו לתמיכה.
`8`	כל המספרים נמצאים ברשימה החסומה.
`9`	לפחות אחד מהנמענים קצר או ארוך מדי.
`10`	שם משתמש או סיסמה שגויים, וה-API Token פג תוקף.
`11`	הטוקן תקף אך אינו תואם לשם המשתמש, או שקיים טוקן חדש יותר שיש להשתמש בו.
`12`	בשליחת SMS: אין מספיק יתרה כספית. בבדיקת OTP: הקוד לא אומת.
`502`	סוג הפעולה (action) אינו תקין.
`503`	שם המשתמש אינו קיים בחשבון שלכם.
`504`	הטוקן הנוכחי לא נמצא.
`510`	בקשת verify_phone לא תקינה – אין מספרים לאימות.
`511`	אין לכם הרשאה לפעולה זו.
`515`	מקור (שולח) לא מאומת. ראו "אימות מספר שולח".
`517`	כבר קיימת כתובת Push לסוג זה.
`714`	ערך לא תקין בפרמטר temp_bl.
`715`	כל המספרים נחסמו זמנית.
`933`	מספר טלפון או סיבה אינם תקינים.
`944`	חלק מהמספרים אינם ברשימה השחורה.
`955`	הקמפיין כבר בוטל.
`966`	הקמפיין כבר נשלח.
`970`	הקמפיינים לא בוטלו. פנו לתמיכה.
`977`	הקמפיין אינו שייך ללקוח או אינו קיים.
`980`	קישור לא תקין.
`981`	שגיאה ביצירת קישור מקוצר.
`986`	ערך לא תקין ב-add_unsubscribe.
`988`	רשימת התפוצה שהוזנה אינה קיימת.
`989`	ההודעה ארוכה או קצרה מדי, או ששם הקמפיין ארוך מדי.
`990`	הכמות חייבת להיות קטנה מהיתרה שלכם.
`991`	הכמות חייבת להכיל ספרות בלבד.
`992`	המקור ארוך או קצר מדי.
`993`	הסיסמה ארוכה או קצרה מדי.
`994`	שם המשתמש כבר קיים.
`995`	שם המשתמש ארוך או קצר מדי.
`996`	השם ארוך או קצר מדי.
`997`	הפקודה שנשלחה אינה תקינה.
`998`	שגיאה לא ידועה בבקשה.
`999`	פנו לתמיכה.

סטטוסי מסירה

הערך שחוזר בשדה status של כל transaction בדוחות מסירה וב-Push.

סטטוס	משמעות
`-1`	נשלח – ללא אישור מסירה
`0`	הגיע ליעד
`1`	נכשל
`2`	Timeout
`3`	נכשל
`4`	נכשל סלולר
`5`	נכשל
`6`	נכשל
`7`	אין יתרה
`14`	נכשל סלולר – עבר תהליך store & forward
`15`	מספר כשר
`16`	אין הרשאת שעת שליחה
`17`	חסום להודעות פרסומיות
`18`	הודעה לא חוקית
`101`	לא הגיע ליעד
`102`	הגיע ליעד
`103`	פג תוקף
`104`	נמחק
`105`	לא הגיע ליעד
`106`	לא הגיע ליעד
`107`	לא הגיע ליעד
`108`	נדחה
`109–132`	לא הגיע ליעד
`201`	נחסם לפי בקשה
`747`	המנוי מחוץ לכיסוי רשת מקומית
`998`	אין הרשאה
`999`	שגיאה לא ידועה