הסבר כללי
סוגי חייגן
כאשר הנכם מקימים חייגן אוטומטי תוכלו לפתוח מספר קמפיינים כאשר כל קמפיין משרת מטרה מסוימת (חיוג ללידים חמים/קרים/לידים שהשאירו פרטים מדף נחיתה ועוד).
הקמפיין יכול להיות מסוג מסוים:
- חייגן לנציג - כאשר השיחה קודם כל מחייגת אצל הנציג ולאחר מענה של הנציג מתבצעת שיחה על היעד.
- חייגן חכם - החיוג הראשוני מתבצע על היעד, לאחר מענה של היעד השיחה עוברת לנתב
בהתאם להגדרה של הנתב היעד יכול לשמוע הקלטה או להמתין במעגל המתנה עד למענה לנציג פנוי.
במידה וקיים בחשבונכם חייגן אוטומטי תוכלו לבצע שימוש בכלי הAPI שלנו למגוון מטרות ומימוש הלוגיקה העסקית הארגונית שלכם בצורה אוטומטית מתוך מערכת המידע הארגונית שלכם.
חייגן אוטומטי יכול להתחלק למספר קמפיינים - כאשר לכל קמפיין יש יעדי חיוג ייעודים, ולכל קמפיין תוכלו לבצע פעולות שונות:
- תוכלו לבחון אילו קמפיינים פעילים כרגע בארגונכם.
- תוכלו להוסיף/להסיר יעדים לחיוג.
- תוכלו להפסיק קמפיין מסוים או להפעיל קמפיין כבוי.
- תהיה לכם אפשרות להוסיף/להסיר נציגים מקמפיין.
כל מה שתצטרכו לבצע הוא בקשת HTTP פשוטה למתודות המפורטות מטה:
GetCampaignList
הסבר כללי
מומלץ שזו תיהיה המתודה הראשונה שבה תבצעו שימוש מאחר והיא תחזיר לכם את הקמפיינים הפעילים בחשבונכם.
לאחר שתדעו איזה קמפיין פעיל תוכלו לתת את האופציה להוסיף מספרי טלפון לקמפיין פעיל.
פורמט בקשה
- POST-JSON
- GET
פורמט תשובה
- POST-JSON
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList
פרמטרים בבקשה
למתודה זו יש לשלוח רק קוד אימות לחשבונכם, את הקוד ניתן לקבל ממחלקת התפעול שלנו.
| שם שדה | תיאור | סוג שדה | הערות |
| Code | מזהה חשבון ייחודי - ניתן לקבל ממחלקת התפעול של וויסנטר | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList?Code=XXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Code": "XXXXXXXXXXXXX"
}
פרמטרים בתגובה
| שם שדה | תיאור | סוג |
| ErrorCode | ססטוס התגובה. במידה ומתקבל "0" סימן שאין שגיאות. | מספר שלם |
| Description | תיאור סטטוס התגובה. במידה ומתקבל "OK" סימן שאין שגיאה ותיאור שלה. | מחרוזת |
| Data | משתמנה מסוג מערך JSON אשר יכיל את הקמפיינים בחשבונכם. | מערך |
| Name | שם הקמפיין | מחרוזת |
| StatusName | מציג את סטטוס הקמפיין, יש שתי אפשרויות: אפשרות ראשונה: "Enabled" - קמפיין פעיל. אפשרות שנייה: "Disabled" - קמפיין לא פעיל/ | מחרוזת |
| TotalPendingCalls | סכום היעדים אשר ממתינים לחיוג. | מספר שלם |
| MaxPriority | משתנה אשר מחזיר את עדיפות המקסימלית אשר הוגדרה לכל יעד. | מספר שלם |
| MinPriority | משתנה אשר מחזיר את עדיפות המינימלית אשר הוגדרה לכל יעד. | מספר שלם |
| TotalAwaitingCalls | שדה זה רלוונטי רק עבור קמפיין מסוג חייגן חכם. שדה זה מציג את סכום היעדים לחיוג קמפיין. שדה זה יותר מומלץ לשימוש מאשר שדה "TotalPendingCalls" עבור קמפיין מסוג חייגן חכם. במידה ומדובר על קמפיין מסוג חייגן לנציג שדה זה יציג "null". | מספר שלם |
| Code | מזהה ייחודי של כל קמפיין, יש צורך בו עבור שימוש בשאר המתודות כמפורט בהמשך. | מחרוזת |
דוגמא לתשובה
{
"Data":
[
{
"Name": "Campaign1",
"StatusName": "Enabled",
"TotalPendingCalls": 23,
"MaxPriority": 1,
"MinPriority": 1,
"TotalAwaitingCalls": 23,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
{
"Name": "Campaign2",
"StatusName": "Enabled",
"TotalPendingCalls": 19,
"MaxPriority": 52,
"MinPriority": 1,
"TotalAwaitingCalls": null,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
]
"ErrorCode": 0,
"Description": "OK"
}
AddCall
הסבר כללי
במידה ויש לכם צורך להוסיף מספר טלפון בודד לקמפיין פעיל, תוכלו לבצע שימוש במתודה זו.
במידה ויש לכם צורך להוסיף מספר יעדים לחיוג יש לבצע שימוש במתודה הבאה: AddCallsBulk.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/AddCall
פורמט בקשה
- POST-JSON
- GET
פורמט תגובה
- POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג משתנה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Target | מספר טלפון של היעד אליו תרצו לחייג. עליכם להוסיף קידומת בינלאומית למספר טלפון - לא חובה עבור מספרים ישראלים. | מחרוזת | חובה |
| CustomerName | שם הלקוח של היעד אליו מחייגים. | מחרוזת | רשות |
| CallerID | מספר טלפון אשר יוצג כמזהה לנציג אשר מקבל את השיחה ליעד זה. | מחרוזת | רשות |
| Priority | עדיפות חיוג על היעד שהוספתם, העדיפות ניתנת לערך שיותר גבוה. | מספר שלם | רשות |
| CustomData | יש באפשרותכם להעביר מידע ייחודי שלכם ליעד שהוספתם בעזרת Custom Data יחד עם ערכים שתרצו לוודא שיישלחו אליכם לאחר סיום השיחה. מידע זה גם יופיע בהקפצת מסך. | מערך | רשות |
| OriginateTime | במידה ותרצו לקבוע חיוג בתאריך עתידי בזמן Epoch, תוכלו לבצע שימוש במשתנה זה. במידה ולא נקבע ערך במשתנה זה, החיוג אל היעד יתבצע במועד הכי מוקדם שמתאפשר. במידה וכן החלטתם לבצע שימוש במשתנה זה עליכם גם לכלול את המשתנה IsDateLocal בבקשה שלכם. | מספר שלם | רשות |
| IsDateLocal | משתנה זה קובע האם שיחות עתידיות יתבצעו בזמן מקומי לפי ההגדרה של חשבונכם בממשק הניהול. במידה ואתם קובעים ערך "false" לשדה זה החיוג ליעד שהוספתם יתבצע לפי אזור זמן GMT - 0 בינלאומי. ההמלצה שלנו היא להשתמש בערך "true". | בוליאני | רשות |
| IgnoreDncStatus | במידה ובחשבונכם מופעל שירות חסימת שיחות מהמאגר הממשלתי - "אל תתקשר אלי", יש באפשרותכם לאפשר שיחות ליעדים חסומים במאגר בשירות החייגן האוטומטי במידה ותעבירו שדה זה. | בוליאני | רשות |
דוגמא לבקשה בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/AddCall?Campaign=XXXXXXXXXXXXXXXXXXXXX&Target=0501234567&CustomerName=John Doe&Priority=42&var_leadID=1234567
דוגמא לבקשה בפורמט POST - JSON
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"IgnoreDncStatus": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
פרמטרים בתגובה
| שם שדה | תיאור | סוג |
| ErrorCode | סטטוס התגובה: סטטוס "0" יעיד על חוסר שגיאות ותקינות הבקשה. ססטוס "1" יעיד על בקשה שלכם עם קמפיין קוד לא תקין. סטטוס "2" יעיד על העדרות של ערך בשדה Target בבקשה שלכם. סטטוס "2-" יעיד על מספר טלפון לא תקין בשדה Target. | מספר שלם |
| Description | תיאור מילולי של השגיאה: תיאור סטטוס "OK" יעיד על חוסר שגיאה. תיאור "Invalid campaign code" יעיד על קמפיין קוד לא תקין. תיאור סטטוס "Campaign code missing" יעיד על חוסר של קוד קמפיין. תיאור סטטוס "Target missing" יעיד על העדרות של השדה הנ"ל. תיאור סטטוס "Number is invalid" יעיד על מספר טלפון לא תקין בשדה Target. | מחרוזת |
דוגמא לתשובה
{
"ErrorCode": 0,
"Description": "OK"
}
AddCallsBulk
הסבר כללי
מתודה זו תיתן לכם מענה על הצורך של הוספת יעדים לחייגן (כאשר רוצים להוסיף יותר מיעד אחד).
במידה ואתם רוצים להוסיף יעד בודד - יש לבצע שימוש במתודה AddCall - המפורטת מעלה.
פורמט בקשה
- POST-JSON
פורמט תשובה
- POST-JSON
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/AddCallsBulk
פרמטרים בבקשה
| שם שדה | תיאור | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Target | מספר טלפון של היעד אליו תרצו לחייג. עליכם להוסיף קידומת בינלאומית למספר טלפון - לא חובה עבור מספרים ישראלים. | מחרוזת | חובה |
| CustomerName | שם הלקוח של היעד אליו מחייגים. | מחרוזת | רשות |
| CallerID | מספר טלפון אשר יוצג כמזהה לנציג אשר מקבל את השיחה ליעד זה. | מחרוזת | רשות |
| Priority | עדיפות חיוג על היעד שהוספתם, העדיפות ניתנת לערך שיותר גבוה. | מספר שלם | רשות |
| CustomData | יש באפשרותכם להעביר מידע ייחודי שלכם ליעד שהוספתם בעזרת Custom Data יחד עם ערכים שתרצו לוודא שיישלחו אליכם לאחר סיום השיחה. מידע זה גם יופיע בהקפצת מסך. | מערך | רשות |
| OriginateTime | במידה ותרצו לקבוע חיוג בתאריך עתידי בזמן Epoch, תוכלו לבצע שימוש במשתנה זה. במידה ולא נקבע ערך במשתנה זה, החיוג אל היעד יתבצע במועד הכי מוקדם שמתאפשר. במידה וכן החלטתם לבצע שימוש במשתנה זה עליכם גם לכלול את המשתנה IsDateLocal בבקשה שלכם. | מספר שלם | רשות |
| IsDateLocal | משתנה זה קובע האם שיחות עתידיות יתבצעו בזמן מקומי לפי ההגדרה של חשבונכם בממשק הניהול. במידה ואתם קובעים ערך "false" לשדה זה החיוג ליעד שהוספתם יתבצע לפי אזור זמן GMT - 0 בינלאומי. ההמלצה שלנו היא להשתמש בערך "true". | בוליאני | רשות |
| IgnoreDncStatus | במידה ובחשבונכם מופעל שירות חסימת שיחות מהמאגר הממשלתי - "אל תתקשר אלי", יש באפשרותכם לאפשר שיחות ליעדים חסומים במאגר בשירות החייגן האוטומטי במידה ותעבירו שדה זה. | בוליאני | רשות |
בקשה לדוגמא בפורמט POST - JSON
[
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"IgnoreDncStatus": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234568"
}
]
פרמטרים בתגובה
| שם שדה | תיאור | סוג |
| AddResult | מערך אשר מציג את כלל היעדים אשר נוספו לקמפיין. | מערך |
| Target | מספר טלפון של היעד אותו הוספתם לקמפיין | מחרוזת |
| ErrorCode | מציג את ססטוס התגובה, יוצגו אחד מהערכים הבאים: סטטוס "0" יעיד על חוסר שגיאות. סטטוס "1" יעיד על קוד קמפיין שגוי. סטטוס "2" יעיד על חוסר יעד להוספה. סטטוס "2-" יעיד על מספר טלפון שאינו תקין. | מספר שלם |
| Description | שדה זה יציג את התיאור לתגובה/שגיאה: תיאור "OK" על חוסר שגיאות ופעולה תקינה מצדכם. תיאור "Invalid campaign code" יעיד על שימוש בקוד קמפיין לא תקין. תיאור "Campaign code missing" יעיד על חוסר קוד קמפיין. תיאור "Target missing" יעיד על חוסר מספר טלפון בבקשה שלכם. תיאור "Number is invalid" יעיד על מספר טלפון לא תקין שניסיתים להוסיף. | מחרוזת |
| CustomData | המידע הייחודי שהעברתם בבקשה שלכם להוספת היעד. | מערך |
דוגמא לתשובה
{
"AddResult":
[
{
"Target": "0501234567",
"ErrorCode": 0,
"Description": "OK",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
{
"Target": "0501234568",
"ErrorCode": 0,
"Description": "OK",
"CustomData":
{
}
}
]
"ErrorCode": 0,
"Description": "OK"
}
Remove Call
הסבר כללי
מתודה זו תאפשר לכם להוריד יעד (מספר טלפון) מקמפיין מסוים, במידה והלקוח ביקש שלא להתקשר שוב או אם ניסתם להתקשר מספר פעמים אך נתקלתם באי מענה בכל פעם.
לכל צורך שיהיה, תוכלו לבצע את הפעולה על ידי בקשת HTTP פשוטה.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/RemoveCall
פורמט בקשה
1. POST-JSON
2. GET
פורמט תשובה
1.POST-JSON
פרמטרים בבקשה
להלן הפרמטרים שהינכם יכולים להשתמש בבקשה למתודה זו:
| שם שדה | תיאור | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Target | מספר הטלפון שאותו תרצו להסיר מהקמפיין הרלוונטי. יש לרשום את המספר עם קידומת בינלאומית. במידה ומדובר על מספר ישראלי אין צורך לרשום עם קידומת בינלאומית. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/RemoveCall?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Target=0501234567
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567"
}
פרמטרים בתשובה
| שם שדה | תיאור | סוג שדה |
| ErrorCode | מציג את ססטוס התגובה, יוצגו אחד מהערכים הבאים: סטטוס "0" יעיד על חוסר שגיאות. סטטוס "1" יעיד על קוד קמפיין שגוי. סטטוס "2" יעיד על חוסר יעד להוספה. | מספר שלם |
| Description | שדה זה יציג את התיאור לתגובה/שגיאה: תיאור "OK" על חוסר שגיאות ופעולה תקינה מצדכם. תיאור "Invalid campaign code" יעיד על שימוש בקוד קמפיין לא תקין. תיאור "Campaign code missing" יעיד על חוסר קוד קמפיין. תיאור "Target missing" יעיד על חוסר מספר טלפון בבקשה שלכם. | מחרוזת |
תשובה לדוגמא בפורמט POST-JSON
{
"ErrorCode": 0,
"Description": "OK"
}
דגש חשוב
במידה והמספר טלפון שרשום בשדה "Target" אינו כלול בקמפיין - התגובה שתקבלו תהיה "OK".
במידה וביקשתם להסיר מספר אשר כלול מספר פעמים במקפיין מסוים, אז המספר יוסר במלאו, הכוונה שהמספר יוסר מהקמפיין בכל הפעמים שהוא מופיע.
ClearCampaignCalls
הסבר כללי
מתודה זו תאפשר לכם "לנקות" את כללי מספרי הטלפון הקיימים בקמפיין מסוים, בעצם תוכלו להסיר את כל היעדים מקמפיין מסוים.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/ClearCampaignCalls
פורמט בקשה
1. GET
2. POST-JSON
פורמט תשובה
1.POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/ClearCampaignCalls?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
פרמטרים בתגובה
| שם שדה | תיאור | סוג |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "4" מעיד על קמפיין קוד לא תקין. | מספר שלם |
| Description | שדה זה מתאר את סטטוס התגובה: תיאור "OK" יעיד על בקשה תקינה וחוסר שגיאה תיאור "Internal error occurred" יעיד על קוד קמפיין שאינו תקין. | מחרוזת |
תגובה לדוגמא
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
GetMembersList
הסבר כללי
על מנת לתת לכם כלי מיטביים לניהול החייגן דרך מערכת המידע שלכם, יש לנו מתודה אשר בעזרתה תוכלו לקבל רשימה של הנציגים השייכים לקמפיין מסוים.
* מתודה זו רלוונטית רק עבור קמפיין מסוג "חייגן לנציג".
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/GetMembersList
פורמט בקשה
1.POST-JSON
2.GET
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/GetMembersList?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": " XXXXXXXXXXXXXXXX"
}
פרמטרים בתשובה
| שם שדה | תיאור | סוג שדה |
| ErrorCode | מציג את ססטוס התגובה לבקשה שלכם. יוצג סטטוס "0" במידה והבקשה שלכם תקינה. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. בקשה תקינה מצדכם תספק תיאור של "OK". | מחרוזת |
| Data | מערך JSON אשר מכיל את הנציגים בקמפיין הרלוונטי. | מערך |
| DisplayName | שם השלוחה בוויסנטר. | מחרוזת |
| Member | מזהה ייחודי של השלוחה, נקרא גם Sip Code (סיפ קוד). | מחרוזת |
תשובה לדוגמא
{
"Data":
[
{
"Member": "SIPSIP1",
"DisplayName": "Walter Melon"
}
{
"Member": "SIPSIP2",
"DisplayName": "John Doe"
}
]
"ErrorCode": 0,
"Description": "OK"
}
AddMember
הסבר כללי
על מנת להגביר את יכולת ניהול המוקד שלכם תוכלו להשתמש במתודה זו על מנת להוסיף נציגים לכל קמפיין של חייגן לנציג שתרצו מתוך מערכת המידע שלכם.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/AddMember
פורמט בקשה
1. GET
2. POST-JSON
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Member | מזהה ייחודי של השלוחה, נקרא גם Sip Code (סיפ קוד). | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/AddMember?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&member=SIPSIP1
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXX",
"Member": "SIPSIP1"
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "2" מעיד על ערך לא תקין שנשלח. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. תיאור של "OK" תתאר בקשה תקינה. תיאור של "Member missing" יעיד על חוסר של ערך בשדה Member. | מחרוזת |
| Data | משתנה מסוג מערך של JSON אשר יציג כמה נציגים נוספו לקמפיין. | מערך |
| TotalAdded | מציג את כמות הנציגים אשר נוספו לקמפיין. במידה והתקבל ערך של 1- זהו סימן שלא נוסף שום נציג עקב בקשה לא תקינה. | מספר שלם |
תשובה לדוגמא
{
"Data":
{
"TotalAdded": 2
}
"ErrorCode": 0,
"Description": "OK"
}
Remove Member
הסבר כללי
על מנת להגביר את יכולת ניהול המוקד שלכם תוכלו להשתמש במתודה זו על מנת להסיר נציגים לכל קמפיין מסוג חייגן לנציג שתרצו מתוך מערכת המידע שלכם.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/RemoveMember
פורמט בקשה
1.GET
2. POST-JSON
פורמט תגובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Member | מזהה ייחודי של השלוחה ברצונכם להסיר מהקמפיין, נקרא גם Sip Code (סיפ קוד). | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
2
https://api.voicenter.com/ForwardDialer/Dialer/RemoveMember?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&member=SIPSIP1
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXX",
"Member": "SIPSIP1"
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "2" מעיד על ערך לא תקין שנשלח. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. תיאור של "OK" תתאר בקשה תקינה. תיאור של "Member missing" יעיד על חוסר של ערך בשדה Member. | מחרוזת |
| Data | משתנה מסוג מערך של JSON אשר יציג כמה נציגים הוסרו מקמפיין. | מערך |
| TotalRemoved | מציג את כמות הנציגים אשר הוסרו מהקמפיין. במידה והתקבל ערך של 0 זהו סימן שלא הוסר שום נציג עקב בקשה לא תקינה. | מספר שלם |
תגובה לדוגמא
{
"Data":
{
"TotalRemoved": 2
}
"ErrorCode": 0,
"Description": "OK"
}
StopCampaign
הסבר כללי
כלי שליטה נוסף שאנחנו מציעים בעזרת API של החייגן הוא האפשרות להפסיק את עבודתו מתוך מערכת המידע שלכם בעזרת שימוש במתודה זו.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/StopCampaign
פורמט בקשה
1.GET
2.POST-JSON
פורמט תגובה
1.POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/StopCampaign?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXXXX"
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "1" מעיד על ערך לא תקין שנשלח. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. תיאור של "OK" תתאר בקשה תקינה. תיאור של "Invalid campaign code" יעיד על ערך לא תקין במשתנה Campaign.. | מחרוזת |
תגובה לדוגמא
{
"ErrorCode": 1,
"Description": "Invalid campaign code"
}
StartCampaign
הסבר כללי
בנוסף ליכולת שלכם לעצור פעילות של קמפיין מסוים בעזרת מערכת המידע שלכם, יש לכם גם אפשרות להפעיל קמפיין לא פעיל על ידי שימוש במתודה StartCampaign.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/StartCampaign
פורמט בקשה
1. GET
2.POST-JSON
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/StartCampaign?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXX"
}
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "1" מעיד על ערך לא תקין שנשלח. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. תיאור של "OK" תתאר בקשה תקינה. תיאור של "Invalid campaign code" יעיד על קוד קמפיין לא תקין במשתנה Campaign. | מחרוזת |
דוגמא לתגובה
{
"ErrorCode": 1,
"Description": "Invalid campaign code"
}
GetCampaignPendingCalls
הסבר כללי
מתודה זו תעזור לכם להבין ולראות כמה יעדים נשאר לחייג אליהם בקמפיין מסוים.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignPendingCalls
פורמט בקשה
1. POST-JSON
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט POST-JSON
1
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXX"
}
פרמטרים בתגובה
| שם שדה | תיאור | סוג שדה |
| ErrorCode | מעיד על סטטוס התגובה: ססטוס התגובה "0" מעיד על חוסר שגיאות ובקשה תקינה. סטטוס התגובה "2" מעיד על קוד קמפיין לא תקין שנשלח. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. תיאור של "OK" תתאר בקשה תקינה. תיאור של "Internal error occurred" יעיד על בעיה עם הקוד קמפיין במשתנה Campaign. | מחרוזת |
| Data | משתנה מסוג מערך אשר מכיל את המידע הבא: מידע כללי במשתנה Campaign ומידע על השיחות הממתינות לחיוג תוכלו למצוא תחת המשנה Calls. | מערך |
| Campaign | משתנה מסוג מערך של JSON אשר מכיל מידע כללי לגבי הקמפיין. | מערך |
| ID | מזהה מספרי ייחודי של הקמפיין. | מספר שלם |
| Name | שם הקמפיין | מחרוזת |
| Status | מציין את סטטוס הקמפיין. סטטוס 1 יציין קמפיין פעיל. סטטוס 2 יציין קמפיין לא פעיל. | מספר שלם |
| Code | קוד קמפיין, לכל קמפיין יש קוד ייחודי משלו אשר בעזרתו ניתן לבצע פעולות רבות בשימוש במתודות המפורטות בעמוד זה. | מחרוזת |
| StatusName | סטטוס הקמפיין. הערך "Enabled" יעיד על קמפיין פעיל. הערך "Disabled" יעיד על קמפיין לא פעיל. | מחרוזת |
| TotalPendingCalls | סכום היעדים שאליהם הקמפיין צריך לחייג. | מספר שלם |
| MaxPriority | עדיפות המקסימלית שניתן ליעד. | מספר שלם |
| MinPriority | עדיפות המינימלית שניתן ליעד. | מספר שלם |
| IsDynamic | שדה זה מסמן את סוג החייגן, השדה יציג את הערך 1 כאשר מדובר על חייגן מסוג חייגן נציג. השדה יציג את הערך 0 כאשר מדובר על חייגן חכם. | בוליאני |
| Calls | משתנה מסוג מערך JSON, יציג את רשימת היעדים שהחייגן צריך לחייג אליהם. | מערך |
| CampaignID | מזהה מספרי ייחודי של הקמפיין. | מספר שלם |
| CallID | מזהה מספרי סידורי של השיחה. לדוגמא, במידה ובחרתם להוסיף 20 יעדים עבור כל שיחה ה CallID שלה יהיה 1, 2, 3 וכן הלאה לפי הסדר. | מחרוזת |
| Phone | מספר טלפון של היעד. | מחרוזת |
| CustomerName | שם היעד | מחרוזת |
| CallerID | מספר הטלפון אשר משמש כמזהה לשיחה ליעד זה. זהו מספר הטלפון שהיעד יראה ברגע שהוא יקבל שיחה ממכם. מספר טלפון המוגדר חייב להיות בחשבונכם. שדה זה יוצג רק במידה והיעד התווסף דרך שימוש ב API ולא נוסף דרך ממשק החייגן האוטומטי בממשק הניהול. | מחרוזת |
| Priority | יציג את העדיפות החיוג שהוגדרה ליעד. יעדים עם עדיפות יותר גבוהה יחוייגו קודם/ | מספר שלם |
| CustomData | מידע שלכם אשר שייכתם ליעד זה בעת ההוספה שלו אל הקמפיין. | מערך |
| OriginateTime | במידה ותרצו לקבוע חיוג בתאריך עתידי בזמן Epoch, תוכלו לבצע שימוש במשתנה זה. במידה ולא נקבע ערך במשתנה זה, החיוג אל היעד יתבצע במועד הכי מוקדם שמתאפשר. במידה וכן החלטתם לבצע שימוש במשתנה זה עליכם גם לכלול את המשתנה IsDateLocal בבקשה שלכם. | מספר שלם |
| CampaignID | מזהה מספרי ייחודי של הקמפיין. | מספר שלם |
| IsDateLocal | משתנה זה קובע האם שיחות עתידיות יתבצעו בזמן מקומי לפי ההגדרה של חשבונכם בממשק הניהול. במידה ואתם קובעים ערך "false" לשדה זה החיוג ליעד שהוספתם יתבצע לפי אזור זמן GMT - 0 בינלאומי. ההמלצה שלנו היא להשתמש בערך "true". | בוליאני |
| CallStatus | משתנה מסוג מערך JSON, אשר יציג סטטוס השיחה שהחייגן צריך לחייג אליהן. | מערך |
| Status | "1" יציג סטטוס של יעד שהוא ממתין לחיוג. | מספר שלם |
| Description | יכיל את הערך "Pending". | מחרוזת |
| CallStatus | מערך מסוג JSON אשר מכיל מידע על סטטוס השיחה. מכיל 2 משתנים: משתנה ראשון הוא Status שהוא סטטוס השיחה. משתנה שני הוא תיאור של סטטוס השיחה אשר יכיל את אחד מהערכים הבאים: ערך ראשון: Tosend וערך שני: Call is in Queue on service. | מערך |
| CallInserted | תאריך וזמן הוספת היעד לחייגן. | מחרוזת |
| CallerName | שם המתקשר שקבעתם ליעד זה. | מחרוזת |
| CustomerName | שם הלקוח שקבעתם ליעד זה. | מחרוזת |
| Priorety | עדיפות החיוג ליעד זה שקבעתם. | מספר שלם |
| LastCallDate | מציג את תאריך וזמן השיחה האחרונה על היעד. הפורמט של המשתנה הוא: YYYY-MM-DD HH:mm:ss.SSS. | מספר שלם |
תגובה לדוגמא
{
"ErrorCode": 0,
"Description": "OK",
"Data":
{
"Campaign":
{
"ID": 13570,
"Name": "קמפיין לידים חמים",
"Status": 1,
"Code": "cNnBe03V3A9LdNIRXVslapVNhEKG75GO",
"StatusName": "Enabled",
"TotalPendingCalls": 7,
"MaxPriority": 1,
"MinPriority": 1,
"IsDynamic": 1
}
"Calls":
[
{
"CampaignID": 13570,
"CallID": "29",
"Phone": "972722776772",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-31T14:31:11.400Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "28",
"Phone": "972722776772",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-31T14:31:11.363Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "27",
"Phone": "972722776772",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-31T14:31:11.323Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "26",
"Phone": "972776048812",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-31T14:31:11.247Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "25",
"Phone": "972722776772",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-30T16:32:41.223Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "24",
"Phone": "972527903511",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-30T16:32:41.120Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
{
"CampaignID": 13570,
"CallID": "23",
"Phone": "972770648812",
"CallStatus":
{
"Status": 1,
"Description": "Tosend"
}
"CallInserted": "2022-08-30T16:32:41.030Z",
"CallerID": "",
"CallerName": "",
"CustomerName": "",
"Priorety": 1,
"LastCallDate": null,
"CustomData": null
}
]
}
}
UpdateCall
הסבר כללי
מתודה זו תעזור לכם לעדכן פרטים של יעד מסוים.
תוכלו לעדכן עדיפות או Custom Data ופרטים אחרים כמפורט מטה ליעד שקיים בקמפיין.
במידה והיעד שביקשתם לעדכן לא מופיע בקמפיין שבו ניסיתי לעדכן את פרטי היעד - מתודה זו תוסיף את היעד.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/UpdateCall
פורמט בקשה
1. GET
2. POST-JSON
פורמט תגובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| Target | מספר טלפון של היעד אליו תרצו לחייג. עליכם להוסיף קידומת בינלאומית למספר טלפון - לא חובה עבור מספרים ישראלים. | מחרוזת | חובה |
| CustomerName | שם של היעד. | מחרוזת | רשות |
| CallerID | מספר מזהה מתקשר אל היעד. זהו מספר הטלפון שהיעד יראה כאשר הקמפיין מחייג אליו. | מחרוזת | רשות |
| Priority | עדיפות של היעד. הקמפיין יחייג ליעדים עם עדיפות יותר גבוהה. | מספר שלם | רשות |
| CustomData | יש באפשרותכם להעביר מידע ייחודי שלכם ליעד שהוספתם בעזרת Custom Data יחד עם ערכים שתרצו לוודא שיישלחו אליכם לאחר סיום השיחה. מידע זה גם יופיע בהקפצת מסך. | מערך | רשות |
| OriginateTime | במידה ותרצו לקבוע חיוג בתאריך עתידי בזמן Epoch, תוכלו לבצע שימוש במשתנה זה. במידה ולא נקבע ערך במשתנה זה, החיוג אל היעד יתבצע במועד הכי מוקדם שמתאפשר. במידה וכן החלטתם לבצע שימוש במשתנה זה עליכם גם לכלול את המשתנה IsDateLocal בבקשה שלכם. | מספר שלם | רשות |
| IsDateLocal | משתנה זה קובע האם שיחות עתידיות יתבצעו בזמן מקומי לפי ההגדרה של חשבונכם בממשק הניהול. במידה ואתם קובעים ערך "false" לשדה זה החיוג ליעד שהוספתם יתבצע לפי אזור זמן GMT - 0 בינלאומי. ההמלצה שלנו היא להשתמש בערך "true". | בוליאני | רשות |
בקשה בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/UpdateCall?Campaign=XXXXXXXXXXXXXXXXXXXXX&Target=0501234567&CustomerName=John Doe&Priority=42&var_leadID=1234567
בקשה בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | סטטוס התגובה לבקשה שלכם: הערך "0" יעיד על בקשה תקינה וחוסר שגיאות.הערך "1" יעיד על קוד קמפיין לא תקין. הערך "2" יעיד על חוסר מספר טלפון של יעד לחיוג. הערך "2-" יעיד על מספר טלפון לא תקין. | מספר שלם |
| Description | תיאור מילולי של סטטוס התגובה. התיאור "OK" יעיד על בקשה תקינה וחוסר שגיאה. התיאור "Invalid campaign code" יעיד על קוד קמפיין לא תקין. התיאור "Campaign code missing" יעיד על חסרון של קוד קמפיין. התיאור "Target missing" יעיד על חסרון של קוד קמפיין בבקשה שלכם. התיאור "Number is invalid" יעיד על מספר טלפון לא תקין. |
תשובה לדוגמא
{
"ErrorCode": 0,
"Description": "OK"
}
GetCampaignDetails
הסבר כללי
מתודה זו תחזיר לכם פרטים ומידע עבור קמפיין מסוים.
קישור
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignDetails
פורמט בקשה
1.GET
2. POST-JSON
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignDetails?Campaign=XXXXXXXXXXXXXXXXXXXXX
בקשה לדוגמא בפורמט POST-JSON
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXX"
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | סטטוס התגובה לבקשה שלכם. במידה והבקשה שלכם תקינה הסטטוס יהיה "0". כל ערך אחר יעיד על בעיה. | מספר שלם |
| Description | תיאור התגובה לבקשה שלכם. במידה והבקשה שלכם תקינה התיאור יהיה "OK", כל תיאור אחר יעיד על בעיה. | מחרוזת |
| Data | מערך אשר מכיל את המידע על הקמפיין שביקשתם לקבל. | מערך |
| Name | שם הקמפיין. | מחרוזת |
| StatusName | סטטוס הקמפיין אשר מכיל 2 ערכים. הערך :Enabled" יעיד על קמפיין פעיל. הערך "Disabled" יעיד על קמפיין כבוי. | מחרוזת |
| TotalPendingCalls | כמות היעדים אשר הקמפיין ממתין לחייג אליהם. | מספר שלם |
| MaxPriority | העדיפות המירבית לחיוג שהוגדר ליעד. | מספר שלם |
| MinPriority | העדיפות המינימלית לחיוג שהוגדר ליעד. | מספר שלם |
| TotalAwaitingCalls | שדה זה רלוונטי רק עבור קמפיין מסוג חייגן חכם. שדה זה מציג את סכום היעדים לחיוג קמפיין. שדה זה יותר מומלץ לשימוש מאשר שדה "TotalPendingCalls" עבור קמפיין מסוג חייגן חכם. במידה ומדובר על קמפיין מסוג חייגן לנציג שדה זה יציג "null". | מספר שלם |
| Code | מזהה ייחודי של הקמפיין. | מחרוזת |
תגובה לדוגמא
{
"Data":
{
"Name": "Campaign1",
"StatusName": "Enabled",
"TotalPendingCalls": 23,
"MaxPriority": 1,
"MinPriority": 1,
"TotalAwaitingCalls": 23,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
"ErrorCode": 0,
"Description": "OK"
}
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
| setQueueForMonitoring | מזהה ייחודי של מעגל ההמתנה, משמש עבור זיהוי איזה מעגל המתנה על החייגן לנטר פעילות שלו. מזהה מעגל המתנה ניתן למצוא דרך תפריט מעגל המתנה בממשק הניהול. | מספר שלם | חובה |
| setQueueMaximumCallers | מספר הממתינים המירבי שאתם מעונינים שיהיו במעגל ההמתנה שאותו הקמפיין מנטר. הערך שאתם מגדירים בשדה זה חייב להיות יותר גדול מ"0". | מספר שלם | חובה |
| setCoefficient | ערך מקדם קצב שיחות החיוג בקמפיין. יש לרשום ערך יותר גדול מ "1". | מספר שלם | חובה |
{
"Campaign": "xxxxxxxxxxxxxxxxxxxx",
"setQueueForMonitoring": 123456789,
"setQueueMaximumCallers": 1,
"setCoefficient": 2
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | סוג שדה |
| ErrorCode | ססטוס התגובה לבקשה שלכם. ערך "0" יעיד על בקשה תקינה וללא שגיאות. | מספר שלם |
| Description | תיאור סטטוס התגובה. הערך "OK" יתאר בקשה תקינה שלכם ללא שגיאות. | מחרוזת |
תגובה לדוגמא
{
" ErrorCode": 0,
"Description": "OK"
}