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

ניהול מסקיו

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

שימו לב

הקצאה (create_maskyoo), שחרור (release_maskyoo) ושחזור (restore_maskyoo) של מספרים עשויים להשפיע על התעריפים שלכם בהתאם לתוכנית המסחרית.

get_maskyoo​

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

Endpoint: /api/?service=get_maskyoo

פרמטרים​

פרמטרסוגחובהתיאור
maskyoostringלאמספר מסקיו ספציפי. אם נשלח – יוחזר רק הוא.
statusintלא1 = מספרים פעילים בלבד (ברירת מחדל) / 0 = לא פעילים. רלוונטי רק כש-maskyoo ריק.
pageintלאעמוד (ברירת מחדל 0).
limitintלאכמות רשומות לעמוד (ברירת מחדל/מקסימום 10000).
filter_namestringלאשם שדה לסינון (לדוגמה description, private_field1, email, extenstion). דורש גם filter_value.
filter_valuestringלאערך הסינון.
filter_operatorstringלאEQ (ברירת מחדל), NE, LT, GT, LIKE.
formatstringלאjson / xml.

שדות בתגובה​

description, maskyoo, maskyoo_old (רק אם תכונת שני המספרים מופעלת לחשבון), active_status, create_time, email, private_field1..10, sms_destination_phone, working_hours, out_of_time_destination_phone, callback_url, callback_url_option, greeting_in, ringback_tone, greeting_out, call_destination_phone, dial_option, dial_timeout_in_sec, record_percentage, record_option, extenstion, expose, disallow_callback, default_dest.

קודי שגיאה​

קודתיאור
4030filter_name אינו חוקי
4031אין תוצאות

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     "https://[MASKYOO_URL]/api/?service=get_maskyoo&maskyoo=0776670000&format=json"

get_available_maskyoo​

החזרת רשימת מספרים פנויים להקצאה (לא מקצה – רק מחזיר).

Endpoint: /api/?service=get_available_maskyoo

פרמטרים​

פרמטרסוגחובהתיאור
prefixstringלאקידומת לסינון המספרים הפנויים.
maskyoostringלאחלק ממספר מסקיו לסינון (חלופי ל-prefix).
amountintלאמספר התוצאות להחזרה (ברירת מחדל 5, מקסימום 50).
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
4050אין מספרים פנויים
4051אין מספרים פנויים עם הקידומת המבוקשת

create_maskyoo​

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

Endpoint: /api/?service=create_maskyoo

פרמטרים​

פרמטרסוגחובהתיאור
descriptionstringכןתיאור המספר (עד 199 תווים).
call_destination_phonestringכןמספרי יעד לחיוג, מופרדים בפסיק (מקסימום 150 תווים).
maskyoostringלאמספר מסקיו ספציפי לבקש (אחרת יוקצה אוטומטית).
prefixstringלאקידומת לבחירת מספר אוטומטית.
active_statusintלא1 = פעיל (ברירת מחדל), 0 = לא פעיל.
dial_optionint/stringלא1 / , = חיוג קבוצתי (ברירת מחדל), 2 / ; = סדרתי, 3 / IVR = נתב שיחות.
dial_timeout_in_secintלא1–180 שניות (ברירת מחדל מהגדרות החשבון).
record_optionintלא1 = ללא הקלטה, 2 = הקלטה עם הודעה, 3 = הקלטה שקטה.
record_percentageintלאאחוז הקלטה 0–100 (תומך גם בשם חלופי record_presantge).
exposeintלא1 = הצגת המסקיו (ברירת מחדל), 2 = הצגת המתקשר, 3 = אנונימי.
disallow_callbackintלא0 (מותר), 1 או 2 (חסימה לפי הגדרות החשבון).
callback_urlstringלאכתובת URL ל-callback (עד 511 תווים).
callback_url_optionintלא1 = בתחילת השיחה, 2 = בסוף (ברירת מחדל), 3 = בשניהם.
greeting_instringלאשם הודעה פנימית.
greeting_outstringלאשם הודעה למתקשר.
ringback_tonestringלאצליל המתנה (שם קובץ).
emailstringלאכתובת אימייל להתראות.
sms_destination_phonestringלאמספר/מספרים לקבלת SMS.
working_hoursstringלאתבנית שעות פעילות לאורך שבוע (168 תווים).
out_of_time_destination_phonestringלאיעד חלופי מחוץ לשעות העבודה.
private_field1 … private_field10stringלאשדות פרטיים (עד 254 תווים לכל אחד).
formatstringלאjson / xml.

