Dialer API

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

 

הסבר כללי

 

סוגי חייגן

 

כאשר הנכם מקימים חייגן אוטומטי תוכלו לפתוח מספר קמפיינים כאשר כל קמפיין משרת מטרה מסוימת (חיוג ללידים חמים/קרים/לידים שהשאירו פרטים מדף נחיתה ועוד).

הקמפיין יכול להיות מסוג מסוים:

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

 

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

  1. תוכלו לבחון אילו קמפיינים פעילים כרגע בארגונכם.
  2. תוכלו להוסיף/להסיר יעדים לחיוג.
  3. תוכלו להפסיק קמפיין מסוים או להפעיל קמפיין כבוי.
  4. תהיה לכם אפשרות להוסיף/להסיר נציגים מקמפיין.

כל מה שתצטרכו לבצע הוא בקשת HTTP פשוטה למתודות המפורטות מטה:

 

 

GetCampaignList

 

הסבר כללי

 

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

 

פורמט בקשה

  1. POST-JSON
  2. GET

 

פורמט תשובה

  1. 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
        

פורמט בקשה

  1. POST-JSON
  2. GET

 

פורמט תגובה

  1. 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 - המפורטת מעלה.

 

מגבלות

 

  1. ניתן להעביר בבקשה אחת עד 100,000 יעדים.
  2. עד 3,000 יעדים תתקבל תשובה מפורטת על תוצאת העלאת כל יעד(כפי שמפורט מטה). מעבר לכמות זאת תתקבל תשובה כללית שהקריאה בוצעה.

פורמט בקשה

 

  1. POST-JSON

 

פורמט תשובה

 

  1. 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במידה ובחשבונכם מופעל שירות חסימת שיחות מהמאגר הממשלתי - "אל תתקשר אלי",
יש באפשרותכם לאפשר שיחות ליעדים חסומים במאגר בשירות החייגן האוטומטי במידה ותעבירו שדה זה.
בוליאנירשות
asyncאנחנו מחזירים תשובה פרטנית על כל יעד שנשלח עד כמות של 3,000 יעדים בקריאה. מעבר לכמות הנ"ל השירות מחזיר תשובה כללית ולא מפרט. במידה ויועבר ערך true בשדה זה, המערכת לא תאפשר שליחה של כמות מעבר של 3,000 יעדים. למעשה מחייבים את השירות להחזיר תשובה פרטנית.בוליאנירשות

 

בקשה לדוגמא בפורמט 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"
}