API - גישת מפתחים למערכות
-
מחיקת כל המספרים מרשימת התפוצה
הפקודה היא -
ClearTemplateEntries
הפרמטרים הנדרשים
פרמטר תיאור token טוקן templateId מזהה תבנית אין מאפיינים מיוחדים בתגובת השרת
-
העלאת קובץ טקסט והפיכתו לרשימת טלפונים לתבנית קמפיין
הפקודה היא -UploadPhoneList
הפרמטרים הנדרשים:פרמטר תיאור הערות token טוקן חובה templateId מזהה תבנית חובה data קובץ רשימת הטלפונים כמחרוזת חובה nameColumns מספר העמודות של 'שם'. כל עמודות הטקסט האחרות עוברות ל'מידע נוסף ' ברירת מחדל 1 defaultPrefix קידומת מספר ברירת מחדל למספרים בני 7 ספרות.הערכים המותרים הם: 02,03,04,08,09,077,072,073. רשות delimiter תו המפריד בין עמודות (עבור עמודות המופרדים ב טאב כיתבו "TAB" ברירת מחדל "," updateType מגדיר את סוג העדכון: UPDATE = עדכן רשומות קיימות והוסף חדשות, NEW = הסר את כל הרשומות הקיימות והוסף חדש, REMOVE = הסר רשומות ברירת מחדל UPDATE blocked 1 = יקבע את סטטוס הרשומות שהועלה ל'חסום '. ברירת מחדל 0 כלומר לא מגדיר כחסום אם ניתוח הקבצים נכשל בגלל פורמט לא מזוהה, יחזיר תגובה עם הודעה = "bad_format".
מאפייני תגובת השרת
מאפיין סוג הסבר message string "ok" - פירושו שההעלאה עובדה כהלכה templateId int מזהה התבנית שעודכן totalParsed int המספר הכולל של מספרים שהתקבלו rejectedRecords Array מערך המתאר את הרשומות שנדחו (ראה להלן פירוט) totalInserted int המספר הכולל של מספרים שהוכנסו בהצלחה totalUpdated int המספר הכולל של המספרים שעודכנו totalRemoved int המספר הכולל של המספרים שהוסרו אם מספרים מסוימים נדחו משום מה,
rejectedRecords
יכיל מערך של אובייקטים בפורמט הבא:מאפיין סוג הסבר phone string מספר הטלפון name string עמודת שם moreinfo string עמודת מידע נוסף blocked bool סטטוס חסום errorState enum DUPLICATE
= המספר כפול,INVALID
= המספר לא חוקי (אסור בקמפיינים)originalRowNumber int מספר השורה בו זוהתה השגיאה -
הפעלת קמפיין
הפקודה היא-RunCampaign
הערה-פקודה זו יוצרת קמפיין המבוסס על אחד מתבניות הקמפיין של הלקוח ואם הכל כראוי הקמפיין מופעל וכחלק מתגובת השרת תקבלוcampaignId
שעם זה תוכלו לעקוב אחרי סטטוס הקמפיין וכן להוציא דוח על הקמפיין ועוד.הפרמטרים הנדרשים
פרמטר תיאור הערות token טוקן חובה templateId מזהה תבנית חובה phones רשימת טלפונים חלופית לשליחת ההודעה, כאשר המספרים מופרדים ב :
רשות callerId זיהוי יוצא רשות -
מצב הקמפיין-GetCampaignStatus
-
הורדת דו"ח קמפיין-DownloadCampaignReport
-
קבלת קמפיינים פעילים-GetActiveCampaigns
-
ביצוע פעולות בקמפיינים פעילים-CampaignAction
-
יצירת קמפיין מתוזמן
הפקודה היא -ScheduleCampaign
הפרמטרים הנדרשים
פרמטר אפשרויות תיאור/הערות/פירוט token טוקן templateId מספר מזהה של הקמפיין time הגדרת זמן הפעלה באחד מהצורות הבאות (תאריך לועזי בלבד) אופציה 1 yyyy-MM-dd-HH:mm:ss שנה -חודש - יום-שעה:דקה:שניה אופציה 2 yyyy-MM-dd-HH:mm שנה -חודש - יום-שעה:דקה אופציה 3 yyyy-MM-dd HH:mm:ss שנה -חודש - יום שעה:דקה:שניה(בין היום לשעה רווח במקום -
)אופציה 4 yyyy-MM-dd שנה -חודש-יום אופציה 5 HH:mm:ss שעה:דקה:שניה אופציה 6 HH:mm שעה:דקה -
קבלת קמפיינים מתוזמנים-
הפקודה היא -
GetScheduledCampaigns
הפרמטרים הנדרשים:
פרמטר תיאור/הערות token טוקן type סוג הקמפיינים להחזרה. האפשרויות הם PENDING
קמפיינים המיועדים לביצוע.SUCCESSFUL
קמפיינים שבוצעו בהצלחה.FAILED
קמפיינים שנכשלו.order סדר המיון. האפשרויות הם: asc
(ברירת מחדל) - סדר עולה.desc
- סדר יורדfrom אופציונלי - maximum number of records to include limit אופציונלי - מקסימום של קמפיינים להחזרה -
מחיקת קמפיין מתוזמן-DeleteScheduledCampaign
-
הצגת תוכן שלוחה (תיקייה)
הפקודה היא
GetIVR2Dir
הפרמטרים הנדרשים
פרמטר תיאור הערות token טוקן חובה path נתיב תיקייה חובה. לדוגמה: /
עבור שלוחה ראשית.1
עבור שלוחה 1ext/1
עבור שלוחהext/1
filesFrom הצג קבצים מ רשות. 0
יציג מהקובץ הראשון1
יציג מהקובץ השני וכן הלאה. ברירת מחדל מציג מהקובץ הראשון.filesLimit הצג קבצים עד רשות. לדוגמה, 5
יציג את הקובץ החמישי (כולל). ברירת מחדל מציג עד הקובץ האחרוןorderBy מיין קבצים לפי ראה להלן "ערכים אפשריים לפרמטר orderBy" orderDir סדר קבצים asc
- סדר עולה.desc
- סדר יורד.ערכים אפשריים לפרמטר orderBy
ערך תיאור name שם קובץ (ברירת מחדל) date תאריך יצירה mtime תאריך שינוי אחרון customerdid מספר מערכת uploader מעלה הקובץ size גודל source מקור
מאפייני תגובת השרת
מאפיין סוג הסבר extIni object אובייקט הכולל את הגדרות השלוחה thisPath string נתיב תיקייה נוכחית parentPath string נתיב תיקיית אב dirs Array מערך הכולל את התיקיות והשלוחות שבתיקייה הנוכחית files Array מערך הכולל את הקבצים שבתיקייה הנוכחית (מלבד קבצי ini ו-html שנמצאים במערך נפרד) ini Array מערך הכולל את קבצי ההגדרות (ini) שבשלוחה messages Array מערך הכולל את הודעות המערכת הקשורות לשלוחה html Array מערך הכולל את קבצי הדוחות (html) שבשלוחה msgDescriptions object אובייקט הכולל את התיאור של כל הודעות המערכת בשלוחה (למשל M0000=הודעת ברוכים הבאים
)מאפיינים משותפים לאובייקטים במערכים "dirs" "files" "ini" "messages" "html"
מאפיין סוג הסבר exists boolean האם התיקייה/קובץ קיימים name string שם התיקייה/קובץ uniqueId string מזהה ייחודי לתיקייה/קובץ what string נתיב תיקייה/קובץ fileType string סוג תיקייה/קובץ מאפיינים משותפים לאובייקטים במערכים "files" "ini" "messages" "html"
מאפיין סוג הסבר size int גודל קובץ (בבתים) mtime string תאריך שינוי אחרון מאפיינים משותפים לאובייקטים במערכים "files" "messages"
הערה: המאפיינים הבאים הינם עבור קבצי שמע בלבדמאפיין סוג הסבר duration אורך (בדקות) durationStr string אורך בפורמט mm:ss customerDid string מספר מערכת בה נוצר הקובץ meta string אובייקט המכיל מידע נוסף על הקובץ date string זמן יצירת קובץ dd/mm/yyyy hh:mm source string מקור הקובץ phone string טלפון יוצר הקובץ ip string כתובת IP של מעלה הקובץ מאפייני אובייקטים במערך dirs
הערה: המאפיינים הבאים הינם עבור תיקיות המוגדרות כשלוחה ולא עבור תיקיות רגילותמאפיין סוג הסבר extType string סוג שלוחה extTitle string תיאור שלוחה -
קבלת רשימת קבצים שבשלוחה-GetIvrTree
-
ניהול תיקיות וקבצים
הפקודה היא
FileAction
הפרמטרים הנדרשים
פרמטר תיאור הערה token טוקן action סוג הפעולה לביצוע ראה להלן what נתיב ראה להלן target יעד ראה להלן בפרמטר
action
האפשרויות הקיימות הן:copy
- העתקהmove
- העברה (לשינוי שם של שלוחה או קובץ יש להשתמש בהעברה)delete
- מחיקה
בפרמטר
what
האפשרויות הקיימות הן:- ניהול קובץ בודד או שלוחה בודדת.
- ניהול קבצים מרובים כאשר בפרמטר
what
יש לציין כל קובץ או שלוחה בנפרד. לדוגמה: - ניהול קובץ בתבנית קמפיין. ראה כאן
${url}FileAction?token=${token}&action=${action}&what0=ivr2:1&what1=ivr2:2/ext.ini
בדוגמה: ניהול שלוחה 1 וניהול קובץ ext.ini שבשלוחה 2.
בפעולה מסוג העברה או העתקה חובה לציין פרמטר
target
. האפשרויות הקיימות הן:- בניהול קבצים מרובים או שלוחות מרובות יש לציין את נתיב היעד הרצוי. לדוגמה, במידה והיעד הוא שלוחה 1 יש לציין את הנתיב כך
target=ivr2:1
.
הערה: שימו לב! השם המקורי נשמר. במידה ומדובר בהעברת או העתקת קבצים עם שם בעל מספר סידורי שמות הקבצים ישתנו בהתאם לשמות הקבצים בשלוחת היעד. (לדוגמה, אם בוצעה העתקה של קובץ 001 משלוחה 2 לשלוחה 1 ששם קיים קובץ בשם 050 אז השם של הקובץ שהועתק ישתנה ל-051). - בניהול קובץ בודד או שלוחה בודדת ניתן גם לציין נתיב מלא כולל השם הרצוי ביעד.
מאפייני תגובת השרת:
מאפיין סוג הסבר הערה reports array מערך אובייקטים ראה להלן success boolean האם הפעולה בוצעה במידה וכן, יופיע הערך true
. במידה ולא, יופיע הערךfalse
action סוג הפעולה שבוצעה תבנית אובייקט
מאפיין ערך what נתיב מקור target נתיב יעד success האם בוצע (זהה לתיאור לעיל) -
קבלת תוכן קובץ טקסט
הפקודה היא -
GetTextFile
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן what נתיב מלא כולל שם הקובץ והסיומת לדוגמה ivr2:1/ext.ini
מאפייני תגובת השרת:
מאפיין סוג ערך contents string התוכן הכתוב בקובץ file array מערך אובייקטים (ראה להלן) תבנית אובייקט:
מאפיין סוג ערך exists boolean האם הפעולה בוצעה (במידה וכן, יופיע הערך true
. במידה ולא, יופיע הערךfalse
)name string שם הקובץ uniqueId string מזהה תנועה ייחודי fileType string סוג קובץ (למשל: INI
)size int גודל קובץ mtime string תאריך ושעה שהקובץ השתנה (פורמט: dd/MM/yyyy HH:mm) what string נתיב מלא -
העלאת טקסט לקובץ
הערה: במידה והקובץ לא קיים בשלוחה, ייווצר קובץ חדש.
הפקודה היא -
UploadTextFile
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן what שם הקובץ והסיומת יש לציין את הנתיב המלא. לדוגמה ivr2:1/ext.ini
contents תוכן הקובץ להעלאה במידה וקיים כבר טקסט בקובץ הוא יימחק אין מאפיינים מיוחדים בתגובת השרת
-
עדכון הגדרות שלוחה
שימו לב! בשונה מהפקודה
UploadTextFile
כאן המערכת לא מוחקת את הקיים בקובץext.ini
והדבר היחיד שמשתנה הוא מה שאתם שולחים לשרתהערה: במידה והשלוחה לא קיימת במערכת, תיווצר שלוחה חדשה.
הפקודה היא -
UpdateExtension
הפרמטרים הנדרשים:
פרמטר תיאור / הערות token טוקן path נתיב בפרמטרים הנוספים תוכלו לצרף ערכים לעדכון בקובץ
ext.ini
לדוגמה:
${url}UpdateExtension?token=${token}&path=ivr2:1&type=menu&title=בדיקה&enter_id=yes
בדוגמה, עדכון הגדרות לשלוחה 1, סוג השלוחה - תפריט, כינוי השלוחה - בדיקה, תתבצע כניסה לפי מספר אישי.
אין מאפיינים מיוחדים בתגובת השרת
-
הכוונת שיחה - העברת מאזין ב**אפשרות הראשונה לשלוחה אחרת או לניתוק
** לא בכל שלב ניתן להעביר את המאזין לשלוחה אחרת באופן מיידי, ולכן הפעולה נשמרת למקום הראשון בו ניתן לעשות את הפעולה
הפקודה היא -
CallAction
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction set:GOasap=XXXX יש להחליף את "XXX" בלאן להעביר את המאזין, נתיב העברה, או "hangup" לניתוק מאפייני תגובת השרת:
מאפיין סוג הסבר calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls action סוג הפעולה שבוצעה callsCount int מספר כולל של שיחות שבוצעה בהן פעולה -
ניהול חדרי ועידה:
הפקודה היא -
CallAction
בקריאה ל
GetIncomingCalls
יש מערך של שיחות של חדרי ועידה, כל הפעולות המפורטות כאן צריכות להיות מבוצעות על הid של המאזין של חדר הועידה - ולא על הID הראשי.טיפה הסבר על מערך של שיחות הוועידה:
דוגמא:
נעבור על החלקים החשובים.
פרמטר תיאור הערות confCalls מכיל את מספר המערכת הראשי, ואז -
ואז את השלוחה של חדר הועידהmute האם הערוץ מושתק hand האם יש הרמת אצבע admin האם מנהל data['survey'] מכיל את נתוני הצבעה, במהלך החדר המאזין יכול להקיש על כל הספרות בטלפון שלו וזה משוקף מייד. באם אין הקשה הערך לא יופיע
הוספה או הסרה של רכיבים מה path וממערך data.
השימוש למשל, כדי לבטל את ההצבעות של המשתשים כדי לאפס את נתוני הסקר.
הוספה של ערך:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidpath:add:XXX הוספה של נתון בpath, זה גם יופיע במערך data
שהובא לעיליש להחליף את XXX בערך, למשל: path:add:survey=7
.הסרה של ערך:
פה ניתן לשלוח רק את ההתחלה של הערך, והוא ירד.
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidpath:remove:XXX הסרה של נתון בpath, זה גם ירד במערך data
שהובא לעיליש להחליף את XXX בתחילת ערך, למשל: path:remove:survey=
. זה יגרום למחיקה של ערךsurvey
ממערך הdata
בכלל - למשל, כדי לאפס נתוני הצבעה.יש לשים לב, זה לא משפיע על סוג וצורת החדר, למשל, שליחה של
path:add:admin
לא תגרום למאזין להיות מנהל של החדר.
הוצאה מחדר ועידה.
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction kick המאזין הולך ביציאה בדיוק לאן שהיה הולך אם המנהל היה מנתק את החדר או שהוא יהיה יוצר מהחדר אלא אם כן מוגדר בשלוחה, התבאר פה.
ניתן גם להוציא את המאזין לשלוחה ספציפית גם ללא שום הגדרה בשלוחה, ניתן לראות בפוסט זה תחת "כיוון הוצאה מחדר ועידה".
השתקת הערוץ:
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction mute
ביטול השתקה של הערוץ:
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction unmute
סימון הורדת יד:
בדומה להורדת אצבע על ידי המאזין בטלפון.
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction lowerhand
סימון הרמת יד:
בדומה להרמת אצבע על ידי המאזין בטלפון.
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction raisehand
כיוון הוצאה מחדר ועידה:
יש לפנות לפה לפני שעושים
kick
על מנת לכוון את המאזין ללכת לשלוחה ספציפית בהוצאה מהחדר. באפשרות זו לא צריך שום הגדרה בשלוחה שתאפשר את היציאה מהחדר, ואם פונים לכאן לפניkick
המאזין ילך לאן שהתבקש.הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidset:ConfbridgeNewGoto=/XX מסמן לאן להעביר את המאזין בביצוע kick
מהאתריש לכתוב נתיב להעברה או hangup לניתוק.
מאפייני תגובת השרת בכל הפעולות:
מאפיין סוג הסבר calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls action סוג הפעולה שבוצעה callsCount int מספר כולל של שיחות שבוצעה בהן פעולה -
שינוי השפה בערוץ:
גובר על ערך language בשלוחה ובivr.ini.
הפרמטרים הנדרשים:
פרמטר תיאור הערות token טוקן ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה :
בין id לidaction=set:Clanguage=XX מסמן את השפה החדשה בערוץ כולו יש להחליף את XX בשפה המבוקשת - כל קודי השפה שיש כמו במערכת עצמה השינוי יכנס לתוקף במעבר שלוחה הבא של המאזין. דוגמה
CallAction?token=xxxxxxxx&ids=fgdhfszfzvxbdgsxf&action=set:Clanguage=en
מאפייני תגובת השרת:
מאפיין סוג הסבר calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls action סוג הפעולה שבוצעה callsCount int מספר כולל של שיחות שבוצעה בהן פעולה -
קבלת סיכום דקות נכנסות למערכת לפי טווח תאריכים
הפקודה היא -
GetIncomingSum
הפרמטרים הנדרשים
פרמטר תיאור דוגמא token טוקן from מאיזה תאריך YYYY-mm-dd to עד איזה תאריך YYYY-mm-dd בחירת מחדל - אם לא צויין טווח תאריכים - יביא מתחילת החודש הלועזי מאפייני תגובת השרת
מאפיין סוג הסבר fromDate string מאיזה תאריך מוצגים הנתונים toDate string עד איזה תאריך מוצגים הנתונים direct int דקות בחיוג ישיר למערכת transferIn int דקות ממערכות אחרות transferOut int דקות שיצאו למערכות אחרות