• הרשמה
    • התחברות
    • חיפוש
    • דף הבית
    • אינדקס קישורים
    • פוסטים אחרונים
    • קבלת התראות מהדפדפן
    • משתמשים
    • חיפוש בהגדרות המתקדמות
    • חיפוש גוגל בפורום
    • ניהול המערכת
    • ניהול המערכת - שרת private

    API - גישת מפתחים למערכות

    אזור התעשיה - הגדרות המערכת
    4
    69
    50331
    טוען פוסטים נוספים
    • מהישן לחדש
    • מהחדש לישן
    • הכי הרבה הצבעות
    תגובה
    • הגיבו כנושא
    התחברו בכדי לפרסם תגובה
    נושא זה נמחק. רק משתמשים עם הרשאות מתאימות יוכלו לצפות בו.
    • ימות המשיח
      ימות המשיח ימות המשיח נערך לאחרונה על ידי

      מצ"ב קישור להגדרות הAPI למערכות ימות המשיח.

      מפתחים מוזמנים להשתמש.

      תגובה 1 תגובה אחרונה תגובה ציטוט 13
      • E
        eliyahu ניהול נערך לאחרונה על ידי שמחה - זו הסיסמא

        API גישת מפתחים למערכות

        הAPI המפורסם כאן נותן אפשרות לניהול המערכת שלא דרך אתר הניהול אלא בצורה עצמאית. הדבר מיועד עבור מפתחים המעוניינים להתממשק בצורה אוטומטית עם המערכת. אין כל קשר בין הAPI הזה למודול API

        בכל פעולה בAPI יש 2 חלקים. חלק ראשון - שליחת בקשה לשרת. חלק שני - תשובה מהשרת.

        חלק ראשון: שליחת בקשה לשרת
        שימו לב: לאחר השידרוג ניתן לשלוח בקשות לכל השרתים עם הכתובת הרגילה
        למערכות בשרתי ymt ו-yemot וכן ל:ymta ו-ymtb כתובת ה-URL למשלוח הבקשה היא

        https://www.call2all.co.il/ym/api/
        

        למערכות בשרתי ymta ו-ymtb ניתן לשלוח בקשות גם לכתובת ה-URL :

        https://private.call2all.co.il/ym/api/
        

        בדוגמאות להלן הכתובת הבסיסית תושמט ובמקומה יופיע {url}$

        את כל הבקשות (למעט העלאת קבצים) ניתן לשלוח בGET או בPOST
        בבקשות POST ניתן לשלוח את הפרמטרים כJSON בתוך הbody. כמובן יש לציין בפניה Content-Type=application/json.

        הבקשה מורכבת מ2 חלקים. חלק 1 פקודה חלק 2 פרמטרים.

        לדוגמה: הפקודה להורדת קובץ היא DownloadFile והפרמטרים הנדרשים הם token path
        במקרה כזה הבקשה בGET תראה כך:

        ${url}DownloadFile?token=${token}&path=${path}
        ובצורה פשוטה יותר
        https://www.call2all.co.il/ym/api/DownloadFile?token=077000000:1234&path=ivr2:/1/1/000.wav
        

        בהמשך נביא את כל הפקודות הקיימות.

        חלק שני: התשובה מהשרת
        כל התשובות מהשרת (למעט הורדת קבצים) מקודדות בפורמט JSON וכוללות את המידע בנוגע לבקשה. בהמשך נביא את סוגי התשובות הקיימות עבור כל בקשה.

        בנוסף, בכל תשובה יכללו המאפיינים הבאים:
        yemotAPIVersion – גרסת הAPI הנוכחית (עשוי לשמש לאיתור בעיות תאימות עם גרסאות עתידיות)
        responseStatus – מידע אודות הפעולה המבוקשת. אם הפעולה המבוקשת הושלמה בהצלחה, הערך יהיה OK אם הפעולה נכשלה, הערך יהיה ERROR ערך FORBIDDEN פירושו שהבקשה הייתה אסורה על ידי השרת, ערך EXCEPTION פירושו שהבקשה גרמה לחריג בשרת.
        מאפיינים נוספים הנשלחים בחלק מהבקשות
        message - הסבר על הפעולה שבוצעה או הסבר על השגיאה.
        messageCode - קוד שגיאה. להלן יובאו כל סוגי הקודים הקיימים. אם במקום קוד שגיאה התקבל הערך null אירעה שגיאה כללית.

        דוגמה לתשובה מהשרת עם הודעת שגיאה:

        {
        "yemotAPIVersion": "1",
        "responseStatus": "ERROR",
        "message": "Username or password is incorrect",
        "messageCode": 1
        }
        

        בדוגמה זו, גירסת הAPI היא 1, הפעולה נכשלה, הסבר על השגיאה זמין במאפיין 'message' קוד השגיאה הוא 1.

        הפונקציות האפשריות בממשק הAPI:

        בגדול כמעט כל הדברים שאפשר לעשות דרך האתר אפשר גם בAPI (הפעלת קמפיינים שינוי שלוחות ניהול קבצים ועוד)

        במדריך זה נחלק את האפשרויות ל3 חלקים.
        חלק 1 התחברות למערכת והגדרות כלליות - שינוי סיסמה העברת יחידות עדכון פרטי משתמש ועוד
        חלק 2 ניהול קמפיינים - הגדרת קמפיינים, הפעלת קמפיין עדכון מספרים ועוד.
        חלק 3 מערכת תוכן - ניהול הקבצים והשלוחות במערכת.

        חלק 1 התחברות למערכת והגדרות כלליות
        התחברות-Login
        התנתקות-Logout
        פרטי המערכת-GetSession
        שינוי סיסמת ניהול-SetPassword
        עדכון פרטי משתמש-SetCustomerDetails
        קבלת רשימת חיובי יחידות-GetTransactions
        העברת יחידות-TransferUnits
        קבלת רשימת שיחות נכנסות-GetIncomingCalls
        העלאת קובץ-UploadFile
        הורדת קובץ-DownloadFile

        חלק 2 ניהול קמפיינים
        קבלת מצב כל תבניות הקמפיינים-GetTemplates
        עדכון תבנית קמפיין-UpdateTemplate
        העלאת והורדת קבצי שמע לקמפיין
        ניהול קבצי שמע בקמפיין (העתקה העברה או מחיקה)
        יצירת תבנית קמפיין חדשה-CreateTemplate
        מחיקת תבנית קמפיין-DeleteTemplate
        הצגת המספרים שברשימת התפוצה-GetTemplateEntries
        עדכון מספר בודד ברשימת תפוצה-UpdateTemplateEntry
        עדכון סטטוס או מחיקה של מספרים מרשימת התפוצה-UpdateTemplateEntries
        מחיקת כל המספרים מרשימת התפוצה-ClearTemplateEntries
        העלאת קובץ טקסט והפיכתו לרשימת טלפונים לתבנית קמפיין-UploadPhoneList
        הפעלת קמפיין-RunCampaign
        מצב הקמפיין-GetCampaignStatus
        הורדת דו"ח קמפיין-DownloadCampaignReport
        קבלת קמפיינים פעילים-GetActiveCampaigns
        ביצוע פעולות בקמפיינים פעילים-CampaignAction
        יצירת קמפיין מתוזמן-ScheduleCampaign
        קבלת קמפיינים מתוזמנים-GetScheduledCampaigns
        מחיקת קמפיין מתוזמן-DeleteScheduledCampaign

        חלק 3 מערכת תוכן
        קבלת מידע מלא על השלוחה-GetIVR2Dir
        קבלת מידע כללי על שלוחה - GetIVR2DirStats
        קבלת מידע על קובץ בודד -GetFile
        ניהול קבצים (שינוי שם, העתקה, העברה ומחיקה)-FileAction
        העלאת קבצים- ראה ערך UploadFile
        הורדת קבצים - ראה ערך DownloadFile
        קבלת תוכן קובץ טקסט-GetTextFile
        העלאת טקסט לקובץ-UploadTextFile
        עדכון סוג שלוחה-UpdateExtension
        הכוונת שיחה - העברת מאזין באפשרות הראשונה לשלוחה אחרת או לניתוק - CallAction
        ניהול חדרי ועידה-CallAction
        שינוי השפה בערוץ
        קבלת סיכום דקות נכנסות למערכת לפי טווח תאריכים-GetIncomingSum
        קבלת לוג סמסים יוצאים-GetSmsOutLog
        פעולות הנוגעות באבטחה של המערכת. צפיה בלוג התחברויות, ניתוק סשנים
        ValidationToken | DoubleAuth | GetLoginLog | GetAllSessions | KillSession | KillAllSessions

        הפעלת צינתוק-RunTzintuk
        בדיקה האם קובץ קיים-CheckIfFileExists
        שליחת SMS מהמערכת-SendSms
        קבלת SMS שהתקבלו במערכת-GetSmsIncomingLog
        הקמת שיחת גישור-CreateBridgeCall
        קבלת מידע בזמן אמת על שלוחת תור-GetQueueRealTime
        קבלת מידע על המערכת - GetCustomerData
        שליחת פקס-SendFax
        קבלת דוח קמפיין-ViewCampaignReports
        מערכת תזמון משימות
        GetTasks | GetTasksData | CreateTask | UpdateTask | DeleteTask

        הוספה ואימות של זיהוי ספיישל-ValidationCallerId
        שליחת קמפיין הודעת TTS
        הפקת דוח מקובץ ymgr (דוחו"ת)-RenderYMGRFile
        פירוט תנועות ביחידות סמסים
        שינוי שימוש (usage) של מספר משנה
        בדיקה האם תיקייה קיימת
        חשבונות ומערכת sip
        ניהול תור אונליין
        ניהול רשימות צינתוקים במודול צינתוקים חינמיים-TzintukimListManagement
        ניהול פרסומפון
        הפעלת קמפיין הנכנס לשלוחה במערכת
        קבלת רישומים לחשבון SIP
        קבלת כל חשבונות הSIP במערכת האם הם רשומים בשרת
        קבלת SMS שהתקבלו במערכת
        קבלת זיהויים מאושרים במערכת להוצאת שיחות/סמסים
        בדיקת זיהוי האם הוא מאושר לשימוש בשיחה/סמס

        תגובה 1 תגובה אחרונה תגובה ציטוט 14
        • E
          eliyahu ניהול נערך לאחרונה על ידי שמחה - זו הסיסמא

          התחברות

          הסבר: בכל הבקשות הנשלחות לשרת יש צורך בפרמטר token שמשמש כקוד התחברות למערכת
          כאשר תשלחו פקודת Login תקינה, תקבלו בחזרה פרמטר token שאת הערך שלו עליכם לציין כשאתם שולחים כל פקודת API.
          ראה להלן דרך נוספת

          הפקודה היא -Login

          הפרמטרים הנדרשים:

          פרמטר תיאור / הערות
          username מספר מערכת
          password סיסמת הניהול של המערכת

          מאפייני תגובת השרת:

          מאפיין ערך הערה
          token טוקן הטוקן שנוצר יפוג לאחר 30 דקות אם לא תתבצע שיחת API עם הטוקן. כמו כן, כל עוד הטוקן תקף יש להשתמש בו ולהימנע מבקשת התחברות נוספת

          שימו לב!
          ישנה דרך נוספת ליצירת טוקן ללא צורך בבקשת Login
          כאשר שולחים כל פקודת API, לרשום בפרמטר token מספר מערכת : סיסמא (username:password)

          לדוגמה:

          ${url}<WebServiceName>?token=${username}:${password}
          
          תגובה 1 תגובה אחרונה תגובה ציטוט 11
          • E
            eliyahu ניהול נערך לאחרונה על ידי eliyahu

            התנתקות
            מחיקת הטוקן שהתקבל בהתחברות

            הפקודה היא - Logout

            הפרמטרים הנדרשים:

            פרמטר תיאור / הערות
            token טוקן

            אין מאפיינים מיוחדים בתגובת השרת

            תגובה 1 תגובה אחרונה תגובה ציטוט 7
            • E
              eliyahu ניהול נערך לאחרונה על ידי eliyahu

              קבלת פרטי המערכת

              הפקודה היא - GetSession

              הפרמטרים הנדרשים:

              פרמטר תיאור / הערות
              token טוקן

              מאפייני תגובת השרת:

              מאפיין סוג ערך
              name שם לקוח
              unitsExpireDate string תאריך תפוגה של היחידות
              email כתובת אימייל
              organization שם ארגון
              contactName שם איש קשר
              phones טלפון
              invoiceName חשבונית על שם
              invoiceAddress כתובת למשלוח חשבונית
              fax פקס
              accessPassword סיסמת גישה למערכת
              units double כמות היחידות שבמערכת
              recordPassword סיסמת הקלטות
              creditFile שם משווק
              username string מספר המערכת
              תגובה 1 תגובה אחרונה תגובה ציטוט 5
              • E
                eliyahu ניהול נערך לאחרונה על ידי eliyahu

                שינוי סיסמת ניהול

                הפקודה היא - SetPassword

                הפרמטרים הנדרשים:

                פרמטר תיאור / הערות
                token טוקן
                password סיסמת הניהול הנוכחית
                newPassword סיסמה חדשה

                אין מאפיינים מיוחדים בתגובת השרת

                תגובה 1 תגובה אחרונה תגובה ציטוט 5
                • E
                  eliyahu ניהול נערך לאחרונה על ידי eliyahu

                  עדכון פרטי משתמש

                  הערה: הפקודה מוחקת את פרטי המשתמש המעודכנים במערכת.

                  הפקודה היא - SetCustomerDetails

                  הפרמטרים הנדרשים:

                  פרמטר תיאור
                  token טוקן פרמטר חובה
                  name שם לקוח
                  email כתובת דוא"ל
                  organization שם ארגון
                  contactName שם איש קשר
                  phones טלפון
                  invoiceName חשבונית על שם
                  invoiceAddress כתובת למשלוח חשבונית
                  fax פקס
                  accessPassword סיסמת גישה
                  recordPassword סיסמת הקלטות

                  אין מאפיינים מיוחדים בתגובת השרת

                  תגובה 1 תגובה אחרונה תגובה ציטוט 5
                  • E
                    eliyahu ניהול נערך לאחרונה על ידי eliyahu

                    קבלת רשימת חיובי יחידות
                    היסטוריה של תנועת יחידות במערכת (כולל דוחות קמפיינים שהסתיימו)

                    הפקודה היא - GetTransactions

                    הפרמטרים הנדרשים:

                    פרמטר תיאור הערות
                    token טוקן חובה
                    from מאיזה תנועה להציג רשות
                    limit מספר מרבי של תנועות שיש לכלול רשות
                    filter סינון תוצאות לפי סוג פעולה campaigns עבור חיובי קמפיינים

                    מאפייני תגובת השרת:

                    מאפיין סוג ערך
                    transactions array מערך אובייקטים (ראה "תבנית אובייקט תנועה" להלן)
                    totalCount int מספר כולל של תנועת יחידות

                    תבנית אובייקט תנועה

                    מאפיין סוג ערך
                    id int מזהה תנועה ייחודי
                    transactionTime string תאריך ושעה (פורמט: yyyy-MM-dd HH:mm:ss)
                    amount double סכום היחידות
                    description string תיאור העסקה. ראה להלן מילות מפתח מיוחדות
                    who string בוצע על ידי:   1) כתובת IP במידה והפעולה בוצעה דרך אתר האינטרנט.   2) מספר טלפון במידה והפעולה בוצעה דרך הטלפון.   3) ADMIN במידה והפעולה בוצעה על ידי שירות הלקוחות.   4) TRANSFER במקרה של העברת יחידות.   5) expire במקרה של פג תוקף.
                    newBalance double כמות יחידות מחודשת לאחר התנועה
                    expireDate string במידה וקיים תאריך תפוגה חדש הוא יופיע בערך זה (בפורמט: yyyy-MM-dd). במידה ולא קיים יתקבל הערך null
                    campaignId string במידה והתנועה שבוצעה היתה הפעלת קמפיין יופיע בערך זה מזהה הקמפיין המתאים (משמש להורדת דוח הקמפיין). במידה ולא, יתקבל הערך null

                    מילות מפתח מיחדות למאפיין description שניתן להשתמש בהן כדי לזהות סוגי פעולות

                    תיאור המתחיל ב פירושו
                    Start- חיוב עבור הפעלת קמפיין
                    transfer to חיוב עבור העברת יחידות למערכת אחרת
                    transfer from יחידות שנוספו בהעברה ממערכת אחרת
                    Units expired פג תוקף היחידות
                    תגובה 1 תגובה אחרונה תגובה ציטוט 4
                    • E
                      eliyahu ניהול נערך לאחרונה על ידי eliyahu

                      העברת יחידות
                      העברת יחידות למערכת אחרת

                      הפקודה היא - TransferUnits

                      הפרמטרים הנדרשים:

                      פרמטר תיאור/הערות
                      token טוקן
                      destination מספר מערכת להעברה
                      amount כמות יחידות להעברה

                      מאפייני תגובת השרת במקרה שהעברה בוצעה בהצלחה:

                      מאפיין סוג ערך
                      destination string מערכת היעד אליה בוצעה ההעברה
                      amount double הסכום שהועבר
                      newBalance double יתרת היחידות במערכת המקור לאחר ביצוע ההעברה

                      במקרה של שגיאה בביצוע ההעברה ההודעות והקודים האפשריים הם כדלקמן:

                      messageCode message הסבר
                      111 Bad destination יעד להעברה לא חוקי: המערכת אינה קיימת או שאינה מורשית לקבל יחידות ממערכת זו
                      112 Bad amount סכום היחידות להעברה אינו חוקי
                      113 Not enough balance יתרת היחידות שבמערכת אינה מאפשרת את ביצוע ההעברה
                      תגובה 1 תגובה אחרונה תגובה ציטוט 7
                      • E
                        eliyahu ניהול נערך לאחרונה על ידי eliyahu

                        קבלת רשימת שיחות הפעילות במערכת

                        הפקודה היא - GetIncomingCalls

                        הפרמטרים הנדרשים:

                        פרמטר תיאור/הערות
                        token טוקן

                        מאפייני תגובת השרת:

                        מאפיין סוג הסבר
                        calls array מערך אובייקטים (ראה "תבנית אובייקט שיחה" להלן)
                        callsCount int מספר כולל של שיחות במערכת

                        תבנית אובייקט שיחה

                        מאפיין ערך
                        did מספר מחוייג
                        callerIdNum מספר מחייג (כולל ערכים של ID val_name במידה וקיים במערכת)
                        duration משך זמן שיחה - בשניות
                        transferFrom האם השיחה הועברה ממערכת אחרת. במידה וכן יופיע הערך מועבר במידה ולא יפיע הערך null
                        id מזהה ייחודי לאורך השיחה
                        path מספר שלוחה (כולל תיאור שלוחה ומספר קובץ במידה וקיים)
                        תגובה 1 תגובה אחרונה תגובה ציטוט 6
                        • E
                          eliyahu ניהול נערך לאחרונה על ידי eliyahu

                          העלאת קובץ


                          הפקודה היא - UploadFile


                          מתודת פניה

                          יש לפנות ב-HTTP POST בפורמט multipart/form-data. (פרמטרים כמו token path וכדומה ניתן לצרף בגוף הפנייה או במחרוזת השאילתה כמו בבקשת GET)

                          שימו לב! ניתן לעלות קובץ בודד בכל פנייה.
                          חשוב לשים לב שיש מגבלה על גודל הקובץ שאפשר לעלות בבקשה אחת (נכון לתאריך 28/09/2022 המגבלה היא 50MB) ולכן אם הקובץ שלכם שוקל יותר מזה, צריך לפצל את הקובץ ולהעלות אותו בחלקים נפרדים וכפי שיובא להלן.


                          הפרמטרים הנדרשים

                          פרמטר תיאור הערות
                          token טוקן חובה
                          path נתיב להעלאה חובה. עבור העלאת קבצים לתיקיות במערכת יש לציין בהתחלה ivr2: ולאחר מכן את הנתיב המלא. למשל לקובץ 000.wav בתיקייה 5 הנתיב יהיה ivr2:5/000.wav. שימו לב שבהעלאה רגילה חובה לציין את שם הקובץ הרצוי, בהעלאה עם מספור אוטומטי (ראה להלן) יש לציין את התיקייה בלבד
                          convertAudio המרת הקובץ בוליאני (1/0). ברירת המחדל היא ללא המרה. אם convertAudio = 1, הקובץ שהועלה יומר אוטומטית לפורמט wav המתאים לטלפוניה. קובץ המקור יכול להיות בכל אחד מפורמטי האודיו הפופולריים (MP3, OGG, WMA וכו '). הערה: פרמטר הנתיב חייב להיות בשם של קובץ היעד לאחר ההמרה (כך שהוא חייב להיות עם סיומת .wav)
                          autoNumbering מספור אוטומטי לקבצי שמע בוליאני (true/false). באפשרות זו יש לציין בפרמטר path את נתיב התיקייה בלבד. למשל לתיקייה 5 יש לציין את הנתיב כך path=ivr2:5/. במקרה כזה, הקובץ יעלה לתיקייה 5 ויקבל את המספור הגבוה ביותר (int) עם סיומת wav.
                          tts הצהרה על קובץ tts בוליאני (1/0). נצרך במקרה של מספור אוטומטי לקבצי tts כדי שהמערכת לא תתן לקובץ את הסיומת wav אלא tts

                          פיצול קובץ לחלקים נפרדים והעלאה לשרת

                          שלב א' - העלאת הקבצים

                          פרמטר תיאור דוגמה
                          qquuid ID יש ליצור באופן רנדומלי לפני הבקשה הראשונה 2017390a-60cf-44ea-822f-27017c13de69
                          qqpartindex אינדקס העלאה 1
                          qqpartbyteoffset עד כה עלה ללא הבקשה הנוכחית בבתים 4000000
                          qqchunksize גודל הבקשה הנוכחית בבתים 4000000
                          qqtotalparts סה"כ חלקים לביצוע (מתחיל ב0 כולל הבקשה האחרונה של החיבור) 8
                          qqtotalfilesize גודל כולל של הקובץ בבתים 29863882
                          qqfilename השם המקורי של הקובץ בוקר טוב.mp3
                          qqfile מקטע של הקובץ שאותו אנחנו מעלים בבקשה הנוכחית (קובץ)
                          uploader מחלקה שמבצעת את העלאה yemot-admin

                          שלב ב' - סיום העלאה ובקשת חיבור לקבצים
                          בסיום העלאה יש לפנות אל - UploadFile?done
                          הפרמטרים שיש לצרף לבקשה

                          פרמטר תיאור דוגמה
                          token טוקן כנ"ל
                          path נתיב כנ"ל
                          convertAudio המרת אודיו כנ"ל
                          autoNumbering מספור אוטומטי כנ"ל
                          tts קובץ tts כנ"ל
                          qquuid ID של מזהה הפעולה 2017390a-60cf-44ea-822f-27017c13de69
                          qqfilename שם מקורי בוקר טוב.mp3
                          qqtotalfilesize גודל כולל 29863882
                          qqtotalparts סך הכל חלקים 8

                          מאפייני תגובת השרת:

                          מאפיין סוג הסבר
                          path string נתיב הקובץ שהועלה, כפי שהועבר על ידי פרמטר הנתיב
                          size long גודל הקובץ שהועלה בבייטים

                          אם convertAudio = 1, יוחזרו בתגובה מאפיינים נוספים :

                          מאפיין סוג הסבר
                          convertedSize long גודל קובץ ה- WAV שהומר בבייטים
                          duration double משך האודיו בשניות

                          במקרה של שגיאה בביצוע ההעברה ההודעות והקודים האפשריים הם כדלקמן:

                          messageCode message הסבר
                          105 System error שגיאה כללית במהלך הטיפול בהעלאה
                          107 File upload expected לא נמצאה קובץ להעלאה בבקשה
                          108 Only single upload per request is supported הועלה יותר מקובץ אחד בבקשה אחת
                          109 path is required דרוש נתיב
                          110 path is invalid הנתיב אינו חוקי

                          על מנת לבדוק העלאות HTTP ניתן להשתמש בטופס פשוט זה:
                          https://www.call2all.co.il/ym/api_upload_test.php

                          תגובה 1 תגובה אחרונה תגובה ציטוט 9
                          • E
                            eliyahu ניהול נערך לאחרונה על ידי eliyahu

                            הורדת קובץ

                            הפקודה היא - DownloadFile

                            הפרמטרים הנדרשים:

                            פרמטר תיאור הערות
                            token טוקן
                            path שם הקובץ להורדה בהמשך יפורט איך לציין את הנתיב של כל קובץ

                            מאפייני תגובת השרת:

                            במידה והקובץ קיים - התגובה תכיל את את תוכן הקובץ המבוקש.
                            במידה והקובץ לא קיים או שהתרחשה שגיאה - התגובה תהיה HTTP 404 Not Found.

                            הערה: שימו לב שהתגובה לבקשה זו אינה JSON (בשונה משאר הבקשות)

                            תגובה 1 תגובה אחרונה תגובה ציטוט 6
                            • E
                              eliyahu ניהול נערך לאחרונה על ידי eliyahu

                              קבלת מצב כל תבניות הקמפיינים

                              הפקודה היא - GetTemplates

                              הפרמטרים הנדרשים

                              פרמטר תיאור / הערות
                              token טוקן

                              מאפייני תגובת השרת:

                              מאפיין סוג הסבר
                              templates array מערך אובייקטים (ראה "אובייקט מזהה תבנית" להלן)

                              אובייקט מזהה תבנית:

                              מאפיין סוג ערך הערות
                              templateId int מזהה התבנית שימו לב לא מדובר במספר הסידורי כמו שמופיע באתר
                              description string תיאור התבנית במידה ולא מוגדר יתקבל הערך null
                              callerId string זיהוי שיחה יוצאת
                              entriesCount int כמות המספרים שברשימת התפוצה פעילים וחסומים
                              blockedEntriesCount int כמות המספרים החסומים
                              incomingPolicy enum מדיניות שיחות נכנסות. ישנם 4 מצבים OPEN BLACKLIST WHITELIST BLOCKED רלוונטי לקמפיין ברירת המחדל בלבד
                              customerDefault boolean האם מדובר בקמפיין ברירת המחדל במידה וכן, יופיע הערך true (-נכון). במידה ולא, יופיע הערך false (-שקר 😲 )
                              maxActiveChannels int הגבלת קווים מחייגים מספר מקסימלי של שיחות פעילות בו זמנית בקמפיין
                              maxBridgedChannels int הגבלת קווים מנותבים מספר מקסימלי של שיחות מנותבות בו זמנית למספר המוגדר בערך bridgeTo. אם מספר הקווים המנותבים מגיע למספר המוגדר כאן, החיוגים בקמפיין ייעצרו עד שמספר הקווים המנותבים ירד. ערך 0 בשדה זה פירושו שאין הגבלת מספר קוים מנותבים
                              originateTimeout double זמן חיוג מקסימלי - בשניות זמן מקסימלי מתחילת החיוג למספר עד למענה השיחה. שיחה שלא נענתה עד זמן זה תירשם בדו"ח כשיחה שנכשלה מסיבת "אין מענה". במידה ומוגדר במערכת מדיניות חיוגים חוזרים באין מענה, המערכת תנסה לחייג שוב למספר שלא נענה בהתאם להגדרה הרלוונטית
                              vmDetect boolean האם האפשרות של זיהוי תא קולי מופעלת במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                              filterEnabled boolean האם האפשרות של קמפיין ממספרים אישיים מופעלת במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                              maxDialAttempts int ניסיונות חיוג מספר מקסימלי של נסיונות חיוג שיבוצעו לאותו מספר בהתאם למדיניות חיוגים חוזרים המוגדרת לקמפיין
                              redialWait int המתנה בין נסיונות חיוג - בשניות זמן המתנה מינימלי בשניות בין נסיונות חיוג לאותו מספר
                              redialPolicy enum מדיניות חיוגים חוזרים. ישנם 3 מצבים - NONE CONGESTIONS FAILED NONE - ללא חיוג חוזר. CONGESTIONS - במידה ולא זמין. FAILED במידה ואין מענה
                              yemotContext enum סוג הקמפיין. ישנם 6 מצבים - SIMPLE REPEAT MESSAGE VOICEMAIL BRIDGE OTHER SIMPLE - השמעת הודעה בלבד. REPEAT - השמעה חוזרת של ההודעה בהקשה על 1 ואישור קבלת ההודעה בהקשה על 7. MESSAGE - שליחת הודעה בדוא"ל בהקשה על 1. VOICEMAIL - השארת הודעה בתא קולי בהקשה על 1 שימו לב! באופן זמני התא הקולי בוטל. BRIDGE - ניתוב שיחה למענה אנושי. OTHER - הגדרה מיוחדת
                              bridgeTo string מספר הטלפון לניתוב במידה והקמפיין מוגדר כניתוב שיחה למענה אנושי
                              playPrivateMsg boolean האם האפשרות של מצב הודעה פרטית מופעלת במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                              messageExists boolean האם קיימת הודעת קמפיין במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                              messageDuration double אורך הודעת הקמפיין - בשניות
                              unitsPerMessage double עלות משוערת ביחידות עבור כל הודעה שמשוגרת
                              moreinfoExists boolean האם קיימת הודעה לפני ניתוב (הודעה המושמעת אחרי שמקבל השיחה לחץ 1) במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                              moreinfoDuration double אורך הודעת הניתוב - בשניות
                              removeRequest enum אפשרויות הסרה. קיימים 2 מצבים - SILENT WITH_MESSAGE SILENT - הסרה בלחיצה על 9 ללא הודעה. WITH_MESSAGE - הסרה בלחיצה על 9 + הודעה סטנדרטית
                              תגובה 1 תגובה אחרונה תגובה ציטוט 6
                              • E
                                eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                עדכון תבנית קמפיין

                                הערה: רק ההגדרות שסופקו יעודכנו, ההגדרות שהושמטו לא ישתנו.

                                הפקודה היא UpdateTemplate

                                הפרמטרים הנדרשים

                                פרמטר סוג תיאור הערות
                                token string טוקן פרמטר חובה
                                templateId int מזהה תבנית פרמטר חובה
                                description string תיאור התבנית
                                callerId string זיהוי שיחה יוצאת
                                incomingPolicy enum (string) מדיניות שיחות נכנסות - רלוונטי לקמפיין ברירת המחדל בלבד. ישנם 4 מצבים OPEN BLACKLIST WHITELIST BLOCKED OPEN - כל אחד יכול להתקשר. BLACKLIST - מספרים שחסומים ברשימת התפוצה לא יוכלו לחייג. WHITELIST - רק מספרים שפעילים ברשימת התפוצה יוכלו לחייג. BLOCKED - אף אחד לא יוכל לחייג
                                customerDefault boolean (1/0) האם להגדיר כקמפיין ברירת המחדל אם כן, יש להגדיר 1. אם לא, יש להגדיר קמפיין אחר
                                maxActiveChannels int הגבלת קווים מחייגים כאן ניתן להגדיר את המספר המקסימלי של שיחות פעילות בו זמנית בקמפיין
                                maxBridgedChannels int הגבלת קווים מנותבים כאן ניתן להגדיר את המספר המקסימלי של שיחות מנותבות בו זמנית למספר המוגדר בערך bridgeTo. אם מספר הקווים המנותבים מגיע למספר המוגדר כאן, החיוגים בקמפיין ייעצרו עד שמספר הקווים המנותבים ירד. ערך 0 בשדה זה פירושו שאין הגבלת מספר קוים מנותבים
                                originateTimeout double זמן חיוג מקסימלי - בשניות זמן מקסימלי מתחילת החיוג למספר עד למענה השיחה. שיחה שלא נענתה עד זמן זה תירשם בדו"ח כשיחה שנכשלה מסיבת "אין מענה"
                                vmDetect boolean (1/0) האם להפעיל את האפשרות של זיהוי תא קולי במידה וכן, יש להגדיר 1. במידה ולא, יש להגדיר 0
                                filterEnabled boolean (1/0) האם להפעיל את האפשרות של קמפיין ממספרים אישיים במידה וכן, יש להגדיר 1. במידה ולא, יש להגדיר 0
                                maxDialAttempts int ניסיונות חיוג מספר מקסימלי של נסיונות חיוג שיבוצעו לאותו מספר בהתאם למדיניות חיוגים חוזרים המוגדרת לקמפיין
                                redialWait double המתנה בין נסיונות חיוג - בשניות זמן המתנה מינימלי בשניות בין נסיונות חיוג לאותו מספר
                                redialPolicy enum (string) מדיניות חיוגים חוזרים. ישנם 3 מצבים - NONE CONGESTIONS FAILED NONE - ללא חיוג חוזר. CONGESTIONS - חיוג חוזר במידה ולא זמין. FAILED חיוג חוזר במידה ואין מענה
                                yemotContext enum (string) סוג הקמפיין. ישנם 5 מצבים - SIMPLE REPEAT MESSAGE VOICEMAIL BRIDGE SIMPLE - השמעת הודעה בלבד. REPEAT - השמעה חוזרת של ההודעה בהקשה על 1 ואישור קבלת ההודעה בהקשה על 7. MESSAGE - שליחת הודעה בדוא"ל בהקשה על 1. VOICEMAIL - השארת הודעה בתא קולי בהקשה על 1 שימו לב! באופן זמני התא הקולי בוטל. BRIDGE - ניתוב שיחה למענה אנושי
                                bridgeTo string מספר הטלפון לניתוב במידה והקמפיין מוגדר כניתוב שיחה למענה אנושי
                                playPrivateMsg boolean (1/0) האם להפעיל את האפשרות של מצב הודעה פרטית במידה וכן, יש להגדיר 1. במידה ולא, יש להגדיר 0
                                removeRequest enum (string) אפשרויות הסרה. קיימים 2 מצבים - SILENT WITH_MESSAGE SILENT - הסרה בלחיצה על 9 ללא הודעה. WITH_MESSAGE - הסרה בלחיצה על 9 + הודעה סטנדרטית

                                מאפייני תגובת השרת

                                מאפיין סוג הסבר
                                templates array נתוני התבנית המעודכנים - זהה לתיאור התבנית בפקודה GetTemplates
                                תגובה 1 תגובה אחרונה תגובה ציטוט 4
                                • E
                                  eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                  העלאת והורדת קבצי שמע לקמפיין

                                  ראה ערך העלאת קובץ כיצד יש להעלות קבצים.
                                  ראה ערך הורדת קובץ כיצד יש להוריד קבצים.

                                  כדי להעלות ולהוריד קבצי שמע יש לציין את הנתיבים הבאים:

                                  הודעת קמפיין קולי

                                  ${templateId}.wav
                                  

                                  הודעת קמפיין sms

                                  ${templateId}.tts
                                  

                                  הודעה לפני ניתוב

                                  ${templateId}-MoreInfo.wav
                                  

                                  כאשר האפשרות של מצב הודעה פרטית מופעלת, ישנם קבצים נוספים המשמשים להפעלת הקמפיין:

                                  ההודעה שמושמעת לכולם לפני ההודעה הפרטית

                                  ${templateId}-First.wav
                                  

                                  הודעה פרטית שמושמעת לטלפון ספציפי

                                  PrivateMsg/${phone}.wav
                                  

                                  הודעה ברירת מחדל שמושמעת במידה ואין הודעה ספציפית עבור הטלפון

                                  PrivateMsg/Default.wav
                                  
                                  תגובה 1 תגובה אחרונה תגובה ציטוט 5
                                  • E
                                    eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                    ניהול קבצי קמפיין

                                    ראה ערכים ניהול קבצים, הצגת תוכן קובץ טקסט, העלאת טקסט לקובץ למידע אודות הפרמטרים הדרושים.

                                    כדי לנהל את קבצי הקמפיין יש לציין את הנתיבים הבאים בפרמטרים what ו-target

                                    הודעת קמפיין קולי

                                    tpl:${templateId}
                                    

                                    הודעת קמפיין sms

                                    tpl:${templateId}:tts
                                    

                                    הודעה לפני ניתוב

                                    tpl:${templateId}:MoreInfo
                                    
                                    תגובה 1 תגובה אחרונה תגובה ציטוט 4
                                    • E
                                      eliyahu ניהול נערך לאחרונה על ידי אהרן שובקס

                                      יצירת תבנית קמפיין חדשה

                                      הערה: ההגדרות של הקמפיין החדש יועתקו מקמפיין ברירת המחדל

                                      הפקודה היא - CreateTemplate

                                      הפרמטרים הנדרשים

                                      פרמטר תיאור
                                      token טוקן
                                      description שם הקמפיין

                                      מאפייני תגובת השרת

                                      מאפיין סוג ערך
                                      templateId int מזהה התבנית החדשה שנוצרה
                                      תגובה 1 תגובה אחרונה תגובה ציטוט 4
                                      • E
                                        eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                        מחיקת תבנית קמפיין

                                        הפקודה היא - DeleteTemplate

                                        הפרמטרים הנדרשים

                                        פרמטר תיאור
                                        token טוקן
                                        templateId מזהה תבנית

                                        אין מאפיינים מיוחדים בתגובת השרת

                                        תגובה 1 תגובה אחרונה תגובה ציטוט 2
                                        • E
                                          eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                          הצגת המספרים שברשימת התפוצה

                                          הפקודה היא - GetTemplateEntries

                                          הפרמטרים הנדרשים

                                          פרמטר תיאור
                                          token טוקן
                                          templateId מזהה תבנית

                                          מאפייני תגובת השרת

                                          מאפיין סוג הסבר
                                          templateId int מזהה תבנית
                                          entries array מערך אובייקטים (ראה "תבנית אובייקט מספר" להלן)

                                          תבנית אובייקט מספר

                                          מאפיין סוג ערך הערות
                                          rowid int מזהה ייחודי של המספר ברשימת התפוצה
                                          index מיקום המספר ברשימת התפוצה
                                          phone string מספר טלפון
                                          blocked boolean האם המספר מוגדר כחסום במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                                          name string שם משוייך במידה ולא מוגדר, יתקבל הערך null
                                          moreinfo string מידע נוסף במידה ולא מוגדר, יתקבל הערך null
                                          תגובה 1 תגובה אחרונה תגובה ציטוט 3
                                          • E
                                            eliyahu ניהול נערך לאחרונה על ידי eliyahu

                                            עדכון מספר בודד ברשימת תפוצה

                                            הפקודה היא - UpdateTemplateEntry

                                            הפרמטרים הנדרשים

                                            פרמטר תיאור הערות
                                            token טוקן פרמטר חובה
                                            templateId מזהה תבנית פרמטר חובה
                                            rowid מזהה ייחודי של המספר ברשימת התפוצה אם הפרמטר מושמט והמספר לא קיים, תיווצר שורה חדשה
                                            phone מספר טלפון אם המספר קיים ברשימת התפוצה והפרמטר rowid הושמט, המספר יעודכן מחדש והערכים name ו-moreinfo שהיו קיימים יימחקו
                                            name שם
                                            moreinfo מידע נוסף
                                            blocked האם לעדכן כחסום במידה וכן, יש להגדיר 1. במידה ולא, יש להגדיר 0

                                            אין מאפיינים מיוחדים בתגובת השרת

                                            תגובה 1 תגובה אחרונה תגובה ציטוט 2
                                            • פוסט ראשון
                                              פוסט אחרון