php

המשך יבוא…

📞 GetCampaignStatus – קבלת מצב קמפיין

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

---

🔹 הפקודה

GetCampaignStatus

---

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

פרמטר	חובה/אופציונלי	תיאור
token	חובה	טוקן
campaignId	חובה	מזהה הקמפיין, כפי שהתקבל בקריאת RunCampaign
entries	אופציונלי	הצגת רשומות בקמפיין (מספרי טלפון). אם לא צוין – מוחזר מצב כללי בלבד.
range	אופציונלי	טווח ערכים להצגה [min]:[max]. לדוגמה: 1:100 יציג את 100 הרשומות הראשונות, או : עבור כולן. ברירת מחדל: 10,000 רשומות ראשונות.

---

🔹 ערכי פרמטר entries

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

---

🔹 תגובה במצב הצלחה (דוגמה)

{
  "responseStatus": "OK",
  "campaign": {
    "campaignId": "0772222770-1117319-2025-01-22-10-07-54-414-API",
    "campaignStatus": "RUNNING",
    "templateId": 1117319,
    "callerId": "0772222770",
    "blockedEntries": 0,
    "pendingEntries": 0,
    "activeEntries": 1,
    "doneEntries": 0,
    "failedEntries": 0,
    "totalEntries": 1,
    "totalDialed": 3,
    "totalSuccessful": 1,
    "totalFailed": 2,
    "paused": false,
    "entries": [
      {
        "phone": "0773137770",
        "name": null,
        "moreinfo": "זוהי הודעת בדיקה",
        "entryStatus": "up",
        "duration": 3680,
        "startTime": "2025-01-22 10:10:14",
        "currentPrice": 1.0,
        "redials": [
          {
            "entryStatus": "no_answer",
            "startTime": "2025-01-22 10:07:54"
          },
          {
            "entryStatus": "no_answer",
            "startTime": "2025-01-22 10:09:04"
          }
        ]
      }
    ]
  },
  "yemotAPIVersion": 6
}

הפעלת קמפיין

מאפשר להפעיל קמפיין על בסיס תבנית קיימת במערכת.

---

הפקודה

RunCampaign

---

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

פרמטר	תיאור	הערות
token	טוקן	חובה
templateId	מזהה תבנית כפי שהתקבל בקריאות GetTemplates / CreateTemplate	רשות; אם לא צוין → תבנית ברירת מחדל
callerId	זיהוי יוצא, מתקבל בקריאת GetApprovedCallerIDs	רשות; אם לא צוין → המערכת תשתמש בזיהוי המוגדר בתבנית
phones	רשימת טלפונים לחיוג	רשות; פורמט מפורט בהמשך
ttsMode	הפעלת הודעות אישיות בהקראה ממוחשבת (TTS)	ראה הסבר להלן
withSMS	הפעלת קמפיין משולב SMS	ראה הסבר להלן

---

פורמט מספרים לשליחה

אפשרות 1 – רשימה פשוטה:
המפריד בין מספר למספר הוא נקודתיים :

phones=0772222770:0773137770

המערכת תחייג למספרים 0772222770 ו־0773137770.

אפשרות 2 – פורמט JSON עם מידע נוסף:

{
  "0773137770": {
    "name": "שם",
    "moreinfo": "מידע נוסף",
    "blocked": true
  },
  "0772222770": {
    "name": "ימות המשיח",
    "text": "עתיד התקשורת כבר כאן"
  }
}

• name → שם
• moreinfo → מידע נוסף
• text → טקסט להודעה אישית (SMS או TTS)
• blocked → true = חסום, false = פעיל (ברירת מחדל פעיל)

---

השמעת הודעות אישיות (TTS)

• ttsMode=1 → המערכת תשמיע הודעה כללית של הקמפיין ואחריה טקסט אישי.
• אם לא סופק phones → הטקסט נלקח מהשדה moreinfo.
• אם סופק phones → הטקסט נלקח מהשדה text.

---

קמפיין משולב SMS

• withSMS=1 → למספר נייד רגיל נשלחת הודעת SMS,
  ולמספר נייד כשר נשלחת הודעה קולית.

---

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

