מיקרופיי · מרכז מפתחים מרכז מפתחים · רשימת החסומים

Webhook לרשימת החסומים

עודכן לאחרונה: 19 באוקטובר 2026 · נתמך ב-HTTP GET וב-JSON

ה-Webhook של רשימת החסומים מאפשר לקבל לשרת שלך, בזמן אמת, כל שינוי ברשימת החסומים של החשבון: חסימה חדשה, שינוי בערוצי החסימה או הסרת חסימה, בחשבון הראשי ובכל תתי המנהלים. כך אפשר לשמור את רשימת החסומים במערכות שלך (CRM, מערכת דיוור, אתר) מעודכנת תמיד, גם כשלקוח מבקש הסרה בסמס, בקישור או בטלפון. כאן המערכת פונה אליך: עליך לבנות עמוד בשרת שלך ולעדכן את כתובתו בהגדרות החשבון.

כיוון
יוצא: המערכת פונה לשרת שלך
מתי נשלח
בכל שינוי, לכל מספר
פורמט
HTTP GET · JSON
תגובה נדרשת
HTTP 200

סקירת ה-Webhook

עדכון נשלח על כל אחד מהשינויים הבאים, בכל ערוץ חסימה (סמס יוצא, סמס נכנס, שיחה נכנסת, הודעה קולית ווואטסאפ):

השינויים נשלחים מכל הדרכים שבהן רשימת החסומים מתעדכנת, והשדה source מציין את המקור:

ערך sourceמקור השינוי
manualהוספה, עדכון או הסרה ידניים במערכת, כולל העלאת קובץ או רשימה, בתפריט "ניהול חסומים גלובלית".
smsמילת הסרה בסמס נכנס.
linkקישור ההסרה בהודעה.
ivrשירות חסימה בטלפוניה.
automationשלב חסימה באוטומציה.
מה לא נשלח: שינוי של ההערה בלבד, ועדכון עם אותם ערכים בדיוק, אינם נשלחים.

הגדרת העמוד שלך

  1. 1 בנה עמוד בשרת שלך שמקבל את הפרמטרים שהמערכת שולחת (ראו טבלת הפרמטרים למטה) ומעבד אותם.
  2. 2 היכנס למערכת מיקרופיי, לחץ על אייקון הפרופיל בפינת המסך, ובתפריט שנפתח בחר "הגדרות חשבון".
  3. 3 באזור "הגדרות טכניות" לחץ על "עדכן", הזן את כתובת העמוד בשדה "כתובת URL לקבלת עדכונים על רשימת החסומים", ובחר את הפורמט: GET (ברירת מחדל) או JSON.
  4. 4 שמור. מעתה כל שינוי ברשימת החסומים יישלח לעמוד שהגדרת. כדי להפסיק, מחק את הכתובת ושמור.
תתי מנהלים: הכתובת מוגדרת בחשבון הראשי בלבד, ומקבלת את כל השינויים בחשבון: ברשימה של החשבון הראשי וברשימות של כל תתי המנהלים. השדה suid מציין למי שייכת הרשומה: 0 לחשבון הראשי, אחרת קוד תת המנהל (אותו קוד כמו בפרמטר suid של ממשק ניהול תתי המנהלים). תת מנהל חדש נכלל אוטומטית.

כתובת ציבורית: הכתובת חייבת להיות כתובת אינטרנט ציבורית שהשרתים שלנו יכולים לפנות אליה. כתובת שמפנה לרשת פנימית לא תתקבל.

מה אפשר לכלול בכתובת: כתובת ב-http או ב-https (מומלץ https), עם פורט או בלי, ואפשר להוסיף פרמטרים משלך אחרי ?, למשל מפתח זיהוי: https://www.mysite.co.il/blocklist.php?key=abc123. הפרמטרים שלנו יתווספו אחריהם עם &. בכתובת אסור לכלול רווחים, אותיות בעברית (אפשר בקידוד, למשל %D7%90), גרשיים או את התו #. אורך הכתובת עד 100 תווים, והיא חייבת להיות כתובת ציבורית ברשת.
פורמט העדכון: ב-GET הפרמטרים משורשרים לכתובת ה-URL, וב-JSON הם נשלחים בגוף בקשת POST עם הכותרת Content-Type: application/json. שתי השיטות מעבירות בדיוק את אותם שדות.

