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

eliyahu

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

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

הפקודה היא UpdateTemplate

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

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

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

מאפיין	סוג	הסבר
templates	array	נתוני התבנית המעודכנים - זהה לתיאור התבנית בפקודה `GetTemplates`

eliyahu

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

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

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

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

${templateId}.wav

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

${templateId}.tts

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

${templateId}-MoreInfo.wav

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

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

${templateId}-First.wav

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

PrivateMsg/${phone}.wav

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

PrivateMsg/Default.wav

eliyahu

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

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

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

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

tpl:${templateId}

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

tpl:${templateId}:tts

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

tpl:${templateId}:MoreInfo

eliyahu

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

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

הפקודה היא - CreateTemplate

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

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

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

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

eliyahu

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

הפקודה היא - DeleteTemplate

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

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

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

eliyahu

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

הפקודה היא - GetTemplateEntries

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

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

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

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

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

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

eliyahu

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

הפקודה היא - UpdateTemplateEntry

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

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

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

eliyahu

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

הפקודה היא - UpdateTemplateEntries

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

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

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

eliyahu

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

הפקודה היא - ClearTemplateEntries

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

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

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

eliyahu

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

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

eliyahu

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

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

פרמטר	תיאור	הערות
token	טוקן	חובה
templateId	מזהה תבנית	חובה
phones	רשימת טלפונים חלופית לשליחת ההודעה, כאשר המספרים מופרדים ב `:`	רשות
callerId	זיהוי יוצא	רשות

eliyahu

מצב הקמפיין-GetCampaignStatus

eliyahu

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

eliyahu

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

eliyahu

ביצוע פעולות בקמפיינים פעילים-CampaignAction

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	שעה:דקה

eliyahu

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

הפקודה היא - GetScheduledCampaigns

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

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

eliyahu

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

eliyahu

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

הפקודה היא 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	תיאור שלוחה

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
}