קודי שגיאה עיקריים​

קודתיאור
4000description ריק או ארוך מ-199
4001call_destination_phone ריק / לא תקין / ארוך מ-150
4002-4006private_field1..10 ארוך מ-254
4007callback_url ארוך מ-511
4008-4009הקצאת המסקיו נכשלה
40010callback_url_option מחוץ לטווח 1–3
40011dial_option מחוץ לטווח 1–3
40012record_option מחוץ לטווח 1–3
40013dial_timeout_in_sec מחוץ לטווח 1–180
40014expose מחוץ לטווח 1–3
40015disallow_callback אינו 0/1/2

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=create_maskyoo" \
     -d "description=Main office" \
     -d "call_destination_phone=972544224422,972544224423" \
     -d "dial_option=1" \
     -d "record_percentage=100" \
     -d "record_option=2" \
     -d "format=json"

update_maskyoo​

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

Endpoint: /api/?service=update_maskyoo

פרמטרים​

זהים ל-create_maskyoo, כאשר:

  • חובה: maskyoo, description.
  • כל שאר הפרמטרים אופציונליים; רק ערכים שנשלחים יתעדכנו.

קודי שגיאה עיקריים​

קודתיאור
4010description ריק או ארוך מ-199
4011maskyoo ריק / קצר מ-5
4012call_destination_phone לא תקין או ארוך מ-150
4013-4017private_field1..10 ארוך מ-254
4018מספר מסקיו לא תקין
4019המסקיו לא קיים בחשבון
4020 / 4021העדכון נכשל
4022-4027ערכי callback_url_option / dial_option / record_option / dial_timeout_in_sec / expose / disallow_callback לא תקינים

דוגמה​

curl -H "Authorization: Bearer TOKEN" \
     -X POST "https://[MASKYOO_URL]/api/?service=update_maskyoo" \
     -d "maskyoo=972776670000" \
     -d "description=Updated" \
     -d "call_destination_phone=972544224422" \
     -d "record_percentage=50" \
     -d "format=json"

release_maskyoo​

שחרור מספר מסקיו מהחשבון. המספר חוזר למאגר המספרים הזמינים.

Endpoint: /api/?service=release_maskyoo

פרמטרים​

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

בשחרור המערכת גם מסירה אוטומטית חסימות ברמת המסקיו עבור המספר הזה; חסימות גלובליות ברשימה השחורה נשארות.

קודי שגיאה​

קודתיאור
4040maskyoo חסר
4041המסקיו לא קיים
4042השחרור נכשל
4043המסקיו לא תקין

restore_maskyoo​

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

Endpoint: /api/?service=restore_maskyoo

פרמטרים​

פרמטרסוגחובהתיאור
maskyoostringכןהמספר לשחזור.
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
4040maskyoo חסר
4041מספר לא תקין
4042המספר לא רשום כמספר ששוחרר מהחשבון
4043המספר כבר פעיל
4044לא ניתן לשחזר את המספר לחשבון

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

create_maskyoo_call​

יזום שיחה (Click2Call קלאסי): המערכת מתקשרת ליעד ובעת מענה מחברת אותו למסקיו.

Endpoint: /api/?service=create_maskyoo_call

פרמטרים​

