טכנוליין
טכנוליין  •  הקול בידיים שלך

מרכז התיעוד — מרכזיה

נקודת מבט מרכזית לכל ממשקי ה-API של המרכזיה — מודל ה-API שמניע שיחות, וה-API לאינטראקציה עם המערכת. בחר נושא להסבר מלא, או הורד את מדריך ה-AI להעצמת מודלי שפה.

2
סוגי API
6
מדריכי תיעוד
JSON
פורמט תקשורת
AI
מדריך מובנה
חשוב · עבודה עם AI

בונה אינטגרציה עם עזרת מודל שפה (AI)?

כדי שהמודל יידע בדיוק איך לעבוד עם המרכזיה — תן לו את הקובץ PBX_DOCUMENTATION_CENTER.md בתחילת השיחה. הקובץ כתוב באנגלית (ליעילות טוקנים) ומסביר את שני סוגי ה-API, את ההפרדה בין "המוח" שלך לבין "הטלפון" של המרכזיה, את כללי האימות, פורמט התגובות, ומפנה לקבצי התיעוד המפורטים של כל ממשק.

איך משתמשים? פותחים שיחה חדשה עם ה-AI, מצרפים את הלינק או את תוכן הקובץ, ואומרים: "אני רוצה לבנות X על המרכזיה". המודל יידע אילו endpoints לבחור, איך לאמת, ומתי להפנות אותך למסמך הספציפי לפעולה.

קישור מלא להעתקה:
https://app.ipsales.co.il/PBX_DOCUMENTATION_CENTER.md
הורדת המדריך (MD) פתיחה בדפדפן

שני סוגי ה-API — חשוב להבין את ההבדל

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

1

מודל API (Module API)

PBX  →  Your Server

