API - גישת מפתחים למערכות
-
מחיקת קמפיין מתוזמן-DeleteScheduledCampaign
-
קבלת מידע מלא על השלוחה-GetIVR2Dir
-
קבלת רשימת קבצים שבשלוחה-GetIvrTree
-
ניהול קבצים
הפקודה היא
FileAction
הפרמטרים הנדרשים
פרמטר תיאור הערה token טוקן action סוג הפעולה לביצוע ראה להלן what נתיב ראה להלן target יעד ראה להלן בפרמטר
action
האפשרויות הקיימות הן:copy
- העתקהmove
- העברה (לשינוי שם של שלוחה או קובץ יש להשתמש בהעברה)delete
- מחיקה
בפרמטר
what
האפשרויות הקיימות הן:- ניהול קובץ בודד או שלוחה בודדת.
- ניהול קבצים מרובים כאשר בפרמטר
what
יש לציין כל קובץ או שלוחה בנפרד. לדוגמה:
${url}/FileAction?token=${token}&action=${action}&what0=ivr2:1&what1=ivr: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
-
העלאת טקסט לקובץ
הערה: במידה והקובץ לא קיים בשלוחה, ייווצר קובץ חדש.
הפקודה היא -
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 לidset:Clanguage=XX מסמן את השפה החדשה בערוץ כולו יש להחליף את XX בשפה המבוקשת - כל קודי השפה שיש כמו במערכת עצמה השינוי יכנס לתוקף במעבר שלוחה הבא של המאזין.
מאפייני תגובת השרת:
מאפיין סוג הסבר 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 דקות שיצאו למערכות אחרות