שיטת ה-HTTP בפורמט GET: כאשר כתובת העמוד היא https, הפנייה מתבצעת כבקשת HEAD (הפרמטרים בכתובת ה-URL, ללא הורדת גוף התשובה). כאשר הכתובת היא http רגיל, הפנייה מתבצעת כבקשת GET. לכן ודא שהעמוד שלך קורא את הפרמטרים משורת הכתובת (למשל $_GET ב-PHP, שמאוכלס גם בבקשת HEAD), ואינו מתנה את פעולתו בכך ש-REQUEST_METHOD הוא דווקא GET.

הפרמטרים שהמערכת שולחת

פרמטרערכיםתיאור
typeמחרוזתסוג העדכון. תמיד blocklist.
phoneמספר טלפוןהמספר שהשתנה. מספר ישראלי בפורמט מקומי (לדוגמה 0541234567), ומספר מחו"ל בפורמט בינלאומי מלא עם קידומת המדינה (לדוגמה 447911123456).
suidמספרלמי שייכת הרשומה: 0 לרשימה של החשבון הראשי, אחרת קוד תת המנהל.
eventמחרוזתnew: המספר נוסף לרשימה. update: ערוצי החסימה של מספר קיים השתנו, כולל הסרת חסימה.
sourceמחרוזתמקור השינוי: manual, sms, link, ivr או automation. ראו את הטבלה למעלה.
smsout0 / 1חסימה לסמס יוצא (שליחת סמס למספר).
smsin0 / 1חסימה לסמס נכנס מהמספר.
callin0 / 1חסימה לשיחה נכנסת מהמספר.
vms0 / 1חסימה להודעה קולית למספר.
wa0 / 1חסימה להודעות וואטסאפ למספר.
noteטקסטההערה שנשמרה עם הרשומה, כפי שהיא מופיעה בעמודה "מידע נוסף" בדוח החסומים במערכת, עד 50 תווים. כשאין הערה: 0.
dateתאריך ושעהמועד השינוי, לפי שעון ישראל, בפורמט YYYY-MM-DD HH:MM:SS.
המצב המלא בכל עדכון: חמשת שדות הערוצים (smsout, smsin, callin, vms, wa) מכילים תמיד את המצב אחרי השינוי, 1 חסום ו-0 פתוח. אין צורך לחשב הבדלים: די לשמור את הערכים שהתקבלו עבור המספר.

דוגמת עדכון בפורמט GET

אם, לדוגמה, כתובת העמוד שהגדרת היא https://www.mysite.co.il/blocklist.php, ולקוח שלח סמס עם מילת ההסרה, המערכת תפנה לעמוד עם הפרמטרים משורשרים לכתובת. מכיוון שהכתובת היא https, הפנייה מתבצעת כבקשת HEAD:

פנייה יוצאת · HTTP HEAD (https)
HEAD https://www.mysite.co.il/blocklist.php?type=blocklist&phone=0541234567&suid=0&event=new&source=sms&smsout=1&smsin=0&callin=0&vms=0&wa=0&note=%5BSMS%5D+%D7%94%D7%A1%D7%A8&date=2026-10-18+14%3A02%3A11

דוגמה להסרת חסימה ידנית ברשימה של תת מנהל שהקוד שלו 10025:

פנייה יוצאת · HTTP HEAD (https)
HEAD https://www.mysite.co.il/blocklist.php?type=blocklist&phone=0527654321&suid=10025&event=update&source=manual&smsout=0&smsin=0&callin=0&vms=0&wa=0&note=0&date=2026-10-18+14%3A05%3A40

אם כתובת העמוד היא http רגיל (ללא TLS), אותה פנייה מתבצעת כבקשת GET במקום HEAD, עם אותם פרמטרים בדיוק. בשני המקרים העמוד שלך קורא את הפרמטרים משורת הכתובת, מעבד אותם, ומחזיר קוד HTTP 200.

דוגמת עדכון בפורמט JSON

