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

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

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

      הפעלת צינתוק

      הפקודה היא - 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" // מספר לא תקין
      }
      

      לפניות בנוגע לפורום: shmuel@yemot.co.il

      תגובה 1 תגובה אחרונה תגובה ציטוט 17
      • שמואל
        שמואל נערך לאחרונה על ידי שמואל

        ניהול רשימות צינתוקים במודול צינתוקים חינמיים

        הפקודה היא - 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 הרשימה שאופסה

        באם תיהיה שגיאה יחזיר שגיאה

        לפניות בנוגע לפורום: shmuel@yemot.co.il

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

          שליחת פקס

          הפקודה היא - 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

          בעת שגיאה תפורט השגיאה והבעיה.

          לפניות בנוגע לפורום: shmuel@yemot.co.il

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

            בדיקה האם קובץ קיים

            הפקודה היא - 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

            לפניות בנוגע לפורום: shmuel@yemot.co.il

            תגובה 1 תגובה אחרונה תגובה ציטוט 11
            • שמואל
              שמואל נערך לאחרונה על ידי שמואל

              שליחת סמסים

              הפקודה היא - 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 אובייקט המכיל את המספרים שאילהם לא נשלחה ההודעה כולל הסיבה

              במקרה של שגיאה השגיאה תפורט.

              לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                הקמת שיחת גישור

                הפקודה היא - 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

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

                במקרה של שגיאה השגיאה תפורט.

                לפניות בנוגע לפורום: shmuel@yemot.co.il

                תגובה 1 תגובה אחרונה תגובה ציטוט 3
                • שמואל
                  שמואל נערך לאחרונה על ידי שמואל

                  קבלת מידע בזמן אמת על שלוחת תור

                  הפקודה היא - 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 מזהה שיחת תור לצורך ביצוע פעולות

                  במקרה של שגיאה השגיאה תפורט.

                  לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                    קבלת מידע על המערכת

                    הפקודה היא - 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 וואצפון החדש

                    לפניות בנוגע לפורום: shmuel@yemot.co.il

                    תגובה 1 תגובה אחרונה תגובה ציטוט 12
                    • שמואל
                      שמואל נערך לאחרונה על ידי

                      קבלת דוח קמפיין

                      הפקודה היא - ViewCampaignReports


                      הדוחות המתקבלים בממשק זה הם דוחות על קמפיינים שפירוט החיוב שלהם מתחיל ב

                      Start-YA-
                      

                      בלבד.
                      למשל:

                      90a20430-33d2-4ec0-8755-9efc0d11a72b-image.png


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

                      פרמטר סוג ערך דוגמא
                      token string טוקן
                      CampaignId string מזהה הקמפיין המבוקש. מזהה הקמפיין הוא כפי המופיע בדוח היחידות עם הסרה של Start-YA- מההתחלה. SMS-3-0773137770-Yemot-1641217161871
                      json Boolean יש לשלוח ערך 1 על מנת לקבל מידע ב JSON 1

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

                      במידה שהבקשה תקינה, ערך "report" יכיל את הדוח של הקמפיין.
                      שימו לב, מבנה התגובה של הדוחות יוכל להשתנות בהתאם לסוג הקמפיין, ההסבר כרגע הוא על דוח של קמפיין סמס:

                      מאפיין סוג ערך
                      CampaignData Object מידע כללי על הקמפיין
                      report Object כל איבר באובייקט הוא מספר טלפון שאליו נשלח הקמפיין ומכיל את המידע עליו.

                      דוגמא למבנה מלא של דוח סמס:

                      daa8618c-6add-495d-b871-558057919b20-image.png

                      לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                        הוספה ואימות של זיהוי ספיישל

                        אימות תקף לשנה אחת. לאחר שנה מהאימות המספר יוסר ויהיה צורך לאמת אותו בשנית. אימות של מספר קיים יאריך את תוקף האימות של המספר בשנה מזמן האימות.

                        הפקודה היא - 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 בהצלחה

                        לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                          מערכת תזמון משימות

                          שימו לב, לע"ע לא יכול להיות מעל 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 מספר המשימות שנמחקו

                          לפניות בנוגע לפורום: shmuel@yemot.co.il

                          תגובה 1 תגובה אחרונה תגובה ציטוט 11
                          • שמואל
                            שמואל נערך לאחרונה על ידי שמואל

                            שליחת קמפיין הודעת 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"
                              }
                            }
                            

                            לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                              הפקת דוח מקובץ 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.

                              לפניות בנוגע לפורום: shmuel@yemot.co.il

                              תגובה 1 תגובה אחרונה תגובה ציטוט 10
                              • שמואל
                                שמואל נערך לאחרונה על ידי שמואל

                                קבלת תנועות יחידות סמסים

                                הפקודה היא - GetCustomerSmsTransactions

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

                                פרמטר תיאור סוג הערות / דוגמא
                                token טוקן string

                                מביא 2000 תנועות אחרונות


                                מאפיין סוג הסבר דוגמא
                                responseStatus string סטטוס הפעולה OK
                                yAfastVersion string גירסת מערכת
                                rows array מערך תנועות

                                פירוט איבר במערך:

                                שם תיאור
                                transactionTime זמן תנועה
                                amount סכום תנועה ביחידות
                                description תיאור החיוב
                                newBalance יתרת יחידות עדכנית בביצוע הפעולה
                                expireDate תאריך תפוגה עדכני בביצוע הפעולה
                                who מבצע הפעולה

                                לפניות בנוגע לפורום: shmuel@yemot.co.il

                                תגובה 1 תגובה אחרונה תגובה ציטוט 3
                                • שמואל
                                  שמואל נערך לאחרונה על ידי שמואל

                                  בדיקה האם תיקייה קיימת

                                  הפקודה היא - CheckIfFolderExists

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

                                  פרמטר תיאור סוג
                                  token טוקן string
                                  path נתיב במערכת. דוגמאות למטה string

                                  מענה בעת הצלחה:

                                  מאפיין סוג הסבר דוגמא
                                  responseStatus string סטטוס הפעולה OK
                                  folderExists bool האם התיקייה קיימת
                                  path string המיקום שלה ivr/10

                                  לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                                    חשבונות SIP


                                    תיעוד api הנוגע לחשבונות SIP

                                    כל השירותים שקשורים לSIP קיימים רק בשרתים תומכים.
                                    בכל פניה לשרת שלא תומך תתקבל תגובה:

                                    {
                                    responseStatus: "ERROR",
                                    message: "שרת זה אינו תומך במערכת SIP",
                                    yAfastVersion: "any"
                                    }
                                    

                                    מאפיינים

                                    לכל חשבון SIP במערכת יש מספר מאפיינים

                                    1. מספר החשבון במערכת (למשל 1 2 וכן הלאה)
                                    2. שם המשתמש להתחברות
                                      בדרך כלל שם המשתמש מורכב ממספר המערכת ומספר החשבון.
                                      למשל 0772222770=2 זהו שם המשתמש של חשבון 2 במערכת 0772222770
                                    3. מספר שלוחה - כל מספר שנמצא בטווח מ-200 ועד 10,000
                                      מספר שלוחה הינו מאפיין הנתון לבחירה של מנהל המערכת וניתן לשנות אותו בכל עת.
                                      הדבר משמש עבור חיוגים פנימיים בין החשבונות. (למשל כדי לחייג משלוחה 200 לשלוחה 201 יש לחייג למספר "201" במקרה כזה מה שיופיע על הצג אצל מקבל השיחה זה "200")
                                    4. סיסמת התחברות
                                    5. פרוטוקול 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.

                                    לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                                      שינוי שימוש (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

                                      לפניות בנוגע לפורום: shmuel@yemot.co.il

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

                                        קבלת מידע כללי על תיקיה (שלוחה)

                                        הפקודה היא GetIVR2DirStats

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

                                        פרמטר תיאור הערות
                                        token טוקן חובה
                                        path נתיב תיקייה חובה. לדוגמה: / עבור שלוחה ראשית. 1 עבור שלוחה 1 ext/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 של מעלה הקובץ

                                        לפניות בנוגע לפורום: shmuel@yemot.co.il

                                        תגובה 1 תגובה אחרונה תגובה ציטוט 11
                                        • הוזכר על-ידי  ש שמואל ש. 
                                        • הוזכר על-ידי  צ צדיק תמים 
                                        • הוזכר על-ידי  צ צדיק תמים 
                                        • הוזכר על-ידי  א אברהם מנס 
                                        • הוזכר על-ידי  ל לעזור לכולם 
                                        • שמואל
                                          שמואל נערך לאחרונה על ידי שמואל

                                          ניהול תור אונליין


                                          שימו לב, ניהול התור אונליין אפשרי לשיחות ממתינות בתור בלבד.

                                          את הממתינים בתור מקבלים בשירות 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

                                          לפניות בנוגע לפורום: shmuel@yemot.co.il

                                          תגובה 1 תגובה אחרונה תגובה ציטוט 7
                                          • הוזכר על-ידי  H HMJE22 
                                          • הוזכר על-ידי  ח חדר 1 
                                          • הוזכר על-ידי  ש שמואל ש. 
                                          • שמואל
                                            שמואל נערך לאחרונה על ידי שמואל

                                            ניהול פרסומפון


                                            הפקודה היא - 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

                                            לפניות בנוגע לפורום: shmuel@yemot.co.il

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