API לבדיקת יתרת הודעות קוליות בחשבון
ממשק בדיקת יתרת ההודעות הקוליות של מיקרופיי מאפשר לבדוק כמה הודעות קוליות נותרו בחשבון, לשליחה בישראל. הבדיקה מתבצעת על אותו ממשק השליחה
(scheduleVms.php) עם הפרמטר act=credit, והמערכת מחזירה מספר עם היתרה. הפנייה מתבצעת ב-HTTPS, ב-GET/POST או JSON, ומאומתת באמצעות טוקן עם הרשאת שירותי טלפוניה.
סקירת הממשק
ממשק זה מאפשר לבדוק את יתרת ההודעות הקוליות בחשבון. ניתן לבדוק רק את יתרת ההודעות לשליחה בישראל. הבדיקה מתבצעת על כתובת ממשק שליחת ההודעות הקוליות,
scheduleVms.php, עם הפרמטר act=credit.
התשובה היא מספר ההודעות הקוליות שניתן לשלוח, ולא סכום כספי. המספר מחושב לפי אורך ההודעה הקולית המוגדר בחשבון, ולכן הוא משקף את מספר ההודעות בפועל. אם בחשבון מוגדרת גם יתרת אשראי (תשלום בדיעבד), היא נכללת בחישוב.
לבדיקת יתרת הודעות הסמס ראו את העמוד בדיקת יתרת סמס.
כתובת הממשק ושיטת השליחה
הכתובת לבדיקת היתרה היא:
https://www.micropay.co.il/extApi/scheduleVms.php
יש לשלוח את כל שמות הפרמטרים באותיות קטנות (Lower Case). ניתן להעביר את הפרמטרים בשיטת GET או POST, או לשלוח אותם בגוף הבקשה בפורמט JSON.
אימות וטוקן
הבקשה דורשת פרמטר token, טוקן שיצרת במערכת עם הרשאת שירותי טלפוניה.
פרמטרים
| פרמטר | חובה | תיאור |
|---|---|---|
token | חובה | טוקן הזדהות שיצרת במערכת, עם הרשאת שירותי טלפוניה. |
act | חובה | יש לשלוח עם הערך credit כדי לבצע בדיקת יתרה. |
get / post | חובה | מציין למערכת באיזו שיטה נשלחו הפרמטרים. יש לשלוח אחד מהם בלבד: get=1 בשליחת GET, או post=2 בשליחת POST. הפרמטר אינו משנה את שיטת השליחה בפועל, אלא רק מצהיר עליה. (בפורמט JSON אין צורך בפרמטר זה.) |
דוגמאות קוד
curl "https://www.micropay.co.il/extApi/scheduleVms.php?get=1&token=XXXXX&act=credit"curl -X POST https://www.micropay.co.il/extApi/scheduleVms.php \ -H "Content-Type: application/json" \ -d '{"token":"XXXXX","act":"credit"}'
Content-Type: application/json, כפי שמופיע בדוגמאות.
אם אינך יכול לקבוע כותרות בבקשה, תוכל במקום זאת להוסיף json=1 בכתובת ה-URL ולשלוח את גוף ה-JSON ב-POST.
תשובת השרת
בקריאה רגילה המערכת מחזירה מספר עם יתרת ההודעות הקוליות. במצב JSON, message הוא OK, היתרה נמצאת בשדה data.credit (מספר), ושדה action הוא credit. data כולל תמיד את remoteIP.
תשובה רגילה (טקסט)
# יתרת ההודעות הקוליות 4000 # שגיאה ERROR --> Description: token parameter, invalid or missing
תשובה ב-JSON
// היתרה ב-data.credit {"status":1,"action":"credit","message":"OK","data":{"credit":4000,"remoteIP":"203.0.113.10"}} // שגיאת פרמטר {"status":0,"action":"credit","message":"ERROR","data":{"description":"token parameter, invalid or missing","remoteIP":"203.0.113.10"}}
טבלת קודי תשובה
| ערך | status ב-JSON | משמעות |
|---|---|---|
| מספר | 1 | יתרת ההודעות הקוליות בחשבון. בטקסט מוחזר המספר עצמו; ב-JSON היתרה ב-data.credit ו-message הוא OK. |
ERROR | 0 | שגיאה באחד הפרמטרים, למשל טוקן ללא הרשאת שירותי טלפוניה. בטקסט מופיע רווח ותיאור; ב-JSON התיאור נמצא ב-data.description. |
שאלות נפוצות
איך בודקים את יתרת ההודעות הקוליות בחשבון?
פונים לכתובת scheduleVms.php עם טוקן בעל הרשאת שירותי טלפוניה והפרמטר act=credit. המערכת מחזירה את מספר ההודעות הקוליות שניתן לשלוח; במצב JSON היתרה בשדה data.credit.
איזו יתרה הממשק מחזיר?
הממשק מחזיר את מספר ההודעות הקוליות שניתן לשלוח בישראל, ולא סכום כספי. המספר מחושב לפי אורך ההודעה הקולית המוגדר בחשבון. אם בחשבון מוגדרת גם יתרת אשראי (תשלום בדיעבד), היא נכללת בחישוב.
איך בודקים את יתרת ההודעות הקוליות של תת מנהל?
שולחים טוקן המשויך לתת המנהל, והמערכת מחזירה את יתרת ההודעות הקוליות של אותו תת מנהל.