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

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

    אזור התעשיה - הגדרות המערכת
    5
    70
    52616
    טוען פוסטים נוספים
    • מהישן לחדש
    • מהחדש לישן
    • הכי הרבה הצבעות
    תגובה
    • הגיבו כנושא
    התחברו בכדי לפרסם תגובה
    נושא זה נמחק. רק משתמשים עם הרשאות מתאימות יוכלו לצפות בו.
    • E
      eliyahu ניהול נערך לאחרונה על ידי eliyahu

      קבלת מצב קמפיין

      מאפשר לבדוק את הסטטוס הנוכחי של קמפיין כפי שהתקבל בקריאת RunCampaign

      הפקודה היא GetCampaignStatus

      פרמטרים בבקשה

      פרמטר חובה/אופציונלי תיאור
      token חובה טוקן
      campaignId חובה מזהה הקמפיין, כפי שהתקבל בקריאת RunCampaign
      entries אופציונלי הצגת רשומות בקמפיין (מספרי טלפון) ראו להלן "הצגת רשומות בקמפיין". במידה ולא צוין, ברירת המחדל היא שלא מציג את מצב הרשומות בקמפיין אלא רק את המצב הכללי של הקמפיין.
      range אופציונלי טווח ערכים להצגה (מקסימום/מינימום) ראו להלן "הגדרת טווח להצגה"

      הצגת רשומות בקמפיין

      סוגי הערכים האפשריים בפרמטר entries

      ערך הסבר
      all הכל
      pending בהמתנה לחיוג
      blocked חסומים
      done בוצע
      accepted אישרו מסירה
      failed נכשלו
      no_answer אין מענה
      busy תפוס
      amd מענה תא קולי
      ringing בחיוג
      up בשיחה
      bridged מנותבים
      remove_request בקשה להסרה
      redial ממתינים לחיוג חוזר
      canceled בוטל
      error שגיאה כללית

      הגדרת טווח להצגה

      בפרמטר range יש להגדיר את טווח הרשומות להצגה.
      הפורמט הוא [min]:[max].
      לדוגמה 1:100 עבור 100 הרשומות הראשונות, או : עבור כל הרשומות.
      ברירת מחדל מחזיר 10,000 ערכים ראשונים.


      פרמטרים בתשובה במצב הצלחה

      מבנה התגובה

      {
          "responseStatus": "OK",
          "campaign": {
              "campaignId": "0772222770-1117319-2025-01-22-10-07-54-414-API",
              "campaignStatus": "RUNNING",
              "templateId": 1117319,
              "who": "0.0.0.0",
              "callerId": "0772222770",
              "blockedEntries": 0,
              "pendingEntries": 0,
              "activeEntries": 1,
              "bridgedEntries": 0,
              "redialEntries": 0,
              "doneEntries": 0,
              "failedEntries": 0,
              "totalEntries": 1,
              "totalDialed": 3,
              "totalSuccessful": 1,
              "totalBridged": 0,
              "totalFailed": 2,
              "totalIncoming": 0,
              "totalIncomingBridged": 0,
              "maxActiveChannels": 100,
              "maxBridgedChannels": 0,
              "maxDialAttempts": 3,
              "redialWait": 10.0,
              "redialPolicy": "FAILED",
              "vmDetect": false,
              "filterEnabled": false,
              "playPrivateMsg": false,
              "runTime": 150.306,
              "currentPrice": 1.0,
              "paused": false,
              "entries": [
                  {
                      "phone": "0773137770",
                      "name": null,
                      "moreinfo": "זוהי הודעת בדיקה",
                      "entryStatus": "up",
                      "duration": 3680,
                      "bridgedDuration": null,
                      "bridged": false,
                      "startTime": "2025-01-22 10:10:14",
                      "currentPrice": 1.0,
                      "redials": [
                          {
                              "entryStatus": "no_answer",
                              "duration": null,
                              "bridgedDuration": null,
                              "bridged": false,
                              "startTime": "2025-01-22 10:07:54"
                          },
                          {
                              "entryStatus": "no_answer",
                              "duration": null,
                              "bridgedDuration": null,
                              "bridged": false,
                              "startTime": "2025-01-22 10:09:04"
                          }
                      ]
                  }
              ]
          },
          "yemotAPIVersion": 6
      }
      

      מבנה תגובת הקמפיין

      מאפיין סוג תיאור
      campaignId מחרוזת מזהה הקמפיין.
      campaignStatus enum סטטוס הקמפיין: אחד מ-STOPPED, RUNNING, PAUSED, STOPPING FINISHED.
      templateId מספר מזהה התבנית שעל בסיסה פועל הקמפיין.
      who מחרוזת כתובת IP או מספר הטלפון שהפעיל את הקמפיין.
      callerId מחרוזת מספר טלפון היוצא עבור הקמפיין.
      blockedEntries מספר מספר הרשומות החסומות.
      pendingEntries מספר מספר הרשומות הממתינות.
      activeEntries מספר מספר הרשומות הפעילות כעת.
      bridgedEntries מספר מספר הרשומות שחוברו בהצלחה.
      redialEntries מספר מספר הרשומות המחכות לחיוג חוזר.
      doneEntries מספר מספר הרשומות שהושלמו בהצלחה.
      failedEntries מספר מספר הרשומות שנכשלו.
      totalEntries מספר סך כל הרשומות בקמפיין.
      totalDialed מספר סך כל החיוגים (כולל חיוגים חוזרים).
      totalSuccessful מספר סך השיחות המוצלחות.
      totalBridged מספר סך כל השיחות שחוברו.
      totalFailed מספר סך כל השיחות שנכשלו.
      totalIncoming מספר סך השיחות הנכנסות במהלך הקמפיין.
      totalIncomingBridged מספר סך השיחות הנכנסות שחוברו.
      maxActiveChannels מספר המספר המרבי של שיחות פעילות מותרות בקמפיין.
      maxBridgedChannels מספר המספר המרבי של שיחות מחוברות מותרות בקמפיין.
      maxDialAttempts מספר מספר הניסיונות המרבי לחיוג חוזר.
      redialWait מספר זמן ההמתנה המינימלי בין ניסיונות חיוג חוזר (בשניות).
      redialPolicy enum מדיניות החיוג החוזר: NONE, CONGESTIONS, או FAILED.
      vmDetect בוליאני האם זיהוי תא קולי מופעל.
      playPrivateMsg בוליאני האם מצב הודעה פרטית מופעל.
      runTime מספר זמן הריצה הכולל של הקמפיין (בשניות).
      currentPrice מספר המחיר הנוכחי שנגבה עבור הקמפיין (ביחידות).
      paused בוליאני האם הקמפיין במצב מושהה.

      שגיאות אפשריות

      קוד הודעה הודעה הסבר
      106 קמפיין לא נמצא campaignId לא נמצא עבור המשתמש.

      הערות

      • כאשר נכלל פרמטר entries, התגובה תכיל את שדה entries עם מידע מפורט על הרשומות (ראו מבנה JSON בתיאור המפורט).
         "entries": [
           {
             "phone": string,
             "name": string|null,
             "moreinfo": string|null,
             "entryStatus": entry_status_enum,
             "duration": time_ms|null,
             "bridgedDuration": time_ms|null,
             "bridged": true|false,
             "startTime": sql_time|null,
             "redials": [
               {
                 "entryStatus": entry_status_enum,
                 "duration": null,
                 "bridgedDuration": null,
                 "bridged": true|false,
                 "startTime": sql_time|null
           },
           {
             "phone": "0501234567",                       // מספר הטלפון של הנמען
             "name": "Yosef",                             // שם (אם קיים)
             "moreinfo": "Jerusalem",                          // מידע נוסף (אם קיים)
             "entryStatus": "bridged",                    // סטטוס נוכחי של הרשומה (למשל: bridged, done, no_answer)
             "duration": 5200,                            // משך השיחה הכולל במילישניות
             "bridgedDuration": 4100,                     // משך זמן ניתוב שיחה
             "bridged": true,                             // האם השיחה מנותבת
             "startTime": "2025-05-25 10:32:00",          // מתי התחילה השיחה (זמן החיוג)
             "redials": [                                 // ניסיונות חוזרים (אם היו)
               {
                 "entryStatus": "busy",                // סטטוס ניסיון חוזר זה
                 "duration": null,                        // משך שיחה בניסיון זה (null כי לא נענתה)
                 "bridgedDuration": null,                 // משך זמן ניתוב שיחה
                 "bridged": false,                        // האם בוצע ניתוב שיחה
                 "startTime": "2025-05-25 10:29:00"       // זמן תחילת ניסיון החיוג הזה
               },
               {
                 "entryStatus": "no_answer",              // ניסיון חוזר נוסף - לא נענה
                 "duration": null,                       // 
                 "bridgedDuration": 0,                    // 
                 "bridged": false,                        //
                 "startTime": "2025-05-25 10:30:30"       //
               }
             ]
           },
           {
             "phone": "0521234567",                       // מספר טלפון נוסף
             "name": null,                                // לא סופק שם
             "moreinfo": null,               // לא סופק
             "entryStatus": "done",                       // הסתיים בהצלחה
             "duration": 8000,                            // משך שיחה
             "bridgedDuration": 0,                        // 
             "bridged": false,                            // 
             "startTime": "2025-05-25 10:35:00",          // מתי בוצעה השיחה
             "redials": []                                // לא היו ניסיונות חוזרים
           }
         ]
      
      תגובה 1 תגובה אחרונה תגובה ציטוט 2
      • E
        eliyahu ניהול נערך לאחרונה על ידי

        הורדת דו"ח קמפיין-DownloadCampaignReport

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

          קבלת קמפיינים פעילים-GetActiveCampaigns

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

            ביצוע פעולות בקמפיין בזמן אמת

            הפקודה היא CampaignAction

            תיאור
            שירות זה מאפשר לבצע פעולות ניהול בזמן אמת על קמפיין פעיל.
            המערכת תומכת בשני סוגי פעולות:

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

            חלק א' – פעולות כלליות בקמפיין

            פרמטרים בבקשה

            פרמטר חובה תיאור
            token כן טוקן
            campaignId כן מזהה הקמפיין, כפי שהוחזר מ־RunCampaign.
            action כן הפעולה שיש לבצע (ראו טבלה להלן).
            value תלוי ערך נלווה לפעולה (למשל 0, 1 או מספר ערוצים).

            פעולות כלליות נתמכות (action)

            ערך (action) תיאור ערך value נדרש
            stop עצירת הקמפיין באופן מיידי. לא נדרש
            setPaused הפעלת/ביטול מצב מושהה – 1 להשהיה, 0 לביטול. 0 או 1
            setMaxActiveChannels שינוי כמות מקסימלית של שיחות פעילות בו־זמנית במהלך הקמפיין. מספר
            setMaxBridgedChannels שינוי כמות מקסימלית של שיחות מנותבות בו־זמנית במהלך הקמפיין. מספר

            מבנה תגובה

            {
              "responseStatus": "OK",
              "campaign": { ... },         /// סטטוס מעודכן של הקמפיין (ראו פירוט בהמשך)
              "action": "setPaused",       /// הפעולה שבוצעה
              "value": "1"                 /// הערך שנשלח לביצוע הפעולה
            }
            

            חלק ב' – פעולות על מספרים ספציפיים

            פרמטרים בבקשה

            פרמטר חובה תיאור
            token כן טוקן
            campaignId כן מזהה הקמפיין
            action כן אחת מהפעולות: add, block, hangup.
            value כן רשימת מספרים לביצוע הפעולה – בפורמט : או JSON (ראו להלן).

            פעולות נתמכות במספרים (action)

            ערך (action) תיאור פעולה
            add הוספת מספרים לרשימת החיוג של הקמפיין (גם תוך כדי ריצה).
            block חסימת מספרים – לא יבוצעו אליהם חיוגים נוספים.
            hangup ניתוק מיידי של שיחות פעילות למספרים שצוינו.

            פורמט value – רשימת מספרים

            אפשרות 1: מחרוזת מופרדת ב־:

            0501234567:0527654321
            

            אפשרות 2: JSON מלא כמו ב־RunCampaign

            {
              "0501234567": "הודעה מותאמת אישית",
              "0527654321": {
                "name": "חיים",
                "moreinfo": "מזכרת בתיה",
                "text": "שלום! זו הודעת תזכורת"
              }
            }
            

            מבנה תגובה

            {
              "responseStatus": "OK",
              "campaign": { ... },         /// סטטוס מעודכן של הקמפיין
              "action": "add",             /// הפעולה שבוצעה
              "value": null,               /// ערך שנשלח (אם רלוונטי)
              "data": [
                {
                  "phone": "0501234567",
                  "action": "add"          /// הפעולה שבוצעה בפועל על המספר (ראה טבלה בהמשך)
                },
                {
                  "phone": "0527654321",
                  "action": "blocked"
                }
              ],
              "yemotAPIVersion": 6
            }
            

            אפשרויות ערך ב־data[].action

            ערך (action) תיאור הפעולה שבוצעה בפועל על המספר
            add המספר נוסף לקמפיין
            addblocked המספר נוסף אך מיד סומן כחסום
            block המספר נחסם ולא יחוייג שוב בקמפיין
            unblock בוטלה החסימה מהמספר
            hangup השיחה למספר זה נותקה (אם הייתה פעילה)
            failed המספר סומן כ"שיחה נכשלה" ולא יחוייג שוב

            campaign – אובייקט סטטוס הקמפיין

            האובייקט campaign המוחזר בתגובה מכיל את הסטטוס הנוכחי של הקמפיין, והוא תואם בדיוק למבנה שמוחזר מהשירות GetCampaignStatus.

            כולל נתונים כגון:

            • campaignId, campaignStatus, templateId, callerId
            • ספירות של pendingEntries, activeEntries, doneEntries, failedEntries, redialEntries ועוד
            • הגדרות כמו maxActiveChannels, vmDetect, paused
            • עלות מצטברת (currentPrice)
            • זמן ריצה כולל (runTime)
            תגובה 1 תגובה אחרונה תגובה ציטוט 2
            • E
              eliyahu ניהול נערך לאחרונה על ידי שמחה - זו הסיסמא

              יצירת קמפיין מתוזמן
              הפקודה היא - ScheduleCampaign

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

              פרמטר אפשרויות תיאור/הערות/פירוט
              token טוקן
              templateId מספר מזהה של הקמפיין
              time הגדרת זמן הפעלה באחד מהצורות הבאות (תאריך לועזי בלבד)
              אופציה 1 yyyy-MM-dd-HH:mm:ss שנה -חודש - יום-שעה:דקה:שניה
              אופציה 2 yyyy-MM-dd-HH:mm שנה -חודש - יום-שעה:דקה
              אופציה 3 yyyy-MM-dd HH:mm:ss שנה -חודש - יום שעה:דקה:שניה(בין היום לשעה רווח במקום -)
              אופציה 4 yyyy-MM-dd שנה -חודש-יום
              אופציה 5 HH:mm:ss שעה:דקה:שניה
              אופציה 6 HH:mm שעה:דקה
              תגובה 1 תגובה אחרונה תגובה ציטוט 2
              • E
                eliyahu ניהול נערך לאחרונה על ידי שמחה - זו הסיסמא

                קבלת קמפיינים מתוזמנים-

                הפקודה היא - GetScheduledCampaigns

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

                פרמטר תיאור/הערות
                token טוקן
                type סוג הקמפיינים להחזרה. האפשרויות הם PENDING קמפיינים המיועדים לביצוע. SUCCESSFUL קמפיינים שבוצעו בהצלחה. FAILED קמפיינים שנכשלו.
                order סדר המיון. האפשרויות הם: asc (ברירת מחדל) - סדר עולה. desc- סדר יורד
                from אופציונלי - maximum number of records to include
                limit אופציונלי - מקסימום של קמפיינים להחזרה
                תגובה 1 תגובה אחרונה תגובה ציטוט 2
                • E
                  eliyahu ניהול נערך לאחרונה על ידי

                  מחיקת קמפיין מתוזמן-DeleteScheduledCampaign

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

                    הצגת תוכן שלוחה (תיקייה)

                    הפקודה היא GetIVR2Dir

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

                    פרמטר תיאור הערות
                    token טוקן חובה
                    path נתיב תיקייה חובה. לדוגמה: / עבור שלוחה ראשית. 1 עבור שלוחה 1 ext/1 עבור שלוחה ext/1
                    filesFrom הצג קבצים מ רשות. 0 יציג מהקובץ הראשון 1 יציג מהקובץ השני וכן הלאה. ברירת מחדל מציג מהקובץ הראשון.
                    filesLimit הצג קבצים עד רשות. לדוגמה, 5 יציג את הקובץ החמישי (כולל). ברירת מחדל מציג עד הקובץ האחרון
                    orderBy מיין קבצים לפי ראה להלן "ערכים אפשריים לפרמטר orderBy"
                    orderDir סדר קבצים asc - סדר עולה. desc - סדר יורד.

                    ערכים אפשריים לפרמטר orderBy

                    ערך תיאור
                    name שם קובץ (ברירת מחדל)
                    date תאריך יצירה
                    mtime תאריך שינוי אחרון
                    customerdid מספר מערכת
                    uploader מעלה הקובץ
                    size גודל
                    source מקור

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

                    מאפיין סוג הסבר
                    extIni object אובייקט הכולל את הגדרות השלוחה
                    thisPath string נתיב תיקייה נוכחית
                    parentPath string נתיב תיקיית אב
                    dirs Array מערך הכולל את התיקיות והשלוחות שבתיקייה הנוכחית
                    files Array מערך הכולל את הקבצים שבתיקייה הנוכחית (מלבד קבצי ini ו-html שנמצאים במערך נפרד)
                    ini Array מערך הכולל את קבצי ההגדרות (ini) שבשלוחה
                    messages Array מערך הכולל את הודעות המערכת הקשורות לשלוחה
                    html Array מערך הכולל את קבצי הדוחות (html) שבשלוחה
                    msgDescriptions object אובייקט הכולל את התיאור של כל הודעות המערכת בשלוחה (למשל M0000=הודעת ברוכים הבאים)

                    מאפיינים משותפים לאובייקטים במערכים "dirs" "files" "ini" "messages" "html"

                    מאפיין סוג הסבר
                    exists boolean האם התיקייה/קובץ קיימים
                    name string שם התיקייה/קובץ
                    uniqueId string מזהה ייחודי לתיקייה/קובץ
                    what string נתיב תיקייה/קובץ
                    fileType string סוג תיקייה/קובץ

                    מאפיינים משותפים לאובייקטים במערכים "files" "ini" "messages" "html"

                    מאפיין סוג הסבר
                    size int גודל קובץ (בבתים)
                    mtime string תאריך שינוי אחרון

                    מאפיינים משותפים לאובייקטים במערכים "files" "messages"
                    הערה: המאפיינים הבאים הינם עבור קבצי שמע בלבד

                    מאפיין סוג הסבר
                    duration אורך (בדקות)
                    durationStr string אורך בפורמט mm:ss
                    customerDid string מספר מערכת בה נוצר הקובץ
                    meta string אובייקט המכיל מידע נוסף על הקובץ
                    date string זמן יצירת קובץ dd/mm/yyyy hh:mm
                    source string מקור הקובץ
                    phone string טלפון יוצר הקובץ
                    ip string כתובת IP של מעלה הקובץ

                    מאפייני אובייקטים במערך dirs
                    הערה: המאפיינים הבאים הינם עבור תיקיות המוגדרות כשלוחה ולא עבור תיקיות רגילות

                    מאפיין סוג הסבר
                    extType string סוג שלוחה
                    extTitle string תיאור שלוחה
                    תגובה 1 תגובה אחרונה תגובה ציטוט 2
                    • E
                      eliyahu ניהול נערך לאחרונה על ידי eliyahu

                      קבלת מידע על קובץ בודד

                      הפקודה היא - GetFile

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

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

                      דוגמה לנתיב

                      what=ivr2:2/000.wav    /// מידע על קובץ 000 בשלוחה 2
                      

                      תגובה (במידה והקובץ קיים)
                      דומה למאפיינים של קובץ כפי שמופיע בGetIVR2Dir

                      במידה וקובץ לא קיים יחזור שגיאה

                      {
                        "responseStatus": "ERROR",
                        "message": "file does not exist",
                        "messageCode": null,
                        "yemotAPIVersion": 6
                      }
                      

                      במידה ונתיב לא חוקי יחזור

                      {
                        "responseStatus": "EXCEPTION",
                        "exceptionClass": "IllegalArgumentException",
                        "exceptionMessage": "bad descriptor format. don't know what is xyz",
                        "nestedException": null,
                        "yemotAPIVersion": 6
                      }
                      
                      תגובה 1 תגובה אחרונה תגובה ציטוט 3
                      • E
                        eliyahu ניהול נערך לאחרונה על ידי שמחה - זו הסיסמא

                        ניהול תיקיות וקבצים

                        הפקודה היא FileAction

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

                        פרמטר תיאור הערה
                        token טוקן
                        action סוג הפעולה לביצוע ראה להלן
                        what נתיב ראה להלן
                        target יעד ראה להלן

                        בפרמטר action האפשרויות הקיימות הן:

                        1. copy - העתקה
                        2. move - העברה (לשינוי שם של שלוחה או קובץ יש להשתמש בהעברה)
                        3. delete - מחיקה

                        בפרמטר what האפשרויות הקיימות הן:

                        1. ניהול קובץ בודד או שלוחה בודדת.
                        2. ניהול קבצים מרובים כאשר בפרמטר what יש לציין כל קובץ או שלוחה בנפרד. לדוגמה:
                        3. ניהול קובץ בתבנית קמפיין. ראה כאן
                        ${url}FileAction?token=${token}&action=${action}&what0=ivr2:1&what1=ivr2:2/ext.ini
                        

                        בדוגמה: ניהול שלוחה 1 וניהול קובץ ext.ini שבשלוחה 2.

                        בפעולה מסוג העברה או העתקה חובה לציין פרמטר target. האפשרויות הקיימות הן:

                        1. בניהול קבצים מרובים או שלוחות מרובות יש לציין את נתיב היעד הרצוי. לדוגמה, במידה והיעד הוא שלוחה 1 יש לציין את הנתיב כך target=ivr2:1.
                          הערה: שימו לב! השם המקורי נשמר. במידה ומדובר בהעברת או העתקת קבצים עם שם בעל מספר סידורי שמות הקבצים ישתנו בהתאם לשמות הקבצים בשלוחת היעד. (לדוגמה, אם בוצעה העתקה של קובץ 001 משלוחה 2 לשלוחה 1 ששם קיים קובץ בשם 050 אז השם של הקובץ שהועתק ישתנה ל-051).
                        2. בניהול קובץ בודד או שלוחה בודדת ניתן גם לציין נתיב מלא כולל השם הרצוי ביעד.

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

                        מאפיין סוג הסבר הערה
                        reports array מערך אובייקטים ראה להלן
                        success boolean האם הפעולה בוצעה במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false
                        action סוג הפעולה שבוצעה

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

                        מאפיין ערך
                        what נתיב מקור
                        target נתיב יעד
                        success האם בוצע (זהה לתיאור לעיל)
                        תגובה 1 תגובה אחרונה תגובה ציטוט 4
                        • E
                          eliyahu ניהול נערך לאחרונה על ידי אלחנן1

                          קבלת תוכן קובץ טקסט

                          הפקודה היא - GetTextFile

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

                          פרמטר תיאור הערות
                          token טוקן
                          what נתיב מלא כולל שם הקובץ והסיומת לדוגמה ivr2:1/ext.ini

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

                          מאפיין סוג ערך
                          contents string התוכן הכתוב בקובץ
                          file array מערך אובייקטים (ראה להלן)

                          תבנית אובייקט:

                          מאפיין סוג ערך
                          exists boolean האם הפעולה בוצעה (במידה וכן, יופיע הערך true. במידה ולא, יופיע הערך false)
                          name string שם הקובץ
                          uniqueId string מזהה תנועה ייחודי
                          fileType string סוג קובץ (למשל: INI)
                          size int גודל קובץ
                          mtime string תאריך ושעה שהקובץ השתנה (פורמט: dd/MM/yyyy HH:mm)
                          what string נתיב מלא
                          תגובה 1 תגובה אחרונה תגובה ציטוט 6
                          • E
                            eliyahu ניהול נערך לאחרונה על ידי אלחנן1

                            העלאת טקסט לקובץ

                            הערה: במידה והקובץ לא קיים בשלוחה, ייווצר קובץ חדש.

                            הפקודה היא - UploadTextFile

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

                            פרמטר תיאור הערות
                            token טוקן
                            what שם הקובץ והסיומת יש לציין את הנתיב המלא. לדוגמה ivr2:1/ext.ini
                            contents תוכן הקובץ להעלאה במידה וקיים כבר טקסט בקובץ הוא יימחק

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

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

                              עדכון הגדרות שלוחה

                              שימו לב! בשונה מהפקודה UploadTextFile כאן המערכת לא מוחקת את הקיים בקובץ ext.ini והדבר היחיד שמשתנה הוא מה שאתם שולחים לשרת

                              הערה: במידה והשלוחה לא קיימת במערכת, תיווצר שלוחה חדשה.

                              הפקודה היא - UpdateExtension

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

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

                              בפרמטרים הנוספים תוכלו לצרף ערכים לעדכון בקובץ ext.ini

                              לדוגמה:

                              ${url}UpdateExtension?token=${token}&path=ivr2:1&type=menu&title=בדיקה&enter_id=yes
                              

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

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

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

                                הכוונת שיחה - העברת מאזין ב**אפשרות הראשונה לשלוחה אחרת או לניתוק

                                ** לא בכל שלב ניתן להעביר את המאזין לשלוחה אחרת באופן מיידי, ולכן הפעולה נשמרת למקום הראשון בו ניתן לעשות את הפעולה

                                הפקודה היא - CallAction

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

                                פרמטר תיאור הערות
                                token טוקן
                                ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                action set:GOasap=XXXX יש להחליף את "XXX" בלאן להעביר את המאזין, נתיב העברה, או "hangup" לניתוק

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

                                מאפיין סוג הסבר
                                calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls
                                action סוג הפעולה שבוצעה
                                callsCount int מספר כולל של שיחות שבוצעה בהן פעולה

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

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

                                  ניהול חדרי ועידה:


                                  הפקודה היא - CallAction

                                  בקריאה ל GetIncomingCalls יש מערך של שיחות של חדרי ועידה, כל הפעולות המפורטות כאן צריכות להיות מבוצעות על הid של המאזין של חדר הועידה - ולא על הID הראשי.

                                  טיפה הסבר על מערך של שיחות הוועידה:

                                  דוגמא:

                                  4c97d3a2-6790-43f7-93f9-54b428a7bdd9-image.png

                                  נעבור על החלקים החשובים.

                                  פרמטר תיאור הערות
                                  confCalls מכיל את מספר המערכת הראשי, ואז - ואז את השלוחה של חדר הועידה
                                  mute האם הערוץ מושתק
                                  hand האם יש הרמת אצבע
                                  admin האם מנהל
                                  data['survey'] מכיל את נתוני הצבעה, במהלך החדר המאזין יכול להקיש על כל הספרות בטלפון שלו וזה משוקף מייד. באם אין הקשה הערך לא יופיע

                                  הוספה או הסרה של רכיבים מה path וממערך data.

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

                                  הוספה של ערך:

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  path:add:XXX הוספה של נתון בpath, זה גם יופיע במערך data שהובא לעיל יש להחליף את XXX בערך, למשל: path:add:survey=7.

                                  הסרה של ערך:

                                  פה ניתן לשלוח רק את ההתחלה של הערך, והוא ירד.

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  path:remove:XXX הסרה של נתון בpath, זה גם ירד במערך data שהובא לעיל יש להחליף את XXX בתחילת ערך, למשל: path:remove:survey=. זה יגרום למחיקה של ערך survey ממערך הdata בכלל - למשל, כדי לאפס נתוני הצבעה.

                                  יש לשים לב, זה לא משפיע על סוג וצורת החדר, למשל, שליחה של path:add:admin לא תגרום למאזין להיות מנהל של החדר.


                                  הוצאה מחדר ועידה.

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  action kick

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


                                  השתקת הערוץ:

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  action mute

                                  ביטול השתקה של הערוץ:

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  action unmute

                                  סימון הורדת יד:

                                  בדומה להורדת אצבע על ידי המאזין בטלפון.

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  action lowerhand

                                  סימון הרמת יד:

                                  בדומה להרמת אצבע על ידי המאזין בטלפון.

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  action raisehand

                                  כיוון הוצאה מחדר ועידה:

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

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

                                  פרמטר תיאור הערות
                                  token טוקן
                                  ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                  set:ConfbridgeNewGoto=/XX מסמן לאן להעביר את המאזין בביצוע kick מהאתר יש לכתוב נתיב להעברה או hangup לניתוק.


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

                                  מאפיין סוג הסבר
                                  calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls
                                  action סוג הפעולה שבוצעה
                                  callsCount int מספר כולל של שיחות שבוצעה בהן פעולה

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

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

                                    שינוי השפה בערוץ:

                                    גובר על ערך language בשלוחה ובivr.ini.

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

                                    פרמטר תיאור הערות
                                    token טוקן
                                    ids מזהה ייחודי של השיחה כפי שהתקבל בקריאה GetIncomingCalls ניתן לשרשר כמה שיחות לביצוע על ידי כתיבה : בין id לid
                                    action=set:Clanguage=XX מסמן את השפה החדשה בערוץ כולו יש להחליף את XX בשפה המבוקשת - כל קודי השפה שיש כמו במערכת עצמה השינוי יכנס לתוקף במעבר שלוחה הבא של המאזין.

                                    דוגמה

                                    CallAction?token=xxxxxxxx&ids=fgdhfszfzvxbdgsxf&action=set:Clanguage=en
                                    


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

                                    מאפיין סוג הסבר
                                    calls array פירוט השיחות שבוצעה בהן פעולה - זהה לתיאור המופיע בפקודה GetIncomingCalls
                                    action סוג הפעולה שבוצעה
                                    callsCount int מספר כולל של שיחות שבוצעה בהן פעולה

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

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

                                      קבלת סיכום דקות נכנסות למערכת לפי טווח תאריכים

                                      הפקודה היא - GetIncomingSum

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

                                      פרמטר תיאור דוגמא
                                      token טוקן
                                      from מאיזה תאריך YYYY-mm-dd
                                      to עד איזה תאריך YYYY-mm-dd
                                      בחירת מחדל - אם לא צויין טווח תאריכים - יביא מתחילת החודש הלועזי

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

                                      מאפיין סוג הסבר
                                      fromDate string מאיזה תאריך מוצגים הנתונים
                                      toDate string עד איזה תאריך מוצגים הנתונים
                                      direct int דקות בחיוג ישיר למערכת
                                      transferIn int דקות ממערכות אחרות
                                      transferOut int דקות שיצאו למערכות אחרות

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

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

                                        קבלת לוג סמסים יוצאים

                                        הפקודה היא - GetSmsOutLog

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

                                        פרמטר תיאור סוג
                                        token טוקן
                                        limit הגבלת תוצאות int

                                        בחירת מחדל מביא את כל הסמסים.
                                        סדר קבלת הסמסים הם מהחדש לישן

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

                                        מאפיין סוג הסבר
                                        rows array מערך של הסמסים היוצאים

                                        להלן תוכן מערך הסמסים:

                                        מאפיין סוג הסבר
                                        CallerId string זיהוי יוצא
                                        To string יעד
                                        Message string תוכן ההודעה
                                        Billing int עלות ביחידות
                                        RunBy string פרטי מבצע הפעולה
                                        Time string זמן השליחה
                                        DeliveryReport string דוח מסירה

                                        להלן סוגי סטטוס דוחות מסירה נפוצים לפי תקן SMPP:

                                        # הסבר
                                        null לא התקבל מידע על מסירת ההודעה
                                        DELIVRD נמסר
                                        ESME_ROK הועבר לשליחה בהצלחה
                                        EXPIRED פג תוקף מעקב המסירה
                                        ESME_RINVDSTADR יעד לא נגיש
                                        ESME_RINVMSGLEN אורך לא חוקי
                                        ESME_RINVCMDLEN אורך פקודה שגוי
                                        ESME_RMSGQFUL תור ההודעות מלא
                                        ESME_RINVNUMDESTS מספר יעדים לא חוקי

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

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

                                          ממשק אירועי אבטחה.

                                          תיעוד API לגישה לאירועי האבטחה של המערכת של המערכת.

                                          ה Web Services היבוארו כאן:

                                          ValidationToken // מידע על הטוקן
                                          DoubleAuth // ביצוע אימות דו שלבי בטוקן
                                          GetLoginLog // קבלת לוג ניסיונות התחברות
                                          GetAllSessions // קבלת סשנים פעילים
                                          KillSession // סגירת סשן ספציפי
                                          KillAllSessions // סגירת כל הסשנים הפעילים
                                          

                                          הערה חשובה:

                                          שימוש בטוקן שהוא שם משתמש וסיסמה של המערכת (077777:1234) לא ממולץ לעבודה עם מתודות שדורשים אימות דו שלבי מכיוון שהאימות הדו שלבי זה ברמת טוקן והתחברות בצורה כזו יוצרת טוקן משתנה.


                                          מתודה - ValidationToken
                                          קבלת מידע על טוקן.

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

                                          פרמטר תיאור
                                          token טוקן

                                          בתגובת השרת במידה שהטוקן תקין יתקבל מערך בשם tokenData המכיל את המידע הבא:

                                          מאפיין סוג הסבר דוגמא
                                          remoteIP string כתובת IP של יוצר הטוקן 172.18.0.1
                                          sessionType string סוג החיבור API
                                          createTime string זמן יצירה 2021-07-30 14:38:30
                                          lastRequest string שימוש אחרון 2021-07-30 14:42:31
                                          doubleAuthStatus boolean האם החיבור עבר אימות דו-שלבי false
                                          validationCalls int כמות שיחות אימות שיצאו ולא אומתו (ערך כללי, לא קשור לחיבור הספציפי) 3
                                          token string רמז של הטוקן hwe***5J76TM

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


                                          מתודה - DoubleAuth
                                          ביצוע אימות דו שלבי בטוקן.

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

                                          פרמטר תיאור
                                          token טוקן
                                          action פעולה: שליחת שיחת אימות או אימות בפועל.

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

                                          קבלת שיחה:

                                          שולחים פרמטר SendCode בערך action.

                                          תגובה תקינה של השרת:

                                          מאפיין סוג הסבר דוגמא
                                          responseStatus string סטטוס הפעולה OK
                                          message string הודעת הצלחה Call successfully sent
                                          LastNumberToSend string 4 הספרות האחרונות של המספר שאליו נשלחה השיחה 7770

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 EXCEPTION message Missing parameters חסרים פרמטרים, או ש action ריק או שהוא מצפה לערך נוסף
                                          2 EXCEPTION message createPhone is Not Valid. verification is disabled מספר יוצר המערכת לא מעודכן או לא מספר תקין, לא ניתן לבצע אימות
                                          3 ERROR message Token has already been verified כבר בוצע אימות דו שלבי בטוקן זה.
                                          4 ERROR message Too many validation Calls. Try for a few more hours יותר מידי שליחת שיחות במערכת ללא אימות בטווח קצר.

                                          הסבר חשוב בנוגע לשגיאה 4: על מנת למנוע ניצול לרעה שליחת שיחות אימות מוגבלות, כל שליחה של שיחת אימות נספרת, וכל אימות מוצלח מוריד ספירה.
                                          זה אומר, שאם תבצעו אימות מוצלח ושיחה אחד בלבד זה לא יחשב בתור שיחה, אבל אם תשלחו 4 שיחות אימות ורק אז יתבצע אימות אז יספר 3 שיחות שיצאו ללא צורך.

                                          ניתן לראות את המונה שיחות של המערכת בפניה ל ValidationToken.
                                          המונה מתאפס כל כ6 שעות.

                                          ביצוע אימות בפועל:

                                          שולחים פרמטר VerifyCode בערך action ואת 4 הספרות של המספר שקיבלתם ממנו את השיחה בערך code.

                                          תגובה תקינה של השרת:

                                          מאפיין סוג הסבר דוגמא
                                          responseStatus string סטטוס הפעולה OK
                                          message string הודעת הצלחה VerifiedOK

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

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 ERROR message Please SendCode before לא ניתן לבצע אימות לפני שליחת שיחה. יש לשלוח שיחה קודם.
                                          2 ERROR message Authentication failed הקוד לא תקין.
                                          3 ERROR message Missing parameters חסרים פרמטרים, או ש action ריק או שהוא מצפה לערך נוסף
                                          4 ERROR message Token has already been verified כבר בוצע אימות דו שלבי בטוקן זה.

                                          מתודה - GetLoginLog
                                          קבל לוג התחברויות

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

                                          פרמטר תיאור
                                          token טוקן שעבר אימות דו שלבי
                                          limit ניתן להגביל את כמות התוצאות שיתקבלו
                                          username חיפוש לוג לפי שם משתמש

                                          לגבי ערך username: בעצם LoginLog לא מחייב שמדובר במערכת אמיתית ולכן זה נשמר לפי שם משתמש, בעת פניה ללא הערך יחזרו הלוגים של המספר הראשי של המערכת, אם ברצונכם להביא לוגים של מספר משנה למשל, יש לצרף ערך זה עם המספר משנה.

                                          בתגובת השרת במידה שהטוקן תקין יתקבל array בשם data המכיל את כל התוצאות, כל תוצאה היא גם מערך המכיל את השדות הבאים:

                                          מאפיין סוג הסבר דוגמא
                                          remoteIP string כתובת IP 172.18.0.1
                                          sessionType string סוג החיבור REGULAR
                                          actionTimestamp string זמן 2021-07-30 14:13:00
                                          username string שם המשתמש 0773137770
                                          successful boolean האם מדובר בחיבור מוצלח או לא false

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי.
                                          2 EXCEPTION message Unknown username ערך שם משתמש שגוי.

                                          מתודה - GetAllSessions
                                          קבל סשנים פעילים

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

                                          פרמטר תיאור
                                          token טוקן שעבר אימות דו שלבי
                                          limit ניתן להגביל את כמות התוצאות שיתקבלו

                                          בתגובת השרת במידה שהטוקן תקין יתקבל array בשם sessions המכיל את כל החיבורים וערך int בשם sessionsCount המכיל את כמות הסשנים הפעילים.
                                          כל ערך בתוך sessions יכיל:

                                          מאפיין סוג הסבר דוגמא
                                          id int מזהה טוקן, לצורך הריגה שלו 16598
                                          token string רמז של הטוקן hwe***5J76TM
                                          active boolean האם הטוקן פעיל true
                                          selectedDID string שם משתמש (בחיבור של API זה null 0773137770
                                          remoteIP string כתובת IP של יוצר הטוקן 172.18.0.1
                                          sessionType string סוג החיבור API
                                          createTime string זמן יצירה 2021-07-30 14:38:30
                                          lastRequest string שימוש אחרון 2021-07-30 14:42:31
                                          doubleAuthStatus boolean האם החיבור עבר אימות דו-שלבי false

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי.

                                          מתודה - KillSession
                                          סגירת סשן

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

                                          פרמטר תיאור
                                          token טוקן שעבר אימות דו שלבי
                                          SessionId מזהה סשן להריגה

                                          תגובה תקינה של השרת:

                                          מאפיין סוג הסבר דוגמא
                                          responseStatus string סטטוס הפעולה OK
                                          SessionId string מזהה הסשן שנסגר 35

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי.
                                          2 EXCEPTION message SessionId Can only be a number ערך מזהה סשן ריק או לא תקין.
                                          3 ERROR message SSessionId is broken מזהה סשן לא פעיל או לא נמצא.

                                          מתודה - KillAllSessions
                                          סגירת כל הסשנים הפעילים של המערכת

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

                                          פרמטר תיאור סוג
                                          token טוקן שעבר אימות דו שלבי

                                          תגובה תקינה של השרת:

                                          מאפיין סוג הסבר דוגמא
                                          responseStatus string סטטוס הפעולה OK
                                          KillSessions string כמות הסשנים שנסגרו 10

                                          שגיאות אפשרויות:
                                          סוג השגיאה מופיע ב responseStatus

                                          # סוג שגיאה ערך הסברה תוכן הסבר
                                          1 EXCEPTION message Unverified session טוקן לא עבר אימות דו שלבי.

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

                                          תגובה 1 תגובה אחרונה תגובה ציטוט 9
                                          • שמואל
                                            שמואל נערך לאחרונה על ידי אלחנן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
                                            • פוסט ראשון
                                              פוסט אחרון