דלג לתוכן הראשי

רשימה שחורה

שירותי API לניהול מספרי מתקשר חסומים. חסימה יכולה להיות גלובלית (לכל מספרי המסקיו בחשבון) או משויכת למסקיו מסוים (חסימה שתחול רק כאשר המתקשר פונה לאותו מסקיו).

המערכת מנרמלת אוטומטית את פורמט מספר הטלפון שנשלח.

get_blacklist​

החזרת רשומות מהרשימה השחורה. ללא פרמטרים – מוחזרת כל הרשימה. בהצלחה מוחזר קוד 200 ושדה result המכיל את הרשומות.

Endpoint: /api/?service=get_blacklist

פרמטרים​

פרמטרסוגחובהתיאור
caller_numberstringלאסינון לפי מספר (התאמה לפי סיומת המספר).
maskyoostringלאסינון לפי שיוך למסקיו ספציפי. נכנס לתוקף רק כש-caller_number אינו ריק. כאשר caller_number נשלח ללא maskyoo, מוחזרות גם החסימה הגלובלית וגם החסימות המשויכות-מסקיו התואמות לאותו מספר.
formatstringלאjson / xml.

קוד שגיאה​

קודתיאור
2001אין תוצאות

add_number_to_blacklist​

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

Endpoint: /api/?service=add_number_to_blacklist

פרמטרים​

פרמטרסוגחובהתיאור
caller_numberstringכןהמספר לחסימה.
maskyoostringלאאם נשלח – החסימה תחול רק על השילוב מסקיו+מתקשר.
notestringלאהערה (מקוצר ל-149 תווים).
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
2021caller_number חסר או נותר ריק לאחר ניקוי תווים לא-ספרתיים
2022המספר כבר ברשימה השחורה
2023ההכנסה נכשלה

דוגמה – חסימה גלובלית​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=add_number_to_blacklist" \
     -d "caller_number=972544224422" \
     -d "note=Spam" \
     -d "format=json"

דוגמה – חסימה בהקשר מסקיו מסוים​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=add_number_to_blacklist" \
     -d "caller_number=972544224422" \
     -d "maskyoo=972776670000" \
     -d "note=blocked at this line only" \
     -d "format=json"

remove_number_from_blacklist​

הסרת מספר מהרשימה השחורה. אם ההוספה בוצעה בשילוב מסקיו, יש לציין גם כאן את הפרמטר maskyoo.

Endpoint: /api/?service=remove_number_from_blacklist

פרמטרים​

פרמטרסוגחובהתיאור
caller_numberstringכןהמספר להסרה.
maskyoostringלאנדרש אם ההוספה בוצעה בשילוב מסקיו.
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
2011caller_number ריק / לא מספרי
2012המספר לא נמצא ברשימה
2013ההסרה נכשלה

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

בעת קריאה ל-release_maskyoo (וגם ב-restore_maskyoo) המערכת מוחקת אוטומטית כל חסימה ברמת המסקיו שמשויכת למספר זה. חסימות גלובליות (ללא שיוך למסקיו) נשארות.

השפעות על המערכת​

הוספה לרשימה השחורה דרך ה‑API חוסמת את המתקשר באופן מיידי:

  • מרכזיה — שיחה נכנסת ממספר חסום נדחית ברמת ה‑PBX; לא מתקבל CDR מלא
  • חסימה גלובלית לעומת ספציפית — ללא maskyoo החסימה תחול על כל המספרים בחשבון; עם maskyoo היא תחול רק על אותו שילוב מתקשר+מסקיו
  • נרמול אוטומטי — המערכת מנרמלת את פורמט מספר הטלפון לפני השמירה; ניסיון כפול מחזיר 2022
  • אינטגרציה עם CRM — נפוץ להזין ספאמרים שזוהו במערכות CRM אוטומטית דרך ה‑API לחסימה בכל מספרי החברה
  • שחרור מסקיו — מחיקה של מסקיו מסירה חסימות ספציפיות למספר זה; חסימות גלובליות נשמרות

ראו גם​