הבדלים בין גרסאות בדף "API"
מתוך wiki.voipe.co.il
(יצירת דף עם התוכן "קישור למסמך ה-API שלנו: https://docs.google.com/document/d/10Vkge7uh-GeYiwyFlwaqXbxEoel6ciG2fXKgIsAy8P8/edit?usp=sharing <br/> כדי לגשת ל...") |
|||
| (2 גרסאות ביניים של אותו משתמש אינן מוצגות) | |||
| שורה 1: | שורה 1: | ||
| − | קישור למסמך ה-API שלנו: https://docs.google.com/document/d/10Vkge7uh-GeYiwyFlwaqXbxEoel6ciG2fXKgIsAy8P8/edit?usp=sharing | + | קישור למסמך ה-API שלנו: https://docs.google.com/document/d/10Vkge7uh-GeYiwyFlwaqXbxEoel6ciG2fXKgIsAy8P8/edit?usp=sharing <br> |
כדי לגשת לAPI יש צורך ב- API token, אשר נוצר בכניסה הראשונית לדף API בפאנל הניהול (הדף זמין רק למשתמשי אדמין).<br/> | כדי לגשת לAPI יש צורך ב- API token, אשר נוצר בכניסה הראשונית לדף API בפאנל הניהול (הדף זמין רק למשתמשי אדמין).<br/> | ||
ניתן ליצור token חדש באמצעות לחיצה על הכפתור "regenerate". | ניתן ליצור token חדש באמצעות לחיצה על הכפתור "regenerate". | ||
| שורה 21: | שורה 21: | ||
* did- חיפוש לפי מספר did. | * did- חיפוש לפי מספר did. | ||
* raw- החזרת כל הרשומות מטבלת הCDR, ללא סינון לפי recordingfilename. <br/> הערך חייב להיות "1" או "true". | * raw- החזרת כל הרשומות מטבלת הCDR, ללא סינון לפי recordingfilename. <br/> הערך חייב להיות "1" או "true". | ||
| − | * from_date- בתבנית .YYYY-MM-DD | + | * from_date- בתבנית YYYY-MM-DD. לסינון גם לפי שעות ניתן להשתמש בתבנית YYYY-MM-DD HH:MM:SS. |
| − | * to_date- בתבנית YYYY-MM-DD. | + | * to_date- בתבנית YYYY-MM-DD. לסינון גם לפי שעות ניתן להשתמש בתבנית YYYY-MM-DD HH:MM:SS. |
* limit- מספר הרשומות שיש למשוך מהמסד הנתונים. הערך המקסימלי הוא 10000. <br/> ערכים גדולים יותר יומרו ל10000. | * limit- מספר הרשומות שיש למשוך מהמסד הנתונים. הערך המקסימלי הוא 10000. <br/> ערכים גדולים יותר יומרו ל10000. | ||
* offset- | * offset- | ||
| שורה 47: | שורה 47: | ||
* status- בדרך כלל "נענה"/ "אין תשובה". | * status- בדרך כלל "נענה"/ "אין תשובה". | ||
* recordingfilename- קישור להורדת קובץ הקלטה. השדה יכול להיות ריק אם אין קובץ הקלטה. | * recordingfilename- קישור להורדת קובץ הקלטה. השדה יכול להיות ריק אם אין קובץ הקלטה. | ||
| + | * uniqueid- מזהה שיחה ייחודי | ||
גרסה אחרונה מ־11:02, 27 באוקטובר 2021
קישור למסמך ה-API שלנו: https://docs.google.com/document/d/10Vkge7uh-GeYiwyFlwaqXbxEoel6ciG2fXKgIsAy8P8/edit?usp=sharing
כדי לגשת לAPI יש צורך ב- API token, אשר נוצר בכניסה הראשונית לדף API בפאנל הניהול (הדף זמין רק למשתמשי אדמין).
ניתן ליצור token חדש באמצעות לחיצה על הכפתור "regenerate".
אימות
האימות בAPI מתבצע באמצעות שם משתמש וסיסמה באופן הבא:
שם משתמש- ה API token שנוצר בפאנל הניהול.
סיסמא- המחרוזת “api_token”.
קודי סטטוסים אפשריים
- 401- לא מאומת. הקוד הזה מוחזר כשמתבצע שימוש ב-API token שגוי.
- 503- שירות לא זמין. מצביע של בעיה פנימית. ניתן להמתין מעט ולנסות שוב.
במידה והשגיאה חוזרת על עצמה, ניתן לפנות לתמיכה שלנו.
פרמטרים זמינים (לסינון הרשומות)
ניתן לשלוח את הפרמטרים הבאים במחרוזת הGET, כדי לבצע סינון בכל התוצאות:
- status- סינון שיחות לפי סטטוס השיחה (נענה, לא נענה וכו').
- direction- יוצאת, נכנסת (יש שיחות שאין להן את השדה כיוון).
- num- חיפוש לפי מספר טלפון.
- did- חיפוש לפי מספר did.
- raw- החזרת כל הרשומות מטבלת הCDR, ללא סינון לפי recordingfilename.
הערך חייב להיות "1" או "true". - from_date- בתבנית YYYY-MM-DD. לסינון גם לפי שעות ניתן להשתמש בתבנית YYYY-MM-DD HH:MM:SS.
- to_date- בתבנית YYYY-MM-DD. לסינון גם לפי שעות ניתן להשתמש בתבנית YYYY-MM-DD HH:MM:SS.
- limit- מספר הרשומות שיש למשוך מהמסד הנתונים. הערך המקסימלי הוא 10000.
ערכים גדולים יותר יומרו ל10000. - offset-
ערכי ברירת מחדל עבור המסננים
- from_date- התאריך הנוכחי.
- to_date- התאריך הנוכחי.
- limit- הערך 1000.
- offset- הערך 0.
המידע המוחזר
הAPI יחזיר אובייקט מסוג JSON הכולל את הפרמטרים הבאים:
- recordsTotal- יכיל את המספר הכולל של הרשומות שנמצאו בהתאם לסינון.
- recordsFiltered- לעת עתה, יכיל את אותו הערך כמו recordsTotal.
- data- יכיל מערך של רשומות.
כל אובייקט במערך data יכיל את השדות הבאים:
- src- מספר המקור.
- direction- כיוון (נכנס, יוצא או ריק).
- dst- מספר היעד.
- did- מספר הdid.
- duration- משך השיחה בשניות.
- calldate- בתבנית “YYYY-MM-DD HH:MM:SS”.
- status- בדרך כלל "נענה"/ "אין תשובה".
- recordingfilename- קישור להורדת קובץ הקלטה. השדה יכול להיות ריק אם אין קובץ הקלטה.
- uniqueid- מזהה שיחה ייחודי
