תיעוד API
מדריך מקיף לשימוש ב-API של Voipe לגישה לנתוני שיחות, הקלטות ואינטגרציה עם מערכות חיצוניות
סקירה כללית
ה-API של Voipe מאפשר גישה לנתוני שיחות, הקלטות ואינטגרציה עם מערכות חיצוניות. באמצעות ה-API ניתן לשלוף מידע על שיחות נכנסות ויוצאות, לסנן לפי תאריכים וסטטוסים, ולבנות אינטגרציות מותאמות אישית עם מערכות CRM, BI ועוד.
יצירת טוקן
ניתן ליצור טוקן API דרך פאנל הניהול. לאחר יצירת הטוקן, ניתן לחדש אותו בכל עת באמצעות לחצן "חדש טוקן".
לצורך אימות, יש להשתמש בטוקן בתור שם משתמש (Username) ובמחרוזת api_token בתור סיסמה (Password).
אימות (Authentication)
האימות מתבצע באמצעות Basic Authentication. יש לשלוח את הטוקן מקודד ב-Base64 בפורמט token:api_token בכותרת Authorization.
$token = 'YOUR_API_TOKEN'; $auth = base64_encode($token . ':api_token'); $headers = ['Authorization: Basic ' . $auth];
קודי סטטוס
ה-API מחזיר את קודי הסטטוס הבאים:
| קוד | תיאור |
|---|---|
| 401 | אימות נכשל — טוקן שגוי או חסר |
| 503 | שירות אינו זמין |
פרמטרי סינון
ניתן לסנן את תוצאות ה-API באמצעות הפרמטרים הבאים:
| פרמטר | תיאור | ברירת מחדל |
|---|---|---|
| status | סטטוס השיחה | — |
| direction | כיוון השיחה (נכנסת/יוצאת) | — |
| num | מספר טלפון | — |
| did | מספר DID | — |
| raw | נתונים גולמיים | — |
| from_date | תאריך התחלה (YYYY-MM-DD) | — |
| to_date | תאריך סיום (YYYY-MM-DD) | — |
| limit | מספר תוצאות מקסימלי (עד 10000) | 1000 |
| offset | נקודת התחלה לדפדוף | 0 |
מבנה התשובה
התשובה מוחזרת בפורמט JSON ומכילה את השדות הבאים:
recordsTotal— סך כל הרשומותrecordsFiltered— מספר הרשומות המסוננותdata— מערך של רשומות שיחה
שדות רשומת שיחה
| שדה | תיאור |
|---|---|
| src | מספר מקור |
| direction | כיוון השיחה |
| dst | מספר יעד |
| did | מספר DID |
| duration | משך השיחה בשניות |
| calldate | תאריך ושעת השיחה |
| status | סטטוס השיחה |
| recordingfilename | שם קובץ ההקלטה |
| uniqueid | מזהה ייחודי של השיחה |