API - גישת מפתחים למערכות
-
ניהול חדרי ועידה:
הפקודה היא -
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 דקות שיצאו למערכות אחרות -
קבלת לוג סמסים יוצאים
הפקודה היא -
GetSmsOutLog
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן limit הגבלת תוצאות int בחירת מחדל מביא את כל הסמסים.
סדר קבלת הסמסים הם מהחדש לישןמאפייני תגובת השרת
מאפיין סוג הסבר rows array מערך של הסמסים היוצאים להלן תוכן מערך הסמסים:
מאפיין סוג הסבר CallerId string זיהוי יוצא To string יעד Message string תוכן ההודעה Billing int עלות ביחידות RunBy string פרטי מבצע הפעולה Time string זמן השליחה DeliveryReport string דוח מסירה להלן סוגי סטטוס דוחות מסירה נפוצים לפי תקן SMPP:
# הסבר null
לא התקבל מידע על מסירת ההודעה DELIVRD נמסר ESME_ROK הועבר לשליחה בהצלחה EXPIRED פג תוקף מעקב המסירה ESME_RINVDSTADR יעד לא נגיש ESME_RINVMSGLEN אורך לא חוקי ESME_RINVCMDLEN אורך פקודה שגוי ESME_RMSGQFUL תור ההודעות מלא ESME_RINVNUMDESTS מספר יעדים לא חוקי -
ממשק אירועי אבטחה.
תיעוד API לגישה לאירועי האבטחה של המערכת של המערכת.
ה Web Services היבוארו כאן:
ValidationToken // מידע על הטוקן DoubleAuth // ביצוע אימות דו שלבי בטוקן GetLoginLog // קבלת לוג ניסיונות התחברות GetAllSessions // קבלת סשנים פעילים KillSession // סגירת סשן ספציפי KillAllSessions // סגירת כל הסשנים הפעילים
הערה חשובה:
שימוש בטוקן שהוא שם משתמש וסיסמה של המערכת (077777:1234) לא ממולץ לעבודה עם מתודות שדורשים אימות דו שלבי מכיוון שהאימות הדו שלבי זה ברמת טוקן והתחברות בצורה כזו יוצרת טוקן משתנה.
מתודה -
ValidationToken
קבלת מידע על טוקן.הפרמטרים הנדרשים
פרמטר תיאור token טוקן בתגובת השרת במידה שהטוקן תקין יתקבל מערך בשם
tokenData
המכיל את המידע הבא:מאפיין סוג הסבר דוגמא remoteIP string כתובת IP של יוצר הטוקן 172.18.0.1 sessionType string סוג החיבור API createTime string זמן יצירה 2021-07-30 14:38:30 lastRequest string שימוש אחרון 2021-07-30 14:42:31 doubleAuthStatus boolean האם החיבור עבר אימות דו-שלבי false
validationCalls int כמות שיחות אימות שיצאו ולא אומתו (ערך כללי, לא קשור לחיבור הספציפי) 3 token string רמז של הטוקן hwe***5J76TM
בעיקרון, מה שחשוב לנו לזכור מכאן זה
doubleAuthStatus
- שמסמן לנו אם הטוקן עבר אימות דו שלבי, וvalidationCalls
שצריך לשים לב אליו, כי הוא מוגבל - זה יוסבר יותר בהמשך.
מתודה -
DoubleAuth
ביצוע אימות דו שלבי בטוקן.הפרמטרים הנדרשים
פרמטר תיאור token טוקן action פעולה: שליחת שיחת אימות או אימות בפועל. אימות כפול מתבצע ב2 שלבים, מבקשים שיחת אימות, ואז פונים שוב עם קוד האימות לסיים את האימות.
קבלת שיחה:
שולחים פרמטר
SendCode
בערךaction
.תגובה תקינה של השרת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK message string הודעת הצלחה Call successfully sent LastNumberToSend string 4 הספרות האחרונות של המספר שאליו נשלחה השיחה 7770 שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 EXCEPTION message Missing parameters חסרים פרמטרים, או ש action
ריק או שהוא מצפה לערך נוסף2 EXCEPTION message createPhone is Not Valid. verification is disabled מספר יוצר המערכת לא מעודכן או לא מספר תקין, לא ניתן לבצע אימות 3 ERROR message Token has already been verified כבר בוצע אימות דו שלבי בטוקן זה. 4 ERROR message Too many validation Calls. Try for a few more hours יותר מידי שליחת שיחות במערכת ללא אימות בטווח קצר. הסבר חשוב בנוגע לשגיאה 4: על מנת למנוע ניצול לרעה שליחת שיחות אימות מוגבלות, כל שליחה של שיחת אימות נספרת, וכל אימות מוצלח מוריד ספירה.
זה אומר, שאם תבצעו אימות מוצלח ושיחה אחד בלבד זה לא יחשב בתור שיחה, אבל אם תשלחו 4 שיחות אימות ורק אז יתבצע אימות אז יספר 3 שיחות שיצאו ללא צורך.ניתן לראות את המונה שיחות של המערכת בפניה ל
ValidationToken
.
המונה מתאפס כל כ6 שעות.ביצוע אימות בפועל:
שולחים פרמטר
VerifyCode
בערךaction
ואת 4 הספרות של המספר שקיבלתם ממנו את השיחה בערךcode
.תגובה תקינה של השרת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK message string הודעת הצלחה VerifiedOK אחרי ביצוע אימות לטוקן ניתן להשתמש איתו למתודות שיבוארו מייד לאחר הסבר השגיאות.
שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 ERROR message Please SendCode before לא ניתן לבצע אימות לפני שליחת שיחה. יש לשלוח שיחה קודם. 2 ERROR message Authentication failed הקוד לא תקין. 3 ERROR message Missing parameters חסרים פרמטרים, או ש action
ריק או שהוא מצפה לערך נוסף4 ERROR message Token has already been verified כבר בוצע אימות דו שלבי בטוקן זה.
מתודה -
GetLoginLog
קבל לוג התחברויותהפרמטרים הנדרשים
פרמטר תיאור token טוקן שעבר אימות דו שלבי limit ניתן להגביל את כמות התוצאות שיתקבלו username חיפוש לוג לפי שם משתמש לגבי ערך username: בעצם LoginLog לא מחייב שמדובר במערכת אמיתית ולכן זה נשמר לפי שם משתמש, בעת פניה ללא הערך יחזרו הלוגים של המספר הראשי של המערכת, אם ברצונכם להביא לוגים של מספר משנה למשל, יש לצרף ערך זה עם המספר משנה.
בתגובת השרת במידה שהטוקן תקין יתקבל array בשם
data
המכיל את כל התוצאות, כל תוצאה היא גם מערך המכיל את השדות הבאים:מאפיין סוג הסבר דוגמא remoteIP string כתובת IP 172.18.0.1 sessionType string סוג החיבור REGULAR actionTimestamp string זמן 2021-07-30 14:13:00 username string שם המשתמש 0773137770 successful boolean האם מדובר בחיבור מוצלח או לא false
שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי. 2 EXCEPTION message Unknown username ערך שם משתמש שגוי.
מתודה -
GetAllSessions
קבל סשנים פעיליםהפרמטרים הנדרשים
פרמטר תיאור token טוקן שעבר אימות דו שלבי limit ניתן להגביל את כמות התוצאות שיתקבלו בתגובת השרת במידה שהטוקן תקין יתקבל array בשם
sessions
המכיל את כל החיבורים וערך int בשם sessionsCount המכיל את כמות הסשנים הפעילים.
כל ערך בתוךsessions
יכיל:מאפיין סוג הסבר דוגמא id int מזהה טוקן, לצורך הריגה שלו 16598 token string רמז של הטוקן hwe***5J76TM
active boolean האם הטוקן פעיל true
selectedDID string שם משתמש (בחיבור של API זה null
0773137770 remoteIP string כתובת IP של יוצר הטוקן 172.18.0.1 sessionType string סוג החיבור API createTime string זמן יצירה 2021-07-30 14:38:30 lastRequest string שימוש אחרון 2021-07-30 14:42:31 doubleAuthStatus boolean האם החיבור עבר אימות דו-שלבי false
שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי.
מתודה -
KillSession
סגירת סשןהפרמטרים הנדרשים
פרמטר תיאור token טוקן שעבר אימות דו שלבי SessionId מזהה סשן להריגה תגובה תקינה של השרת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK SessionId string מזהה הסשן שנסגר 35 שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי. 2 EXCEPTION message SessionId Can only be a number ערך מזהה סשן ריק או לא תקין. 3 ERROR message SSessionId is broken מזהה סשן לא פעיל או לא נמצא.
מתודה -
KillAllSessions
סגירת כל הסשנים הפעילים של המערכתהפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן שעבר אימות דו שלבי תגובה תקינה של השרת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK KillSessions string כמות הסשנים שנסגרו 10 שגיאות אפשרויות:
סוג השגיאה מופיע בresponseStatus
# סוג שגיאה ערך הסברה תוכן הסבר 1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי. -
הפעלת צינתוק
הפקודה היא -
RunTzintuk
שליחת צינתוק במתודה זו היא בעלות של 0.1 יחידה למספר מלבד הפעלה של צינתוק מרשימת צינתוקים חינמים שהיא ללא עלות.
יתכן שתעריף השימוש במודול זה ישתנה בהמשך לפי שיקול דעת ההנהלה.הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן callerId זיהוי יוצא, בחירת מחדל זיהוי ראשי של המערכת, ניתן לכתוב זיהוי ספיישל או מספר משנה. ניתן להשתמש עם זיהוי רנדומלי על ידי ציון RAND
, זיהוי רנדומלי יבואר מתחת לטבלאint TzintukTimeOut זמן צינתוק. בחירת מחדל 9 שניות. מקסימום זמן צינתוק 16 שניות Float phones מספרים לחיוג. יבוארו האפשרויות למטה. הסבר על זיהוי רנדומלי:
השירות מיועד למשל כדי לבצע אימות מספר טלפון באתרים וכד, בעת ציון של ערך זה לא ניתן לשלוח לרשימה של מספרים והמספר הראשון ברשימה כפי שנבחרה יקבל את השיחה.
בתגובה מהשרת יתמלא גם ערךverifyCode
שמכיל את 4 הספרות האחרונות של הזיהוי ממנו יצא השיחה, ובערךcallerId
בתגובה מהשרת יהיה כתובRAND
. תוכלו לבצע אימות של הלקוח בצורה שאתם מבקשים ממנו להקיש את ה4 ספרות האחרונות של המספר ממנו הוא קיבל את השיחה ואתם משווים את זה עםverifyCode
.
במקרה שהשיחה לא מזיהוי רנדומלי ערךverifyCode
יהיה ריק.צורות אפשרויות להגשת רשימת המספרים לחיוג:
כאשר הפניה היא בGET או בPOST שהוא לא jsos (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" } ]
ואז ניתן להוציא צינתוק לרשימת מספרים עם ״זיהוי שיחה מתחלף״.
שליחת צינתוקים לכמה רשימות צינתוקים חינמיים יחד:
השירות מוגבל ל50 רשימות בקריאה.
בעת שליחת צינתוק לרשימת צינתוקים חינמיים ניתן להפעיל קמפיין אחד לכמה רשימות יחד.
מספרים הנמצאים בכמה מהרשימות יקבלו צינתוק אחד בלבד.
על מנת לציין כמה רשימות ניתן או לחלק את הרשימות על ידי,
אחרי ציוןtzl:
. למשל, כדי לשלוח לרשימה100
ולרשימה200
ו300
יש לציין:tzl:100,200,300
.
במידה ששמות הרשימות מכילות את התו,
זה ייצור בעיות, ולכן אפשר גם לציין את זה כמערך, זאת במידה שהשליחה היא בPOST - json באופן שבphones
מציינים רקtzl:
ואת הרשימות בפרמטרtzintukLists
. כמו בדוגמא הבאה:{ "phones": "tzl:", "tzintukLists": [ "100", "200", "בית ספר, כיתה ג", "משרד, מזכירות" ] }
מאפייני תגובת השרת בתגובה מוצלחת:
מאפיין סוג הסבר דוגמא responseStatus sting סטטוס הפעולה OK
verifyCode sting 4 ספרות אחרונות של הזיהוי היוצא לצורכי אימות. יהיה מלא רק במידה שהשיחה מזיהוי רנדומלי. 9835
callerId sting זיהוי השיחה היוצא 0773137770
callsCount int כמות שיחות יוצאות 3
bilingPerCall int תשלום לכל שיחה 0.1
biling int כמות תשלום כולל 0.3
errors array מערך של מספרי טלפון שלא נשלח אילהם השיחה כולל הסיבה. מתחת לטבלא דוגמא לפירוט שגיאות במערך "errors":
{ 05832XXXXX: "blocked", // חסום 0773137770: "double", // מספר כפול *8080: "notValid" // מספר לא תקין }
- רשימה מפורשת עם הפרדה של
-
ניהול רשימות צינתוקים במודול צינתוקים חינמיים
הפקודה היא -
TzintukimListManagement
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string action פעולה לביצוע, ערך חובה. יוסברו הפעולות מטה string TzintukimList מספר הרשימה. לא חובה כאשר מבקשים לקבל את רשימת הצינתוקים string
פעולה: getlists
מחזיר את כל רשימות הצינתוקים בתוך מערך "lists"
מאפייני תגובת השרת בתגובה מוצלחת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
lists array מערך של הרשימות, ראה טבלא למטה כל אובייקט במערך
lists
מכיל 2 ערכים:מאפיין סוג הסבר דוגמא listName string שם הרשימה 120 subscribers int כמות רשומים 7
פעולה: getlistEnteres.
חובה לצרף ערך TzintukimListמחזיר את רשימת המספרים המנויים לרשימה
מאפייני תגובת השרת בתגובה מוצלחת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
listName string שם הרשימה 1844 countSubscribers int כמות הרשומים 7 enteres array מערך של המספרים ושמות שלהם. השמות נטענים מקובץ 'PhonesName.ini' מהשלוחה הראשית, תבנית הקובץ צריכה להכיל "טלפון=שם"
כל אובייקט במערך
enteres
מכיל:מאפיין סוג הסבר דוגמא phone string מספר הטלפון הרשום name string השם של מספר הטלפון הרשום כפי שנטען מקובץ PhonesName.ini
פעולה: getLogList
חובה לצרף ערך TzintukimListמחזיר את לוג הפעולות שבוצעו על הרשימה
מאפייני תגובת השרת בתגובה מוצלחת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
events array מערך של האירועים, ראה טבלה כל אובייקט במערך
events
מכיל:מאפיין סוג הסבר דוגמא Folder string שלוחה במערכת 1/2 CustomerDID string מספר המערכת 0773137770 Phone string מבצע הפעולה 0533137770 Date string תאריך 19/01/2021 Time string שעת ביצוע 00:39:10 TypeOperation string סוג הפעולה מצורף למטה הסוגים PhoneAction string פעולה על טלפון (הערך יהיה מלא במידה שמדובר בפעולה על טלפון מסויים ברשימה) הסוגים האפשריים בTypeOperation:
AddToListTzintuk // הוספה לרשימה RunTzintuk // הפעלת צינתוק RemovingToListTzintuk // הסרה מהרשימה AdminRemovingToListTzintuk // מנהל הסיר מספר מהרשימה ResetToListTzintuk // הרשימה אופסה
פעולה: resetList
חובה לצרף ערך TzintukimListמאפס רשימת צינתוקים
מאפייני תגובת השרת בתגובה מוצלחת:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
list string הרשימה שאופסה באם תיהיה שגיאה יחזיר שגיאה
-
שליחת פקס
הפקודה היא -
SendFax
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string pdfFile קובץ לשליחה. יבואר 2 אפשרויות string phone לאן לשלוח string callerId זיהוי שיחה יוצאת. בחירת מחדל הזיהוי של המערכת הראשי string deliveryUrl כתובת לקבלת דוח מסירה string
pdfFile
ניתן לציין נתיב של קובץ מתוך המערכת, למשל:ivr2://FaxTest.pdf
וישלח את קובץ "FaxTest.pdf" שתחת השלוחה הראשית. אפשר גם לציין את זה:/FaxTest.pdf
, רק חשוב ה/
בהתחלה.בנוסף, ניתן להעלות קובץ ספציפי, לצורך כך יש לציין בערך
UPLOAD
ואז יש להעלות את הקובץ בערך "fileToUpload
, כמובן בעת שימוש באפשרות זו הפניה חייבת להיות בPOST מסוגmultipart/form-data
deliveryUrl
יש לציין URL מלא לקבלת דוח מסירה. למשל:http://127.0.0.6:18358/FaxDel
, הפניות ישלחו בPOST בלבד ויכילו את הערכים הבאים:לכל הפניות יצורף ערך
CampaignId
שתוכלו להשוות אותו עם ערךCampaignId
שמתקבל בהצלחה.
לכל הפניות יצורף ערךDelivery
המכיל את סטטוס המסירה.- במידה ש
Delivery
הואNoAnswer
יצורף ערךDIALSTATUS
המכיל את התשובה של החיוג ללקוח. - במידה ש
Delivery
הואEnd
יצורף ערךstatus
המכיל את התשובה מצד מנוע הפקס. תשובה של מסירה מוצלחת תיהיהSUCCESS
בערךstatus
. - במידה ש
Delivery
הואAnswer
זה אומר שהשיחה נענת, מציין שהעברת הפקס התחילה.
על כל שליחה של פקס יש חיוב של 0.1 יחידות על עצם השליחה ובנוסף חיוב יחסי לפי הזמן של השיחה הפעילה - בחישוב של יחידה לדקה. אם זמן השליחה לקח 3 דקות תחוייבו בנוסף 3 יחידות, בנוסף, לא ניתן להפעיל שיחת פקס אם אין ספייר במערכת של יותר מ5 יחידות מהחיוב על השיחה עצמה.
מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
callerId string זיהוי השיחה היוצאת 0773137770 CampaignId string מזהה הקמפיין WSOC-LC-2021-08-28-21-40-49-083 deliveryUrl string מציין את הכתובת למסירה באם צויינה http://127.0.0.6:18358/FaxDel fileNameSend string שם הקובץ שנשלח ivr2://FaxTest.pdf callsCount int כמות שיחות יוצאות 1 bilingPerCall float חיוב לכל שיחה 0.1 biling float כמות חיוב בפועל 0.1 בעת שגיאה תפורט השגיאה והבעיה.
- במידה ש
-
בדיקה האם קובץ קיים
הפקודה היא -
CheckIfFileExists
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string path נתיב במערכת. דוגמאות למטה string
אפשרויות ציון קבצים ניתן לציין בכל אחד מהצורות מטה:
לצורך הדוגמא כדי לחפש את קובץext.ini
בשלוחה 4.path=ivr2:/4/ext.ini path=ivr2:4/ext.ini path=ivr/4/ext.ini
מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
fileExists bool האם הקובץ קיים path string המיקום שלו ivr/1/ext.ini -
שליחת סמסים
הפקודה היא -
SendSms
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string from זיהוי שולח, בחירת מחדל זיהוי המערכת הראשי. ניתן לכתוב מספר מאושר במערכת או מספר משני. ניתן גם לבצע שליחה משולח טקסטואלי (זיהוי טקסט), באם יש לכם צורך בזה יש לפנות לשירות הלקוחות עם סיבה. string message תוכן ההודעה string sendFlashMessage הודעת פלאש? מסרון פלאש (הודעת הבזק) ישלח ללקוח ויקפוץ בטלפון במסך מלא. האפשרות יכולה לא לעבוד בטלפונים מסויימים/במפעילים מסויימים ויתכן שנמענים מסויימים יזהו את המסרון כמסרון רגיל. Boolean (0/1) phones נמענים בהפרדה של :
בין כל מספר, אוtpl:X
על מנת לשלוח לרשימת תפוצה במערכת שבמקום הX יש לכתוב את מזהה הקמפייןstring החיוב על שליחת סמס הוא 0.1 יחידה לכל 70 תוים בחיוב לכל מספר טלפון.
מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
message string תוכן ההודעה ששלחתם from string הזיהוי ממנו יצאה ההודעה sendCount int כמה הודעות נשלחו Billing float תשלום oks array מערך של מספרים אילהם נשלחה ההודעה errors object אובייקט המכיל את המספרים שאילהם לא נשלחה ההודעה כולל הסיבה במקרה של שגיאה השגיאה תפורט.
-
הקמת שיחת גישור
הפקודה היא -
CreateBridgeCall
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string callerId זיהוי השיחה היוצאת שתופיע על הצג לאורך הדרך string Phones מספר טלפון לחיוג string BridgePhones מספר טלפון לניתוב string DialSip האם להפעיל מנגנון חיוג ל SIP (הסבר למטה) 0/1 DialSipExtension האם להפעיל מנגנון חיוג לשלוחת SIP (הסבר למטה) 0/1 AccountNumber מספר חשבון SIP במערכת (בחירת מחדל המספר הראשי) int SipExtension במידה שזה שלוחת sip, יש לציין את השלוחה. int RecordCall האם להקליט את השיחה Boolean (0/1) SendMailInCall האם לשלוח הקלטה למייל Boolean (0/1) SendMailInCallTo מייל ספציפי לשליחת ההקלטה. בחירת מחדל המייל המופיע במערכת string ערכים שיש להם בחירת מחדל:
callerId=מספר מערכת ראשי RecordCall=0 SendMailInCall=0
הסבר אודות הפעלת שירות חיוג לחשבון SIP (
DialSip)
:
השירות מאפשר לחייג לחשבון SIP קיים במערכת וממנו לגשר את השיחה באופן שלא יהיה עלות ניתוב כפול אלא רק עלות של הניתוב החיצוני - אחרי המענה בשלוחת SIP.
בעת הפעלת השירות ערךPhones
לא משנה (עדיין חובה לשלוח אותו) והמספר שיקבע הוא המספר של חשבון הSIP/השלוחה של חשבון ה sip לפי הפרמטרים.
לא ניתן לחייג לשלוחת SIP שלא קיימת באותה המערכת.
בכל מקרה יש עלות של 0.1 יחידות על עצם הפעלת הקמפייןהחיוב על שליחת שיחה הוא 0.1 יחידה על עצם הקמת שיחת הגישור ואז לפי החישוב הבא:
יש כאן 2 מסלולי חיוב.
1: מהרגע שאני מוציא שיחה לנציג.
2: מהרגע שהלקוח המגושר ענה.למשל, אם אני חייגתי לנציג 60 שניות, הוא חייג ללקוח - שהוא הלקוח המגושר. זמן החיוג היה 10 שניות ועוד 50 שניות הוא דיבר איתו, אז החיוב יחידות יהיה על 110 שניות:
60 שזה זמן השיחה הכללי, + 50 שניות של דיבור עם הלקוח המגושר. על זמן החיוג ללקוח המגושר הוא לא משלם.מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
CampaignId string מזהה קמפיין WSOC-LC-2021-11-23-15-10-15-276 callerId string זיהוי השיחה callsCount int כמות שיחות 1 bilingPerCall float עלות של כל שיחה biling string סך הכל חיוב SendMailInCall Boolean RecordCall Boolean SendMailInCallTo string כמובן, הערכים הקשורים לחיוב שמתקבלים בתגובה מציינים את החיוג על הפעלה הקמפיין ולא על החיוב הסופי שמחושב בנפרד.
במקרה של שגיאה השגיאה תפורט.
-
קבלת מידע בזמן אמת על שלוחת תור
הפקודה היא -
GetQueueRealTime
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string queuePath נתיב שלוחת התור במערכת. לשלוחה ראשית: .
או לשלוחות פניומיות:/1/2
string מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
queueData Object מידע כללי על התור דוגמא בטבלא למטה members array מידע על הנציגים דוגמא בטבלא למטה entries array מידע על הממתינים דוגמא בטבלא למטה שימו לב! כל הסטטיסטיקות של הנציגים בזמן אמת מתאפסת בעת שינוי קובץ
queue.ini
שבשלוחה.
פירוט של "queueData":
ערך סוג הסבר Abandoned int שיחות שננטשו Calls int לקוחות ממתינים Completed int שיחות שהושלמו TalkTime int זמן שיחות Holdtime int זמן המתנה Max int מקסימום שיחות בתור Strategy string סוג התור
פירוט של כל אובייקט במערך "members":
ערך סוג הסבר agent string מספר הנציג Status string סטטוס נציג. 1 פנוי 2 תפוס CallsTaken int שיחות שהנציג לקח LastCallUnitTime string זמן השיחה האחרונה שהוא לקח ב unit time LastCall string זמן של השיחה האחרונה שלקח LastCallAgo string לפני כמה זמן לקח שיחה אחרונה, למשל: 4 דקות, 33 שניות
Paused Boolean האם הנציג בהפסקה Penalty string עדיפות הנציג בתור
פירוט של כל אובייקט במערך "entries":
ערך סוג הסבר phone string מספר הלקוח Wait string זמן המתנה בשניות WaitAgo string כמה זמן הלקוח ממתין, למשל: 7 דקות, 23 שניות
Position string מיקום בתור CallId string מזהה שיחת תור לצורך ביצוע פעולות במקרה של שגיאה השגיאה תפורט.
-
קבלת מידע על המערכת
הפקודה היא -
GetCustomerData
הפרמטרים הנדרשים:
פרמטר תיאור / הערות token טוקן מאפייני תגובת השרת:
מאפיין סוג ערך mainDid string מספר המערכת הראשי secondary_dids array מערך של מספרים משניים (ראה להלן) callerIds array מערך של מספרי ספיישל לשיחות יוצאות (ראה להלן) name string שם לקוח expiredUnits boolean האם יחידות פגו תוקף unitsExpireDate string תאריך תפוגה של היחידות email string כתובת אימייל organization string שם ארגון contactName string שם איש קשר phones string טלפון invoiceName string חשבונית על שם invoiceAddress string כתובת למשלוח חשבונית fax string פקס accessPassword string סיסמת גישה למערכת units string כמות היחידות שבמערכת recordPassword string סיסמת הקלטות resellerCreditFile string שם משווק systemSite string אתר מערכת (לדוגמה: yemot
ymt
ymta
ymtb
)pirsumPhoneStatus Boolean האם המערכת פעילה ב"פרסומפון" ivrType string סוג המערכת (יפורט הסוגים)
בתוך מערך
secondary_dids
(מספרים משניים) יופיעו האובייקטים הבאיםאובייקט תיאור דוגמה id מזהה מספר משנה 100
did מספר משנה 0773137770 usage שימוש goto:/1
בתוך מערך
callerIds
(מספרי ספיישל) יופיעו האובייקטים הבאיםאובייקט תיאור דוגמה callerId מספר מאושר לזיהוי יוצא 0773137770 expiryDate פג תוקף של האישור לזיהוי 2025-04-18+01:39:27
(במקום + יופיע רווח)
הסוגים שאפשריים ב
ivrType
סוג תיאור הערה CAMPAIGN חייגן - מערכת קמפיינים EMERGENCY חייגן חירום IVR1 מערכת IVR1 מערכת שיצאה מתמיכה IVR2 מערכת תוכן - IVR2 SPECIAL מערכת מיוחדת לא נפוץ WHATSAPP_PHONE וואצפון למערכות וואצפון אין גישה בAPI QUEUE תור לא נפוץ VIRTUAL_PLUS וירטואל פלוס WHATSAPP_PHONE_ADMIN וואצפון מנהלים DIAL_TO_SIP חיוג למשתמש SIP NEW_WHATSAPP_PHONE וואצפון החדש -
קבלת דוח קמפיין
הפקודה היא -
ViewCampaignReports
הדוחות המתקבלים בממשק זה הם דוחות על קמפיינים שפירוט החיוב שלהם מתחיל ב
Start-YA-
בלבד.
למשל:
הפרמטרים הנדרשים:
פרמטר סוג ערך דוגמא token string טוקן CampaignId string מזהה הקמפיין המבוקש. מזהה הקמפיין הוא כפי המופיע בדוח היחידות עם הסרה של Start-YA-
מההתחלה.SMS-3-0773137770-Yemot-1641217161871
json Boolean יש לשלוח ערך 1 על מנת לקבל מידע ב JSON 1
מאפייני תגובת השרת:
במידה שהבקשה תקינה, ערך "report" יכיל את הדוח של הקמפיין.
שימו לב, מבנה התגובה של הדוחות יוכל להשתנות בהתאם לסוג הקמפיין, ההסבר כרגע הוא על דוח של קמפיין סמס:מאפיין סוג ערך CampaignData Object מידע כללי על הקמפיין report Object כל איבר באובייקט הוא מספר טלפון שאליו נשלח הקמפיין ומכיל את המידע עליו. דוגמא למבנה מלא של דוח סמס:
-
הוספה ואימות של זיהוי ספיישל
אימות תקף לשנה אחת. לאחר שנה מהאימות המספר יוסר ויהיה צורך לאמת אותו בשנית. אימות של מספר קיים יאריך את תוקף האימות של המספר בשנה מזמן האימות.
הפקודה היא -
ValidationCallerId
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string action פעולה - (send/valid) להלן יפורטו הפעולות והפרמטרים string פעולה: send - שליחת בקשת אימות:
הפרמטרים לפעולה send :
פרמטר תיאור סוג callerId המספר להוספה string validType סוג האימות. SMS
/CALL
string שליחת סמס/שיחת אימות הינה בעלות יחידות לפי התעריף הרגיל.
בתגובה תקינה יחזור:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
reqId string מזהה בקשת אימות. איתה יש לפנות על מנת לבצע אימות בפועל
פעולה: valid - אימות:
הפרמטרים לפעולה valid:
פרמטר תיאור סוג reId מזהה בקשת אימות שהתקבל בפעולת send string code קוד האימות string בתגובה תקינה יחזור:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
status Boolean סטטוס הוספת זיהוי הספשייל. true
בהצלחה -
מערכת תזמון משימות
שימו לב, לע"ע לא יכול להיות מעל 10 משימות פעילות בכל לקוח.
הפקודה היא -
GetTasks
קבלת רשימת המשימות במערכת.הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string limit הגבלה לתוצאות (בחירת מחדל 100) int בתגובה תקינה יחזור מערך
tasks
המכיל בכל אובייקט משימה עם הפרטים הבאים:מאפיין סוג הסבר דוגמא id int מזהה משימה (נדרש לביצוע פעולות, מחיקת משימה, עידכון משימה או קבלת לוגים) 1
description string תיאור חופשי של המשימה type string סוג המשימה createTs string זמן יצירה status string סטטוס המשימה active Boolean(0/1) האם פעילה sendMailInEnd Boolean(0/1) האם מוגדר לקבל מייל בעת סיום מוצלח sendMailInError Boolean(0/1) האם מוגדר לקבל מייל בעת סיום בשגיאה nextRun string זמן ריצה הבא
הפקודה היא -
GetTasksData
קבלת מידע מפורט על משימה מסויימתהפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string TaskId מזהה משימה int בתגובה תקינה יחזור:
ערכים מוגדשים הם ערכים שנוספו על המידע המתקבל בתוך המערך של רשימת המשימות הכללית
מאפיין סוג הסבר דוגמא id int מזהה משימה (נדרש לביצוע פעולות, מחיקת משימה, עידכון משימה או קבלת לוגים) 1
description string תיאור חופשי של המשימה type string סוג המשימה createTs string זמן יצירה status string סטטוס המשימה active Boolean(0/1) האם פעילה sendMailInEnd Boolean(0/1) האם מוגדר לקבל מייל בעת סיום מוצלח sendMailInError Boolean(0/1) האם מוגדר לקבל מייל בעת סיום בשגיאה nextRun string זמן ריצה הבא updateTs string זמן עדכון lastRun string זמן ריצה אחרון minute int הגדרת זמן ריצה: דקה hour int הגדרת זמן ריצה: שעה year int הגדרת זמן ריצה: שנה day int הגדרת זמן ריצה: יום בחודש month int הגדרת זמן ריצה: חודש days_of_week string הגדרת זמן ריצה: ימים בשבוע (ימים מופרדים בפסיקים 0=יום ראשון - 6=יום שבת) action_data JSON מידע למנוע המשימות על הפעולות לביצוע במשימה
הפקודה היא -
GetTasksLogs
קבלת לוג הפעלות על משימה מסויימתהפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string TaskId מזהה משימה int בתגובה תקינה יחזור ערך
logs
המכיל מערך שכל אובייקט מכיל את הפרטים הבאים:ערכים מוגדשים הם ערכים שנוספו על המידע המתקבל בתוך המערך של רשימת המשימות הכללית
מאפיין סוג הסבר דוגמא id int מזהה הפעלת המשימה 1
succeeded Boolean(0/1) האם הסטטוס הוא מוצלח error_message string פירוט שגיאה Campaign Id does Not found in customer
ts string זמן ההפעלה
הפקודה היא -
CreateTask
יצירת משימה חדשההפרמטרים הנדרשים
פרמטרי זמן ריצה שלא נשלחים נחשבים כ null - ללא התחשבות
פרמטר סוג תיאור מידע נוסף token string טוקן description string תיאור חופשי של המשימה minute int הגדרת זמן ריצה: דקה hour int הגדרת זמן ריצה: שעה year int הגדרת זמן ריצה: שנה day int הגדרת זמן ריצה: יום בחודש month int הגדרת זמן ריצה: חודש active Boolean(0/1) האם משימה פעילה checkIsKodesh Boolean(0/1) האם למנוע מהמשימה לרוץ בשבתות וחגים mailInEnd Boolean(0/1) האם לשלוח מייל בסיום מוצלח mailInError Boolean(0/1) האם לשלוח מייל בסיום בכישלון ifAnyDay Boolean(0/1) אם זה 1 אז כל לא בודק התחשבנות ב days days (string(JSON סטרינג המכיל JSON לפי הדוגמא מטה, כל איבר באובייקט המפתח שלו הוא יום. במידה שערך זה לא יהיה תקין יכנס null - כל הימים בשבוע taskType string סוג משימה כרגע יכול להיות: SendSMS
/RunTzintuk
/MoveOnFile
callerId string זיהוי יוצא רלוונטי לסוגי משימות SendSMS
/RunTzintuk
toList string מזהה / שם רשימה רלוונטי לסוגי משימות RunTzintuk
smsList string מזהה רשימת תפוצה רלוונטי לסוגי משימות SendSMS
typeList string סוג רשימה רלוונטי לסוגי משימות RunTzintuk
. יכול להיותtpl
/tzl
smsMessage string טקסט להודעת סמס רלוונטי לסוגי משימות SendSMS
folder string תיקיית מקור רלוונטי לסוגי משימות MoveOnFile
target string תיקיית יעד רלוונטי לסוגי משימות MoveOnFile
moveFileType string סוג קובץ, maxFile
/minFile
רלוונטי לסוגי משימות MoveOnFile
blockMoveIfNewFileInMinutes int חסימת העברת הקובץ במידה שבשלוחת היעד קיים קובץ שהוקלט בטווח הדקות שמצויין רלוונטי לסוגי משימות MoveOnFile
דוגמא לסטרינג JSON המכיל מידע על ימי הפעילות:
{"0":1,"1":0,"2":1,"3":1,"4":0,"5":0,"6":0}
כלומר - כל key הוא יום. כל valus אומר ב 0 / 1 האם היום פעיל או לא.
בדוגמא למעלה רק ימים ראשון ושלישי מאופשרים.
להזכירכם: 0-זה יום ראשון ו6-זה יום שבתבתגובה תקינה יחזור:
מאפיין סוג הסבר דוגמא id int מזהה הפעלת המשימה 1
jobId int מזהה משימה שנוצרה ActionData object אובייקט עם מידע על המשימה נכון לאיך שהיא נקלטה
הפקודה היא -
UpdateTask
עידכון זמני ריצה של משימה קיימת.- לא ניתן לשנות את סוג המשימה או את הדברים שהמשימה עושה
הפרמטרים הנדרשים
פרמטרי זמן ריצה שלא נשלחים נחשבים כ null - ללא התחשבות
פרמטר סוג תיאור מידע נוסף token string טוקן TaskId int מזהה משימה לעריכה חובה description string תיאור חופשי של המשימה minute int הגדרת זמן ריצה: דקה hour int הגדרת זמן ריצה: שעה year int הגדרת זמן ריצה: שנה day int הגדרת זמן ריצה: יום בחודש month int הגדרת זמן ריצה: חודש active Boolean(0/1) האם משימה פעילה mailInEnd Boolean(0/1) האם לשלוח מייל בסיום מוצלח mailInError Boolean(0/1) האם לשלוח מייל בסיום בכישלון ifAnyDay Boolean(0/1) אם זה 1 אז כל לא בודק התחשבנות ב days days (string(JSON סטרינג המכיל JSON לפי הדוגמא מטה, כל איבר באובייקט המפתח שלו הוא יום. במידה שערך זה לא יהיה תקין יכנס null - כל הימים בשבוע דוגמא לסטרינג JSON המכיל מידע על ימי הפעילות:
{"0":1,"1":0,"2":1,"3":1,"4":0,"5":0,"6":0}
כלומר - כל key הוא יום. כל valus אומר ב 0 / 1 האם היום פעיל או לא.
בדוגמא למעלה רק ימים ראשון ושלישי מאופשרים.
להזכירכם: 0-זה יום ראשון ו6-זה יום שבתבתגובה תקינה יחזור:
מאפיין סוג הסבר דוגמא status Boolean יהיה true
הפקודה היא -
DeleteTask
מחיקת משימההפרמטרים הנדרשים
פרמטר סוג תיאור מידע נוסף token string טוקן TaskId int מזהה משימה למחיקה בתגובה תקינה יחזור:
מאפיין סוג הסבר דוגמא status int מספר המשימות שנמחקו -
שליחת קמפיין הודעת TTS
הפקודה היא -
SendTTS
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string callerId זיהוי שולח, בחירת מחדל זיהוי המערכת הראשי. ניתן לכתוב מספר מאושר במערכת או מספר משני. string ttsMessage תוכן הטקסט string callbackUrl קישור לקבלת hooks בזמן אמת על סטטוס הקמפיין (הסבר למטה) string repeatFile כמה פעמים לחזור על ההשמעה. בחירת מחדל 2 פעמים. int ttsRate מהירות השמעה כאשר 10 זה הכי מהיר ו 10- זה הכי לאט (בחירת מחדל רגיל) int ttsVoice הקול של ההשמעה (מידע על הקולות כאן) string SendMail האם לקבל דוח קמפיין 0/1 phones נמענים בהפרדה של :
בין כל מספר, אוtpl:X
על מנת לשלוח לרשימת תפוצה במערכת שבמקום הX יש לכתוב את מזהה הקמפיין. ניתן גם לקחת את המספרים מרשימת צינתוקים חינמית (בעלות יחידות מלאה!) על ידי ציוןtzl:XX
ובמקום XX את שם הרשימה.string החיוב על שליחת שיחה TTS הוא יחידה לדקה ראשונה ואחריה חיוב יחסי של יחידה לדקה.
מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
CampaignId string מזהה קמפיין OKCalls int ספירת שיחות מוצלחות ErrorCalls object שיחות שגויות וסיבה billing float עלות units string יחידות בלקוח במקרה של שגיאה השגיאה תפורט.
הסבר ודוגמא בנוגע לקבלת hooks בזמן אמת על סטטוס הקמפיין:
באם מציינים פרמטר
callbackUrl
המערכת תשלח בזמן אמת בעת פעילות הקמפיין לשרת שלכם את סטטוס השיחות.
הדבר אפשרי בעת הפעלה לרשימה של עד 500 מספרים לע״ע.הפניות יגיעו לכתובת שלכם בPOST באופן הבא:
בעת שיחה שנענתה:
{ "CampaignId": "YA-3-xxxxx-Yemot-1672066954231731", "Number": "077xxxxx", "Status": "UP", "Time": 1672066959116 }
בעת שיחה שנכשלה:
{ "CampaignId": "YA-3-xxxxx-Yemot-1672066954231731", "Number": "077xxxxx", "Status": "FAILD", "Time": 1672066959865, "FailReason": "5" }
בעת שיחה שהסתיימה:
{ "CampaignId": "YA-3-xxxxx-Yemot-1672067627514828", "Number": "077xxxxx", "Status": "DOWN", "Time": 1672067636731, "CallTimeMS": 4969, "BridgeCallStart": null, "BridgeCallStop": null }
בעת סיום הקמפיין:
{ "CampaignId": "YA-3-xxxxx-Yemot-1672068098471003", "Number": null, "Status": "END", "Time": 1672068114027, "moreData": { "CampaignBilling": 3, "notEnteris": 0, "enteris": 3, "done": 2, "fail": 1, "createTS": "2022-12-26 17:21:38", "runTS": "2022-12-26 17:21:38", "endTS": "2022-12-26 17:21:53" } }
-
הפקת דוח מקובץ ymgr
הפקודה היא -
RenderYMGRFile
הפרמטרים הנדרשים
פרמטר תיאור סוג הערות / דוגמא token טוקן string wath מיקום הקובץ במערכת string ivr2:/ymgtTest.ymgr convertType סוג הקובץ להנפקה. סוגים אפשריים: html
/csv
/json
string רק במקרה של בקשת json תיהיה תגובה של json ממש. בשאר המקרים התגובה תיהיה הקובץ עצמו (Blob) notLoadLang האם לא להשתמש בקבצי שפה/תרגום לעמודות/ערכים 0/1 באם ערך זה הוא 1 התרגום יהיה נקי ומדוייק של הymgr ללא תוספות/הסתרות עמודות/שינויי שמות לעמודות. כבחירת מחדל מבצע תרגום גם שמבקשים json. renderLanguage שפת חיפוש תרגומים [A-Z] ניתן לבקש תרגום לפי שפה. בחירת מחדל HE
.
חישוב סדר המרת ותרגום עמודות:
כל שלב דורס תרגום קודם באופן שהוא לא מוחק אותו אלא דורס תרגומים שיש עליהם הגדרה ספציפית.
- קובץ ראשי - יש תרגום כללי (בשרת של ימות המשיח).
- קובץ ספציפי (למשל, קובץ ל
ApprovalAll
) - קובץ ברמת מערכת לפי השפה שנבחרה.. למשל מחפש קובץ:
YMGRLangs\EN\ApprovalAll.ini
- קובץ ברמת מערכת - מחפש את שם הקובץ בסיומת ini בתוך תיקייה
YMGRLangs
שצריכה להיות תחת התיקיה הראשית של המערכת שבתוכה קובץ הini. - קובץ ברמת שלוחה לפי השפה שנבחרה.. למשל מחפש קובץ:
main\1\2\EN\ApprovalAll.ini
- קובץ בשלוחה - קובץ באותה השלוחה של קובץ הymgr עם סיומת ini.
שימו לב! רמת שפה היא רמת מתחת קובץ ללא שפה. למשל, אם אני בוחר שפה EN אבל בקובץ בשלוחה לא בתיקיה של השפה יש לי ערכים המערכת תתחשב בתרגום שלהם.
המענה בעת ההצלחה הוא הקובץ, כמו שנאמר, או במקרה של json:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
yALogsVersion string גירסת מערכת data array מערך שמכיל את תוכן הקובץ במקרה של שגיאה השגיאה תפורט כתגובה בjson.
-
קבלת תנועות יחידות סמסים
הפקודה היא -
GetCustomerSmsTransactions
הפרמטרים הנדרשים
פרמטר תיאור סוג הערות / דוגמא token טוקן string מביא 2000 תנועות אחרונות
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
yAfastVersion string גירסת מערכת rows array מערך תנועות פירוט איבר במערך:
שם תיאור transactionTime זמן תנועה amount סכום תנועה ביחידות description תיאור החיוב newBalance יתרת יחידות עדכנית בביצוע הפעולה expireDate תאריך תפוגה עדכני בביצוע הפעולה who מבצע הפעולה -