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

מאפשר לבדוק את הסטטוס הנוכחי של קמפיין כפי שהתקבל בקריאת 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 יש להגדיר את טווח הרשומות להצגה.
הפורמט הוא:

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

{ "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 }