המרכזיה מדברת אל השרת שלך. כשמתקשר נכנס לשלוחה, המרכזיה שולחת בקשה לכתובת ה-URL שהגדרת — והשרת שלך מחזיר JSON עם הוראות מה לעשות (להשמיע הודעה, לקבל DTMF, להקליט, לנתב, לסלק אשראי וכו').

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

ללא apiKey · המזהה הוא כתובת ה-URL עצמה
2

API לאינטראקציה (Interaction API)

Your Server  →  PBX

השרת שלך מדבר אל המרכזיה. אתה יוזם פעולות — להפעיל קמפיין יוצא, לערוך שלוחה, לטעון קובץ שמע, להפעיל שיחת אימות. הבקשה נשלחת לאנדפוינטים של המערכת, מאומתת ב-API Key, ולעיתים גם ברשימת IP מאושרים.

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

דורש apiKey · לעיתים גם אישור IP מראש
טיפ פרקטי: כשבונים פתרון מלא — בד"כ משתמשים בשני סוגי ה-API. משתמשים ב-Interaction API כדי להזין רשימת מספרים ולהפעיל קמפיין יוצא, וב-Module API כדי לקבוע מה יקרה כשמישהו עונה (תפריט, ניתוב, הודעה).

בחירת נושא

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

מודל API PBX → השרת שלך

Module API

מדריך API מרכזיה

apiModuleDocs.html

הסבר על דפוס "מרכזיה שואלת — שרת עונה ב-JSON". מתעד 12 מודולים: הודעה פשוטה, תפריט, קבלת DTMF, הקלטה, תמלול קולי, ניתוב טלפוני / IP, נגן מדיה, מעבר לשלוחה, ניתוק, השמעת קמפיינים וסליקת אשראי. כולל פרמטרים קבועים, קבצי שמע ושרשור פקודות.

JSON Modules Call Flow DTMF הקלטה סליקה
פתיחת התיעוד MD

API לאינטראקציה השרת שלך → PBX

Interaction API

API קמפיינים

campaignApiDocs.html

שיגור ושליטה בקמפיינים קוליים יוצאים — הפעלה עם רשימת טלפונים, היסטוריית קמפיינים, דוחות מלאים, הגבלת קצב חיוג (maxring), השהיה / חידוש / עצירה ופעולות מקשים בזמן אמת.

שיחות יוצאות היסטוריה דוחות maxring hold/resume
פתיחת התיעוד MD
Interaction API

API ניהול שלוחות

ivrExtensionsApiDocs.html

בנייה וניהול של עץ השלוחות במלואו — Bootstrap סכמת UI, עץ שלוחות, ניהול קבצים והקלטות, הגדרות שלוחה (כל הסוגים), הרשאות גישה, הודעות מערכת, ו-Dropdowns דינמיים.

עץ שלוחות Schema קבצי שמע הרשאות Forms
פתיחת התיעוד MD
Interaction API

API שיחת אימות

makeCallApiDocs.html

הפעלת שיחה יוצאת קצרה עם Caller ID מותאם — לאימות דו-שלבי (2FA), קוד חד-פעמי בזיהוי המתקשר, או כל שימוש שדורש העברת ספרות בלי לדבר. השיחה מתנתקת מיד עם המענה.

2FA Caller ID OTP Rate Limit IP Whitelist
פתיחת התיעוד
Interaction API

API Click‑to‑Call

click2callApiDocs.html

חיוג בלחיצה מתוך ה‑CRM — שלוחת הסוכן מצלצלת ראשונה, וכשמרים מחוברת ליעד. תומך במספרים ישראליים, שלוחות פנימיות 100–999 ומספרי תצוגה 099088XXXX. כולל שם תצוגה למסך הטלפון ו‑‎ringSec.

Click‑to‑Call חיוג מ‑CRM שלוחה ↔ יעד targetName ringSec
פתיחת התיעוד MD
Interaction API

API רשימות תפוצה

mailingListsApiDocs.html

ניהול אנשי קשר ברשימות תפוצה — ייבוא בכמות (add / replace / insert / delete), שליפה עם חיפוש ופייג'ינג, עריכה / הוספה של איש קשר בודד, חסימה ושחרור, ומחיקה. הרשימות משמשות לקמפיינים טלפוניים יוצאים, שליחת הודעות והקראות IVR.

ייבוא חיפוש חסימה opt‑out קמפיינים
פתיחת התיעוד MD

אימות וכתובת IP

מודל API — אין צורך ב-apiKey

ב-מודל API המרכזיה היא זו שיוזמת את הבקשה לשרת שלך. המזהה הוא כתובת ה-URL שהזנת בהגדרת השלוחה — אין מפתח שצריך לשלוח. הוודא שהשרת שלך:

API לאינטראקציה — apiKey חובה

כל הבקשות ל-API לאינטראקציה חייבות לכלול apiKey. המפתח מזהה את חשבון הלקוח ואת ההרשאות שלו. יש לטפל בו כסיסמה — לא לשמור בקוד דפדפן ציבורי.

מיקום דוגמה
Query string ?apiKey=YOUR_API_KEY&...
גוף POST (json) { "apiKey": "YOUR_API_KEY", ... }
גוף POST (form-urlencoded) apiKey=YOUR_API_KEY&...
אישור IP מראש (חובה ב-Campaign / makeCall): בקשות ל-campaignApi.php ו-makeCall חייבות להגיע מכתובת IP מאושרת מראש מול הצוות הטכני של טכנוליין. בקשה מ-IP לא מאושר נדחית מיד עם Access denied / HTTP 400. כל IP מאושר בנפרד — אין הרשאה כללית.

מוסכמות משותפות

נושא אנדפוינט שיטת בחירת פעולה שיטה
Module API הכתובת של השרת שלך המרכזיה שולחת GET עם פרמטרי שיחה. השרת שלך מחזיר JSON עם type מבין 12 המודולים. GET
קמפיינים campaignApi.php פרמטר action=<name> (לדוגמה action=campaignRun). multipart לשליחת קבצים. POST
ניהול שלוחות ivrFilesApi.php פרמטר action=<name>. רוב הפעולות GET / form-urlencoded; uploadFile = multipart, saveCustomMessagesBeta = JSON. GET / POST
שיחת אימות ivrFilesApi.php פרמטר action=makeCall + phone + cid (6 ספרות). GET / POST
Click‑to‑Call ivrFilesApi.php פרמטר action=click2call + extension + target (אופציונלי targetName, ringSec). GET / POST
רשימות תפוצה mailingListsApi.php פרמטר action=<name> — ייבוא, שליפה, עריכה, חסימה ומחיקה. תומך ב-form / JSON / multipart. POST

מבנה תגובת JSON אופייני

{ "status": "OK" } { "status": "OK", "note": "...", "data": { ... } } { "status": "ERROR", "note": "תיאור השגיאה" }

פורמט מודול לדוגמה (Module API)

{ "type": "simpleMenu", "fileName": "menu_main", "max_digits": 1, "min_digits": 1, "tries": 3, "timeout": 5 }
שימו לב: Module API מצפה ל-JSON מהשרת שלך — לא לטקסט חופשי, לא ל-XML. אם החזרת JSON שאינו תואם לאחד מ-12 המודולים, המרכזיה תפיל את המתקשר חזרה לתפריט הקודם.