פרמטרסוגחובהתיאור
maskyoostringכןהמספר ממנו "נשלחת" השיחה.
destinationstringכןהמספר המתקשר.
first_targetstringלאmaskyoo כדי להתקשר קודם למסקיו ולחבר ליעד (כולל החלפת greeting_in / greeting_out).
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
3011maskyoo ריק/לא תקין
3012לא ניתן לבצע שיחה עבור חשבון זה
3013היעד ברשימה שחורה
3014המסקיו לא פעיל
3015כשל בביצוע השיחה
3016המסקיו לא קיים

create_maskyoo_call_v2​

יזום שיחה עם שני צמדי מספרים – כל צד יוצג עם Caller ID שונה. בגרסה הזו אפשר להעביר פרמטרים מותאמים אישית שיישמרו על השיחה לצורך דיווח ופיקסל.

Endpoint: /api/?service=create_maskyoo_call_v2

פרמטרים​

פרמטרסוגחובהתיאור
maskyoo1 (או maskyoo)stringכןCaller ID לצד הראשון.
destination1stringכןהמספר שהשיחה יוצאת אליו.
maskyoo2stringלאCaller ID לצד השני (ברירת מחדל: כמו maskyoo1).
destination2stringכןהמספר שהצד הראשון יחובר אליו.
פרמטרים נוספיםstringלאכל פרמטר נוסף יישמר על השיחה ויהיה זמין בדוחות ובפיקסל.
formatstringלאjson / xml.

קודי שגיאה​

קודתיאור
3031maskyoo ריק/לא תקין
3032destination1 או destination2 ריקים/לא תקינים
3033 / 3038destination1 / destination2 ברשימה שחורה
3034 / 3037maskyoo1 / maskyoo2 לא פעילים
3035כשל בביצוע השיחה
3036maskyoo1 או maskyoo2 לא קיימים
3039מחוץ לשעות העבודה של אחד המספרים

יצירת קישור חתום שאפשר להטמיע באתר / בקמפיין. בגישה לקישור המערכת תיזום שיחה בהתאם להגדרות.

Endpoint: /api/?service=click2call_link

פרמטרים​

פרמטרסוגחובהתיאור
maskyoostringכןהמסקיו שיוצג ליעד.
destinationstringכןהיעד.
first_targetstringלאmaskyoo / destination (ברירת מחדל).
expire_daysintלאתוקף הקישור בימים (ברירת מחדל 365).
formatstringלאjson / xml.

תגובה​

ה-result מכיל את ה-URL הציבורי של הקישור שנוצר (עם חתימה ותאריך תפוגה).

קודי שגיאה​

קודתיאור
3017maskyoo ריק/לא תקין
3018destination ריק/לא תקין
3019המסקיו לא קיים
3020המסקיו לא פעיל
3021היעד ברשימה שחורה

test​

בדיקת זמינות ה-API. לא דורש פרמטרים נוספים, אך דורש IP + טוקן חוקיים.

Endpoint: /api/?service=test

מחזיר {"service":"test","status":{"code":200,"description":"OK"}}.

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

services של ניהול מסקיו משפיעים ישירות על ה‑DDI וכל הלוגיקה שתלויה בו:

  • ממשק ניהול מסקיו — יצירה/עדכון/שחרור/שחזור נראים מיד בעמוד ניהול המספרים ובכל הדוחות
  • חיוב — הקצאה (create_maskyoo) ושחרור/שחזור עשויים להשפיע על התעריף החודשי בהתאם לתוכנית המסחרית
  • רשימה שחורה — שחרור מספר מסיר אוטומטית חסימות ברמת אותו מסקיו; חסימות גלובליות נשמרות
  • Click2Call — click2call_link יוצר URL ציבורי חתום שאפשר להטמיע באתר/בקמפיין; פג תוקף לפי expire_days
  • שיחות ודוחות — create_maskyoo_call / create_maskyoo_call_v2 יוצרות שיחה חיה שנרשמת ב‑CDR עם כל הפרמטרים המותאמים ומשתתפת באוטומציה ובפיקסל
  • לוג שינויים — כל שינוי במספר מתועד ומוצג בלוג שינויים של המסקיו

ראו גם​