מילון מונחים

מילון המונחים מרכז הסבר קצר וברור לכל המונחים שבהם משתמש התיעוד הטכני של מיקרופיי, ממונחי ה-API הבסיסיים (טוקן, GET/POST, JSON) ועד מונחי השליחה והאימות (זיהוי שולח, קמפיין, OTP, Webhook, DLR ועוד). השתמשו בו כעוגן מהיר תוך כדי קריאת עמודי הממשקים.

מונחי בסיס

API

ממשק תכנות יישומים. מאפשר למערכות חיצוניות (אתר, מערכת CRM, אפליקציה) לתקשר עם מיקרופיי באמצעות קריאות HTTPS.

Endpoint (כתובת ממשק)

כתובת ה-URL של ממשק ספציפי, תחת /extApi/, לדוגמה scheduleSms.php.

טוקן (Token)

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

הרשאה (Permission)

קבוצת השירותים שטוקן רשאי לגשת אליה: שירותי סמס, שירותי טלפוניה, רשימות תפוצה, ניהול תת מנהלים, שירותי וואטסאפ או אוטומציות.

GET / POST

שיטות שליחה של HTTP. GET מעביר את הפרמטרים בכתובת ה-URL, POST בגוף הבקשה. במיקרופיי מצהירים על השיטה בפרמטר get=1 או post=2.

JSON

פורמט להחלפת נתונים מובְנים. מיקרופיי תומכת בשליחה וקבלה ב-JSON במבנה אחיד. ראו מוסכמות ופורמט תשובה.

מעטפת התשובה (status, message, data)

המבנה האחיד של תשובת JSON: status דגל הצלחה מספרי, message קוד התוצאה, data נתונים נוספים לפי הממשק.

url encoding

קידוד תווים מיוחדים (רווחים, סימנים) בשליחה רגילה בפורמט GET או form-urlencoded. בשליחת JSON או multipart אין צורך בו. ראו אפשרויות שליחה וקידוד.

UTF-8

קידוד תווים התומך בעברית ובאימוג'ים. מומלץ בכל שליחה, וחובה במצב JSON.

ערוצי שליחה

סמס (SMS)

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

הודעה קולית (VMS)

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

וואטסאפ (WhatsApp Business)

שליחת הודעות בערוץ וואטסאפ באמצעות תבניות מאושרות.

WABA

WhatsApp Business Account, החשבון העסקי בוואטסאפ שאליו משויכים מספרי השליחה והמכסות היומיות.

תבנית (Template)

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

IVR

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

מונחי שליחה

קמפיין (Campaign)

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

קוד קמפיין (taskId)

מזהה ייחודי שמוקצה לכל שליחה ומוחזר בתשובה (בטקסט אחרי OK, ב-JSON תחת data.taskId).

רשימת תפוצה (Pool)

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

זיהוי שולח (Sender ID)

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

תזמון (Scheduling)

קביעת מועד עתידי לשליחה, באמצעות פרמטרי התאריך והשעה (dh, di, dy, dm, dd).

פרמטרים דינמיים

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

listjson

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

validate

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

אימות וקוד חד-פעמי

OTP

סיסמה חד-פעמית (One-Time Password), קוד אימות זמני לשימוש בודד. ראו OTP וקוד אימות.

אימות דו-שלבי (2FA)

Two-Factor Authentication, שכבת אבטחה נוספת מעבר לסיסמה, לרוב באמצעות קוד OTP.

precode

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

WebOTP

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

Webhooks

Webhook

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

DLR

חיווי מסירה (Delivery Report), עדכון על סטטוס מסירת ההודעה למכשיר הלקוח (נמסר, נכשל וכו').

סמס נכנס (MO)

Mobile Originated, הודעת סמס שהלקוח שולח אליך, ומועברת לעמוד בשרת שלך.

מונחים כלליים

תת מנהל (Sub-user)

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

יתרה (Credit)

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

remoteIP

כתובת ה-IP של הקורא, המוחזרת בכל תשובת JSON תחת data.

Zapier

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

המשך