API - גישת מפתחים למערכות
-
בדיקה האם קובץ קיים
הפקודה היא -
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 מבצע הפעולה -
-
חשבונות SIP
תיעוד api הנוגע לחשבונות SIP
כל השירותים שקשורים לSIP קיימים רק בשרתים תומכים.
בכל פניה לשרת שלא תומך תתקבל תגובה:{ responseStatus: "ERROR", message: "שרת זה אינו תומך במערכת SIP", yAfastVersion: "any" }
מאפיינים
לכל חשבון SIP במערכת יש מספר מאפיינים
- מספר החשבון במערכת (למשל
1
2
וכן הלאה) - שם המשתמש להתחברות
בדרך כלל שם המשתמש מורכב ממספר המערכת ומספר החשבון.
למשל0772222770=2
זהו שם המשתמש של חשבון 2 במערכת 0772222770 - מספר שלוחה - כל מספר שנמצא בטווח מ-200 ועד 10,000
מספר שלוחה הינו מאפיין הנתון לבחירה של מנהל המערכת וניתן לשנות אותו בכל עת.
הדבר משמש עבור חיוגים פנימיים בין החשבונות. (למשל כדי לחייג משלוחה 200 לשלוחה 201 יש לחייג למספר "201" במקרה כזה מה שיופיע על הצג אצל מקבל השיחה זה "200") - סיסמת התחברות
- פרוטוקול SIP להתקשרות (נכון לעכשיו התמיכה היא בפרוטוקולים UDP WSS)
יצירת חשבון
הפקודה היא -
CreateSipAccount
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string extNumber אפשר לציין מספר שלוחה. לא חובה. מספר שלוחה יכול להיות בין 200 ל10000. int מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
accountID string שם המשתמש שם החשבון שנוצר. accountNumber int מספר החשבון במערכת (לא מספר שלוחה) PASS string הסיסמה של החשבון להתחברות
קבלת רשימת החשבונות במערכת
הפקודה היא -
GetSipAccountsInCustomer
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
accounts array מערך חשבונות accountLimit int כמות החשבונות שהלקוח יכול ליצור במערכת 6 מערך החשבונות
מאפיין סוג הסבר דוגמא id string שם המשתמש של החשבון accountNumber int מספר חשבון במערכת customerExtension int מספר שלוחה, אם מוגדר transport string סוג התקשורת המותרת בחשבון. transport-udp
\transport-wss
callerid string מערכת לחיוב יחידות specialCallerID string זיהוי מיוחד להוצאת שיחות password string סיסמה להתחברות בsip created_date string תאריך יצירה של החשבון
שינוי התעבורה המותרת בחשבון - UDP \ WSS
מאפשר לשנות את סוג התעבורה המותרת. תיתן להתחבר לחשבונות הsip עם תקשורת של UDP או עם חיבור לwebsocet של שרת הסיפ, למשל כדי להטמיע את השירות בדפדפן על ידי פרוטוקול webRTC למשל בשימוש עם ספריית jssip.
הכתובת של שרת הsip להתחברות עם websocket היא
wss://sip.yemot.co.il:8089/ws
, החיבור הוא על בחיבור מאובטח בלבד (wss://
).הפקודה היא -
SipToWss
|SipToUdp
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string accountNumber מספר החשבון, אם לא צוין מוגדר על החשבון הראשון int מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
הגדרת זיהוי יוצא קבוע
מאפשר להגדיר את הזיהוי היוצא של החשבון
מיותר לציין, שזה יעבוד רק אם המספר מאושר במערכת או שהוא מספר משנה + מספר ישראלי תקין.
הפקודה היא -
EditCallerIdInSipAccount
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string accountNumber מספר חשבון int callerId זיהוי יוצא string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
ניתן לבקש זיהוי יוצא מיוחד גם בעת השיחה עצמה ללא שינוי בהגדרות החשבון על ידי צירוף של header בשם
X-YemotCallerId
ל INTIVE של השיחה היוצאת.
במקרה של סתירה בין המופיע בהגדרות החשבון להגדרות השיחה הנוכחית, הגדרות השיחה יגברו.
מחיקת חשבון
הפקודה היא -
DeleteSipAccount
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string accountNumber מספר החשבון למחיקה כמספר, או מערך של מספרי חשבונות sip למחיקה. int / array מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
affected_rows int מספר חשבונות הsip שנמחקו
ניהול מספר שלוחה
הפקודה היא -
SipExtensionManagement
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string SipExtensionManagement פעולה לביצוע. Get
עבור קבלת מספר השלוחה ללא ביצוע שינוי.Set
עבור שינוי או הגדרה של מספר שלוחה.string accountNumber מספר חשבון ברירת מחדל החשבון הראשון extNumber מספר שלוחה. לא חובה בפעולת Get, אם לא צויין בפעולת Set מספר השלוחה ימחק. מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
extNumber int מספר השלוחה. במידה שמדובר בפעולת Set זה יכיל את המספר שלוחה החדש.
מידע טכני נוסף על קבלת שיחות לחשבון SIP
ב
INVITE
שמגיע מימות המשיח ללקוח בכל שיחה יש 2 header שנוספים בכל שיחה.X-Yemot-Path
= מספר השלוחה שממנה הגיע השיחה.
X-Yemot-CallID
= מזהה השיחה. ניתן להשוות את זה עם מודול תור בשימוש עם queue_api_send=yes, שם זה מגיע לשרת בערךYemotCallID
. - מספר החשבון במערכת (למשל
-
שינוי שימוש (usage) של מספר משנה
הפקודה היא -
SetSecondaryDidUsageDescription
הפרמטרים הנדרשים
פרמטר תיאור סוג token טוקן string secondaryDidId מזהה המספר משנה. מתקבל במערך המספרים המשניים ב GetCustomerData int newUsage שימוש חדש, כפי המוסבר מטה. string ניתן לשנות שימוש של מספר משנה לאחד משתי הקידומות האלה:
sip:[0-9] goto:/[A-Za-z0-9א-ת/]
בנוסף, עם השימוש הישן הוא לא משהוא שאפשר לבחור אותו לא יתאפשר בכלל לשנות את השימוש.
הסבר על שימוש sip:X:
מאפשר לשייך מספר משנה למספר חשבון sip במערכת, כך שבחיוג ישיר למספר המשנה יגיעו לחשבון הsip. למשל, כדי לשייך לחשבון מספר 5 של המערכת יש לכתוב
sip:5
. גם ציון מספר שלוחה אפשרי ויחייג למספר השלוחה. האפשרות תעבור רק בשרתים תומכי sip.הסבר על שימוש goto:/:
מאפשר לשייך מספר משנה לשלוחה ספציפית במערכת - למשל, כדי לשייך לשלוחה
1/20/11
יש לכתובgoto:/1/20/11
.
מענה בעת הצלחה:
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
status bool הצלחה ture -
קבלת מידע כללי על תיקיה (שלוחה)
הפקודה היא
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 queuePath מיקום התור. זהה לצורה שבה שולחים שם תור ב GetQueueRealTime string callIds מערך מזהי שיחות תור (מתקבל גם ב GetQueueRealTime במערך הממתינים 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" } }
השהיית נציג / החזרת נציג לפעילות
בפעולת אלה לא צריך לשלוח
callIds
, אלא רקqueuePath
הפעולה היא -pause
- השהיית נציג
הפעולה היא -unpause
- ביטול נציג מהשהייההפרמטרים הנדרשים בנוסף
פרמטר תיאור סוג agent שם הנציג. זהה לשם שמגיע ב GetQueueRealTime['members'][?]['agent']
string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה 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
- רשימה מפורשת עם הפרדה של
-
-
-
-
-
-
-
-
-
-
קבלת רישומים לחשבון SIP - SipGetContexts
הפקודה היא -
SipGetContexts
בכל פניה יש לצרף:
פרמטר תיאור סוג token טוקן string accountNumber ניתן לציין מספר חשבון sip, באם ריק, זה החשבון הראשון string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
contexts array טבלאת רישומים מערך, יבואר מטה מבנה האובייקט אובייקט במערך contexts
בעיקרון, לא אמור להיות יותר מרישום אחד פעיל.
מאפיין סוג הסבר דוגמא expiration_time string זמן התפוגה של הרישום, באם השלוחה שולח keep_alive - הזמן מתארך 2024-06-04 15:43:38 uri string הURI לחיוג בפועל לשיחה נכנסת sip:0773137770@192.168.1.99:5060 user_agent string הפלטפורה שמחוברת Yealink SIP-T29G via_addr string ניתוב דרך. זה יכול להיות גם כתובת פנימית של השלוחה 192.168.1.110 via_port string ניתוב בפורט 5060 -
קבלת חשבונות הSIP במערכת בדגש על בדיקה אם הם רשומים - GetSipAccountsRegisteredStatus
הפקודה היא -
GetSipAccountsRegisteredStatus
בכל פניה יש לצרף:
פרמטר תיאור סוג token טוקן string מענה בעת הצלחה
מאפיין סוג הסבר דוגמא responseStatus string סטטוס הפעולה OK
accounts array טבלאת חשבונות מערך, יבואר מטה מבנה האובייקט אובייקט במערך accounts
מאפיין סוג הסבר דוגמא userName string שם המשתמש של החשבון 0773137770 createdDate string זמן יצירת החשבון 2021-06-26 23:00:00 registered bool האם רשום? true -
-