API - גישת מפתחים למערכות
-
קבלת מידע כללי על תיקיה (שלוחה)
הפקודה היא
GetIVR2DirStats
הפרמטרים הנדרשים
פרמטר תיאור הערות token טוקן חובה path נתיב תיקייה חובה. לדוגמה: /
עבור שלוחה ראשית.1
עבור שלוחה 1ext/1
עבור שלוחהext/1
מאפייני תגובת השרת
מאפיין סוג הסבר type string סוג השלוחה thisPath string נתיב תיקייה נוכחית parentPath string נתיב תיקיית אב dirsCount int כמות תיקיות בשלוחה filesCount int כמות קבצים בשלוחה contentFilesCount int כמות קבצי שמע בשלוחה minFile object מידע על קובץ השמע הנמוך בשלוחה maxFile object מידע על קובץ השמע הגבוה בשלוחה מאפייני קובץ שמגיעים באובייקטים
minFile
/maxFile
מאפיין סוג הסבר exists boolean האם התיקייה/קובץ קיימים name string שם התיקייה/קובץ uniqueId string מזהה ייחודי לתיקייה/קובץ what string נתיב תיקייה/קובץ fileType string סוג תיקייה/קובץ size int גודל קובץ (בבתים) mtime string תאריך שינוי אחרון duration אורך (בדקות) durationStr string אורך בפורמט mm:ss customerDid string מספר מערכת בה נוצר הקובץ meta string אובייקט המכיל מיגע נוסף על הקובץ date string זמן יצירת קובץ dd/mm/yyyy hh:mm source string מקור הקובץ phone string טלפון יוצר הקובץ ip string כתובת IP של מעלה הקובץ -
-
-
-
-
-
ניהול תור אונליין
שימו לב, ניהול התור אונליין אפשרי לשיחות ממתינות בתור בלבד.
את הממתינים בתור מקבלים בשירות GetQueueRealTime - לכל ממתין יש מזהה שיחה.
הפקודה היא -
QueueManagement
שימו לב, שירות זה מקבל מערך. לצורך זה ניתן לפנות אליו רק בPOST עם json בbody.
בכל פניה יש לצרף:
פרמטר תיאור סוג token טוקן string callIds מערך מזהי שיחות תור array action פעולה לביצוע string moreData הוראות נוספות - רשות string פעולות:
הוצאה מהתור - kick
הפעולה היא -
kick
הפרמטרים הנדרשים בנוסף
פרמטר תיאור סוג moreData ניתן לציין בפרמטר זה שלוחה להעברת המשתמש היוצא. הפרמטר רשות. כדי להעביר למשל לשלוחה 1 יש לציין: GOTO:/1
string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
status object סטטוס פעולות, באופן שהkey הוא מזהה השיחה והvalue הוא הסטטוס. דוגמא לתגובה מלאה:
{ "responseStatus": "OK", "yAfastVersion": "6.6.20", "status": { "805c3b221d4b76bb53769aac9e2c57c1": "Call not found", "f6657b78a2f35d6d04dd203400828362": "OK" } }
-
-
-
-
ניהול פרסומפון
הפקודה היא -
PirsumPhoneManagement
בכל פניה יש לצרף:
פרמטר תיאור סוג token טוקן string action פעולה לביצוע string פעולות:
קבלת סטטוס רישום לשירות - GetRegistrationStatus
הפעולה היא -
GetRegistrationStatus
מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
registrationStatus boolean האם רשום או לא true
רישום לשירות - Registration
הפעולה היא -
Registration
מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
results string הודעת הצלחה OK
הסרה מהשירות - UnRegistration
הפעולה היא -
UnRegistration
מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
results string הודעת הצלחה OK -
-
-
-
הפעלת קמפיין הנכנס לשלוחה במערכת
השירות מאפשר להפעיל קמפיין לרשימת מספרים - שבעת המענה לשיחה השיחה תיכנס למערכת לשלוחה מסויימת.
הפקודה היא -
CallExtensionBridging
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string phones רשימת מספרים. ראה להלן צורות תמיכה ברשימת מספרים string / json ivrPath שלוחה במערכת, למשל: ivr2:/1/100
- יכניס לשלוחה 1/100string callerId זיהוי שיחה יוצא, ברירת מחדל זיהוי של המערכת/רשימת התפוצה שנבחרה string callsTimeOut זמן חיוג מקסימלי - בשניות, ברירת מחדל 30 שניות, מקסימום 35 שניות. number תמיכה בצורת רשימת מספרים:
פרמטר phones יכול להכיל רשימת מספרים בדומה לשירות
RunTzintuk
:
כאשר הפניה היא בGET או בPOST שהוא לא (
Content-Type: application/json)
יש 3 אפשריות:- רשימה מפורשת עם הפרדה של
:
בין מספר למספר - מספרים מתוך רשימת תפוצה קיימת על ידי ציון
tpl:XX
כשאשר במקום הXX
יש לכתוב את מזהה רשימת התפוצה. - צינתוק לרשימת צינתוק חינמי (שימו לב הערה למטה בנוגע לאפשרויות שליחה לכמה רשימות צינתוקים חינמיים) על ידי ציון
tzl:XX
כאשר במקוםXX
יש לכתוב את מספר הרשימה במערכת.
כאשר הפניה היא json - ניתן גם לשלוח את רשימת המספרים כמערך:
{ "phones": [ "0510000", "0510001", "0510002", "0510003" ] }
או כמערך עם אובייקטים לצורך ציון זיהוי יוצא ספציפי לכל מספר:
{ "phones": [ { "phone": "0511111", "callerId": "077313" }, { "phone": "05111333", "callerId": "07731344" } ] }
או על אותו הדרך עם קבוצות:
"phones": [ { "phones": [ "0511111", "051111221" ], "callerId": "077313" }, { "phones": [ "0511111999" ], "callerId": "077414" } ]
חיוב יחידות:
על כל מספר שנכנס לחיוג יש חיוב של 0.1 יחידות,
על כל שיחה שנענת, יש חיוב של יחידה לדקה, עם מינמום חיוב של 0.5 יחידות.שימו לב, ניתן להפעיל בשירות זה קמפיין עם עד 500 מספרים.
מענה בעת הצלחה:
פרמטר סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
module string המודול של השלוחה שהשיחות יגיעו אילה menu callerId string זיהוי השיחה היוצאת 0770770770 callsCount int כמות מספרים שנכנסו לקמפיין 6 bilingPerCall int חיוב לכל שיחה (משוער) 1 errors object מערך של מספרים שלא נכנסות לחיוג ושגיאה { "0510001": "not Vaild", "0510002": "not Vaild", "0510003": "not Vaild" }
callsTimeout int זמן שיחה יוצאת כפי שנקלט 30 campaignId string מזהה קמפיין במערכת הקמפיינים YA-1-0770770770-Yemot-1695290243349441
- רשימה מפורשת עם הפרדה של
-
-
-
-
-
-
-
-
-