מאפיין	משמעות	סוג	דוגמה
templateId	מזהה תבנית עליה מתבסס הקמפיין	int	1117319
campaignId	מזהה הקמפיין	string	0772222770-1117319-2025-01-21-15-11-18-347-API
entriesCount	סה״כ ערכים (מספרים) ברשימה	int	333
pending	סה״כ מספרים לחיוג	int	300
blocked	סה״כ מספרים חסומים	int	33
estimatedPrice	עלות משוערת ביחידות	double	333.0
customerUnits	יתרת יחידות במערכת	double	10000.12121212
smsCount	כמות SMS	double	0.0
smsPrice	עלות SMS	double	0.0

---

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

קוד הודעה	הודעה	הסבר
100	תבנית לא חוקית	ערך templateId אינו קיים
101	הקמפיין לא מוגדר כראוי	רשימת טלפונים ריקה / אין הודעה תקינה
102	אין טלפונים תקינים	כל המספרים שסופקו בפרמטר phones אינם תקינים
103	יחידות לא מספיקות	יתרת היחידות אינה מספיקה
104	isKodesh is true	ניסיון הפעלה בשבת או יום טוב
105	שגיאה כללית	שגיאת מערכת – הקמפיין לא יכול להתחיל
120	CallerId אינו מורשה	המספר שצוין ב־callerId אינו מורשה

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

---

הפקודה

UploadPhoneList

---

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

פרמטר	תיאור	הערות
token	טוקן	חובה
templateId	מזהה תבנית	חובה
data	קובץ רשימת הטלפונים כמחרוזת	חובה
nameColumns	מספר העמודות של ‘שם’. כל עמודות הטקסט האחרות עוברות ל’מידע נוסף’	ברירת מחדל 1
defaultPrefix	קידומת מספר ברירת מחדל למספרים בני 7 ספרות. ערכים מותרים: 02,03,04,08,09,077,072,073	רשות
delimiter	תו המפריד בין עמודות. עבור טאב יש לכתוב "TAB"	ברירת מחדל ,
updateType	סוג העדכון: UPDATE = עדכון רשומות קיימות והוספת חדשות, NEW = הסרה והוספת חדשות, REMOVE = הסרה בלבד	ברירת מחדל UPDATE
blocked	1 = הרשומות שהועלו חסומות	ברירת מחדל 0 = לא חסומות

---

תגובות שגיאה

אם ניתוח הקובץ נכשל בגלל פורמט לא מזוהה → message = "bad_format"

---

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

מאפיין	סוג	הסבר
message	string	"ok" = ההעלאה עברה בהצלחה
templateId	int	מזהה התבנית שעודכן
totalParsed	int	מספר כולל של מספרים שהתקבלו
rejectedRecords	array	מערך עם רשומות שנדחו (ראה תבנית להלן)
totalInserted	int	מספר הרשומות שהוכנסו בהצלחה
totalUpdated	int	מספר הרשומות שעודכנו
totalRemoved	int	מספר הרשומות שהוסרו

---

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

מאפיין	סוג	הסבר
phone	string	מספר הטלפון
name	string	עמודת שם
moreinfo	string	עמודת מידע נוסף
blocked	bool	סטטוס חסום
errorState	enum	DUPLICATE = מספר כפול, INVALID = מספר לא חוקי (אסור בקמפיינים)
originalRowNumber	int	מספר השורה בקובץ בו זוהתה השגיאה

מחיקת כל המספרים מרשימת התפוצה

---

הפקודה

ClearTemplateEntries

---

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

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

---

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

אין מאפיינים מיוחדים.

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

---

הפקודה

UpdateTemplateEntries

---

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

פרמטר	תיאור	הערות
token	טוקן	פרמטר חובה
templateId	מזהה תבנית	פרמטר חובה
rowids	מזהים ייחודיים של המספרים ברשימת התפוצה	יש להפריד בין המספרים עם מקף -
action	איזה פעולה לבצע	ישנן 3 אפשרויות: <br>• block - חסימה <br>• unblock - ביטול חסימה <br>• delete - מחיקה

---

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

אין מאפיינים מיוחדים.

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

---

הפקודה

UpdateTemplateEntry

---

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

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

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

---

הפקודה

GetTemplateEntries

---

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

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

---

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

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

---

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

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

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

---

הפקודה

DeleteTemplate

---

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

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

---

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

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

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

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

---

הפקודה

CreateTemplate

---

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

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

---

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

מאפיין	סוג	ערך
templateId	int	מזהה התבנית החדשה שנוצרה