אם בחרת בפורמט JSON, המערכת שולחת בקשת POST לכתובת שהגדרת, עם גוף JSON המכיל את אותם שדות (כל הערכים כמחרוזת):

פנייה יוצאת · JSON
POST https://www.mysite.co.il/blocklist.php
Content-Type: application/json

{"type":"blocklist","phone":"0541234567","suid":"0","event":"new","source":"sms","smsout":"1","smsin":"0","callin":"0","vms":"0","wa":"0","note":"[SMS] הסר","date":"2026-10-18 14:02:11"}
איך מקבלים את גוף ה-JSON? בעמוד שלך יש לקרוא את גוף הבקשה הגולמי, לדוגמה ב-PHP באמצעות json_decode(file_get_contents("php://input"), true), ולא דרך $_POST.

תגובת השרת שלך

העמוד שלך צריך להחזיר קוד HTTP 200 בלבד, אין צורך להחזיר תוכן בגוף התשובה. בכתובת https או בפורמט JSON, אם העמוד מחזיר קוד אחר, או שאינו זמין, המערכת תנסה לפנות אליו שוב עד 3 פעמים נוספות, בהפרש של 5 דקות. בכתובת http רגיל בפורמט GET, המערכת שולחת את העדכון בלי להמתין לתשובה, ולכן ניסיון חוזר מתבצע רק כאשר אין אפשרות להתחבר לשרת שלך.

חשוב לבניית העמוד:
  • כמות: כל מספר נשלח בפנייה נפרדת. העלאה של עשרות אלפי מספרים יוצרת עשרות אלפי פניות לעמוד שלך. מומלץ שהעמוד יענה מהר, בפחות משנייה, ויבצע את העיבוד ברקע.
  • סדר: עדכון שנכשל בפנייה לעמוד שלך נשלח שוב מאוחר יותר, ולכן העדכונים לא תמיד מגיעים לפי הסדר. לכל מספר, החילו את העדכון עם ה-date המאוחר ביותר.
  • כפילויות: במקרים נדירים אותו עדכון יכול להגיע פעמיים. קבלה חוזרת של אותם ערכים לא אמורה לשנות דבר אצלכם.
  • סנכרון מלא: עדכון שלא הצליח להגיע אחרי כל הניסיונות החוזרים לא יישלח שוב. אפשר תמיד לייצא את רשימת החסומים המלאה מהמערכת, בתפריט "ניהול חסומים", ולסנכרן מחדש.

שאלות נפוצות

על אילו שינויים ברשימת החסומים נשלח עדכון?

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

האם מתקבלים גם שינויים של תתי המנהלים?

כן. הכתובת מוגדרת בחשבון הראשי בלבד ומקבלת את כל השינויים בחשבון: ברשימה של החשבון הראשי וברשימות של כל תתי המנהלים. השדה suid מציין למי שייכת הרשומה: 0 לחשבון הראשי, אחרת קוד תת המנהל. תת מנהל חדש נכלל אוטומטית.

איך מזהים הסרת חסימה?

הסרת חסימה נשלחת כ-event=update, כשכל ערוצי החסימה (smsout, smsin, callin, vms, wa) הם 0. בכל עדכון נשלח המצב המלא של כל הערוצים אחרי השינוי, כך שאין צורך לחשב הבדלים.

מה קורה בהעלאה של הרבה מספרים?

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

מה העמוד שלי צריך להחזיר בתגובה?

די שהעמוד יחזיר קוד HTTP 200, מהר ככל האפשר. אין צורך להחזיר תוכן. בכתובת https או בפורמט JSON, אם מוחזר קוד אחר או שהעמוד אינו זמין, המערכת מנסה שוב עד 3 פעמים נוספות, בהפרש של 5 דקות. בכתובת http בפורמט GET העדכון נשלח בלי המתנה לתשובה, ולכן ניסיון חוזר מתבצע רק כשאין אפשרות להתחבר לשרת.

ממשקים קשורים

רוצה לשמור את רשימת החסומים מסונכרנת עם המערכות שלך?
פתח חשבון, הגדר עמוד בשרת שלך וקבל כל שינוי ברשימת החסומים בזמן אמת
פתח חשבון חינם