2. רגל 2 (Leg 2) היא השיחה ליעד שנבחר (בעקבות תשובה לשיחת רגל 1), זה מוגדר על ידי הגדרת מספר הטלפון של הלקוח בפרמטר היעד.
https://api.voicenter.com/forwardDialer/click2call.aspx
https://api.voicenter.com/ForwardDialer/click2call.aspx?phone=XXXXXXXX&target=057XXXXXXX&code=XXXXXXXXXXX&action=call
1. שיחה יוצאת.
2. חיוג והשמעת הקלטה.
3. שיחת ועידה.
1. POST - JSON
2. GET
הגדרת פורמט התגובה תבוצע בעת שליחת הפורמט הרצוי בבקשה עצמה.
1. XML - מוגדר כברירת מחדל.
2. JSON
פרמטר | תיאור | חובה/רשות |
Phone | "הרגל" הראשונה שבה שיחת הקליק2קול תחייג. אפשר להטמיע מזהה של שלוחה (SIP, לדוגמא -API1API2) או מספר טלפון בפורמט E.164 אך ללא + (לדוגמא: 972521234567). יש לרשום מספר טלפון ישראלי בצורה הבאה *********0. במידה והחיוג אמור להתבצע לסיפ טראנק יש להגדיר: Phone=SIPTRUNK בבקשה שלכם. במידה ושלוחת וויסנטר בבקשה שלכם תלויה בביצוע לוגין למען הוצאת שיחות על הבקשה שלהם להיראות כך: יש לבצע שימוש בפרמטרים: phone=logincode & phonelogincode=[login code] - את הפרטים הללו ניתן להשיג מתוך ממשק הניהול. | חובה |
target | "הרגל" השנייה שבה השיחה תחייג - היעד אליו אתם מחייגים. אפשר להטמיע מזהה של שלוחה (סיפ) או מספר טלפון בפורמט E.164 אך ללא +. יש לרשום מספר טלפון ישראלי בצורה הבאה *********0. | חובה |
code | קוד ייחודי לחשבון. (הקוד ימסר על ידי מחלקת התפעול שלנו). | חובה |
action | Call (action=call). | חובה |
record | האם להקליט את השיחה? יש להעביר את אחד מהערכים הבאים: True/False. | רשות |
phonecallerid | מספר מזהה של "הרגל הראשונה" - השיחה הנכנסת לשלוחה/מספר טלפון בשדה Phone בבקשה שלכם. * לא נתמך על ידי כלל הספקים החיצונים. | רשות |
phonecallername | שם מתקשר של "הרגל הראשונה" - השיחה הנכנסת לשלוחה/מספר טלפון בשדה Phone בבקשה שלכם. * לא נתמך על ידי כלל הספקים החיצונים. | רשות |
targetcallerid | מספר טלפון מזהה של "הרגל השנייה" - השיחה היוצאת ליעד שלכם בשדה Target בבקשה שלכם. * לא נתמך על ידי כלל הספקים החיצונים. | רשות |
targetcallername | שם מתקשר של "הרגל השנייה" - השיחה היוצאת ליעד שלכם בשדה Target בבקשה שלכם. * לא נתמך על ידי כלל הספקים החיצונים. | רשות |
phonemaxdialtime | זמן חיוג מקסימלי בשניות של "הרגל הראשונה" - השיחה הנכנסת לשלוחה/מספר טלפון בשדה Phone בבקשה שלכם. ערך ברירת מחדל הוא 60 שניות. | רשות |
targetmaxdialtime | משך זמן חיוג מקסימלי של היעד "הרגל השנייה", מוצג בשניות. אם לא הוזן, ברירת מחדל הינה 60 שניות. | רשות |
maxduration | משך השיחה מקסימלי בשניות. אם לא הוזן, ברירת מחדל הינה 7200 שניות(שעתיים). | רשות |
phoneautoanswer | רק עבור שלוחות Voicenter, עם הערכים 1 או true למענה אוטומטי. אם לא צוין מוגדר כ- False. | רשות |
targetautoanswer | רק עבור שלוחות Voicenter, עם הערכים 1 או true למענה אוטומטי ביעד השיחה. אם לא צוין מוגדר כ- False. | רשות |
checkphonedevicestate | חסום את השיחה אם השלוחה לא מחוברת. | רשות |
checktargetdevicestate | אימות לפני ביצוע שיחה. וודא כי השלוחה אליה מתקשרים מחוברת. | רשות |
format | פורמטים אפשריים לתגובת קליק2קול: XML / JSON שברצונכם לקבל. ברירת המחדל היא XML. | רשות |
var_* | כל פרמטר מותאם אישית עם קידומת "var_" שברצונכם להעביר בבקשה שלכם. לדוגמא var_customer=2342 זה פרמטר שברצונכם להוסיף לבקשה שלכם. פרמטר זה יוצג בהתראות של תוסף הכרום שלנו. מידע זה גם מועבר בלוג השיחות שנשלח בAPI שלנו. המגבלה היא 10 פרמטרים. | רשות |
פרמרטר | תיאור | רשות/חובה |
Phone | מזהה שלוחה של חברת וויסנטר שעבורה תרצו לנתק את השיחה. | חובה |
code | קוד ייחודי לחשבון. (הקוד ימסר על ידי מחלקת התפעול שלנו). | חובה |
action | terminate (action=terminate). | חובה |
התשובה תגיע בפורמט XML (XML-RPC) או בפורמט JSON לבחירתכם.
ברירת המחדל היא XML-RPC.
התשובה של השירות תכלול 3 פרמטרים:
1. ERRORCODE - קוד השגיאה (פירוט של קודי השגיאה בטבלה המופיעה מטה).
2. (String)ERRORMESSAGE - תמצית הודעת השגיאה (כמפורט מטה).
3. (String)CALLID - מזהה שיחה ייחודי בעל 32 תווים (במידה והשיחה נכשלה השדה יהיה ריק).
ERRORCODE יכלול את אחד הקודים הבאים:
קוד | תיאור |
0 | Ok |
1 | Invalid request parameters. |
2 | Application error. |
3 | Extension representative offline. |
4 | Extension blocked for Click2Call calls. |
<methodResponse> <params> <param> <value> <struct> <member> <name>ERRORCODE</name> <value><string>1</string></value> </member> <member> <name>ERRORMESSAGE</name> <value><string>Phone is missing</string></value> </member> <member> <name>CALLID</name> <value><string></string></value> </member> </struct> </value> </param> </params> </methodResponse>
1. מתבצעת שיחה נכנסת מלקוח מתקשר.
2. תוסף לדפדפן כרום של Voicenter שולח את פרטי השיחה אל שרת שלכם בעזרת בקשת Http (אינטגרציית הקפצת המסך ניתנת למימוש ללא התוסף לכרום באמצעות Real-Time API).
3. השרת שלכם מעבד את המידע ומחזיר תשובה לתוסף לכרום של Voicenter.
4. התוסף לכרום שלנו מציג ויזואלית במסך של הנציג את שם הלקוח, בלחיצה על הבועית הייעודית ניתן לפתוח את כרטיס הלקוח.
1. GET
2. POST
1. JSON
1. GET:
https://www.yourdomain.com/contact_search.asp?phone=0722776772&ivrid=202010111sdsd3684752bcb3d&extenU ser=SIPSIPl&did=0722776773&statusCall=Ringing
2. POST- Application/X-WWW-Form-Urlencoded:
phone=0722776772&ivrid=202010111sdsd3684752bcb3d&extenUser=NaDzw5Ol&did=0722776773&status=Ringing
שם שדה | תיאור | סוג שדה |
phone | מספר טלפון של הלקוח | מחרוזת |
ivrid | מזהה שיחה ייחודי | מחרוזת |
extenUser | מזהה שלוחה ייחודי. התוסף מעביר את המזהה של השלוחה שבה התרחש צלצול/מענה/ניתוק. | מחרוזת |
did | מספר טלפון שאליו הלקוח קצה התקשר. | מחרוזת |
statusCall | מצב השיחה. הערך יהיה "Ringing" עבור שיחות נכנסות כאשר הן מצלצלות. עבור שיחות יוצאות שמחייגות ליעד סטטוס השיחה יהיה Dialing. | מחרוזת |
שם שדה | תיאור | סוג הפרמטר | רשות/חובה |
STATUS | מקבל אך ורק ערך "OK", ערך אחר יעיד על בעיה בצד לקוח (מצד מערכת המידע שלכם). שימו לב כי OK צריך להיות באותיות גדולות. | מחרוזת | חובה |
URL | קישור לכרטיס הלקוח שאותר בתוך מערכת המידע שלכם. | מחרוזת | רשות |
CLIENTNAME | שם הלקוח שאותר במערכת המידע שלכם. | מחרוזת | רשות |
TOTAL | כמות הרשומות שאותרו שנמצאו במערכת המידע. | מספר שלם | רשות |
COMPANY | שם החברה של הלקוח המתקשר שאותרה במערכת המידע שלכם. | מחרוזת | רשות |
1. ניתן להוריד את התוסף כרום כאן. לאחר הורדת התוסף, תתבקשו להזין את שם המשתמש והסיסמא הייחודיים לכל משתמש אותם ניתן למצוא בממשק Cpanel.
2. התוסף מותקן בעמדת המחשב המקומית של כל נציג, שליחת בקשות יבוצעו דרך כתובת ה-IP של הרשת ממנה הנציג מחובר לרשת.
3. במקרה בו שיחה תצלצל בו זמנית במספר שלוחות במקביל, כל תוסף לכרום ישלח בקשה נפרדת לשירות אינטרנט (Web-Service) בנקודת הקצה (End Point). לדוגמא, אם שיחה מצלצלת בעשר שלוחות במקביל, וכל אחד מהנציגים עושה שימוש בתוסף לכרום של Voicenter, עשרה בקשות HTTP ישלחו לשרת לקוח (Client Server) וכל אחד מהם ימתין לתגובה.
4. בהגדרות התוסף לכרום של Voicenter, תתבקשו לקבוע איזה סוג של שיחות יקפיצו את המסך (נכנסות/ יוצאות/ קליק2קול). במילים אחרות, באיזה סוג שיחה התוסף לכרום ישלח בקשה. לדוגמא, ניתן להגדיר שהתוסף יקפיץ מסך אך ורק בשיחות יוצאות (כלומר יתעלם משיחות יוצאות).
5. במידה והמתקשר מוגדר כאיש קשר במערכת ה-CRM ונשלח קישור (שדה "URL"), לחיצה על ידי הנציג על החלונית שמוקפצת על המסך תפתח חלון חדש בדפדפן עם הכרטיס לקוח. ניתן להגדיר בהגדרות התוסף שעמוד איש הקשר יפתח באופן אוטומטי ללא צורך בפעולה מצד הנציג בעת שיחה נכנסת.
התוסף לכרום של Voicenter מאפשר מעבר להקפצת המסך גם Click2Call (חיוג בלחיצה) המחובר באופן מיידי עם החשבון שלכם ב-Voicenter. ה-Click2Call מאפשר חיוג מתוך כל דף אינטרנט אשר נפתח בדפדפן כרום - קליק ימני על המספר הרצוי ובחירה בclick2call מתוך התפריט גלילה שנפתח אוטומטית. תכונת ה-Click2Call מאפשרת להגדיר חיבור שיחה לשלוחת Voicenter, טלפון נייד, מספר חיצוני או כל יעד רצוי לחיבור השיחה.
בעת התקנת התוסף מתקבלת התראה "This extension will have access to all browsing history and private data on all websites". מדובר בהתראת ברירת מחדל שמוצגת בכל תוסף שדורש הרשאת גישה של סקריפט תוכן לכל אתרי האינטרנט. הגישה הזו נדרשת לטובת זיוי מספרי טלפון לחיוג בקליק במקום שתחייגו באופן ידני.
לאחר סיום השיחה Voicenter מנתחת את נתוני השיחה מעבדת אותם ומייצרת פרטי שיחה שאותם אנו שולחים לשרת של מערכת המידע שלכם בבקשה (Request) HTTP פשוטה - עליכם להחזיר אלינו תגובה (Response) 200 על מנת שנדע שהמידע התקבל אצלכם בהצלחה.
מתוך המידע המתקבל תוכלו:
1. לשלוח התראה במייל/סמס/וואטצאפ למנהל המוקד על שיחה שננטשה.
2. לשלוח סמס/וואטצאפ ללקוח שנטש המתנה.
3. להציג במערכת המידע שלכם היסטורית שיחות של לקוח מסוים.
4. לתעד את ההקלטות במערכת המידע שלכם תחת אותה ישות.
5. לייצר דוחות לבחינה BI עסקי ולנתח עומס פעילות, תפוקות של נציגים בשיחות נכנסות או יוצאות.
6. לראות באילו יעדים ומדינות יש אחוזי מענה יותר גבוה לשיחות יוצאות שאתם מבצעים.
7. מגוון רב של פעולות אשר יאפשרו לכם לנטר את הפעילות העסקית שלכם ולשפר תהליכים עסקיים עקב זאת.
שדה | תיאור | דוגמא |
caller | מציג את מספר הטלפון של המתקשר. מספר הטלפון שהיעד רואה בעת קבלת השיחה. | "caller":"0722776772" |
target | מציג את יעד השיחה. הפרמטר יכול להיות מספר טלפון או מזהה שלוחה. נא שימו לב כי מספר טלפון יישלח עם קידומת בינלאומית. | "target":"SIPSIP" / "target":"972722776772" |
time | מציג את מועד תחילת השיחה בזמן Epoch. | "time":1536855354 |
duration | מציג את משך השיחה בשניות. נתון זה אינו כולל את משך צלצול השיחה בשלוחה/ות אלא רק את משך השיחה עצמה. | "duration":33 |
ivruniqueid | מציג מזהה שיחה ייחודי. | "ivruniqueid":"20200720095iMlilHJs" |
type | מציג את סוג השיחה. לדוגמא: האם מדובר על שיחה יוצאת? או שיחת מעגל? יש מספר רב של סוגי שיחה, אנא התבוננו בטבלה מטה. | "type":"Incoming Call" / "type":"Extension Outgoing" / "type":"Click2Callleg1" |
status | מציג את התוצאה של השיחה. האם השיחה ננטשה? נענתה? במידה ולשיחה יש שתי רגליים (כמו שיחות קליק2קול וחייגן) אז פרמטר זה יציג את התוצאה של הרגל 2 של השיחה. לפירוט נוסף על תוצאות שיחה אפשריות יש לעיין בטבלה מטה. | "status":"ANSWER" / "status":"ABANDONE" / "status":"TE" |
leg1DialStatusName | במידה ולשיחה היו 2 רגליים (כגון שיחות קליק2קול וחייגן), שדה זה יציג את התוצאה של הרגל ראשונה. | "leg1DialStatusName": "ANSWER"/ "leg1DialStatusName": "ABANDONE" / "leg1DialStatusName":"TE" |
targetextension | מציג את מזהה השלוחה שענתה לשיחה הנכנסת. לעיתים הערך בפרמטר זה יהיה זהה לערך בפרמטר target שרשום מעלה. ישנם מקרים שבהם שיחה נכנסת אינה מגיעה ישירות לשלוחה ולכן השדה target עשוי להכיל ערכים שונים. | "targetextension":"SIPSIP" |
callerextension | מציג את מזהה השלוחה אשר ביצעה שיחה יוצאת. שדה זה שונה משדה caller מאחר ושדה caller מציג את המספר המזהה של השלוחה המתקשרת. | "callerextension":"SIPSIP" |
did | מציג את מספר הטלפון שאליו התקשרו בשיחה נכנסת. | "did":"0722776772" |
queueid | במידה והשיחה נותבה למעגל המתנה, שדה זה יציג את המזהה של המעגל. השדה יציג 0 במידה והשיחה לא עברה במעגל המתנה. | "queueid":1234567 |
queuename | במידה והשיחה נותבה למעגל המתנה, שדה זה יציג את שם המעגל. | "queuename":"Service Queue" |
record | מציג את קישור להקלטת השיחה. | https://cpanel.voicenter.co.il/CallsHistory/PlayRecord/202205181005020246363e832-aws-Rojxp5-972521112233.mp3 |
price | מציג את תמחור השיחה באגורות. | "price":7 |
dialtime | מציג את זמן צלצול/חיוג השיחה בשניות. פרמטר זה אינו מציג את משך השיחה. | "dialtime":23 |
representative_name | מציג את שם המשתמש של השלוחה שמקושרת לשיחה. במידה ויוזר לא ביצע לוגין בזמן השיחה, שדה זה יציג את שם המתשמש שמקושר לשלוחה/מספר של שיחה זו. | "representative_name": "Walter Melon" |
representative_code | מציג את מזהה המשתמש אשר השיחה מקושרת אליו. במידה והמשתמש לא ביצע לוגין, שדה זה יציג את מזהה המשתמש אשר מקושר לשלוחה או למספר טלפון אשר מקושרים לשיחה. | "representative_code":"9996" |
targetextension_name | מציג שם שם השלוחה אשר ענתה לשיחה. | "targetextension_name": "Walter Melon" |
callerextension_name | מציג את שם השלוחה אשר ביצעה את השיחה. | "callerextension_name": "Walter Melon" |
target_country | מציג את שם המדינה שאליה בוצעה שיחה יוצאת. | "target_country":"Israel" |
caller_country | מציג את שם המדינה שממנה התקבלה השיחה. | "caller_country":"Israel" |
seconds_waiting_in_ queue | שדה זה מכיל את משך ההמתנה של הלקוח בשיחה הרלוונטית במעגל המתנה. שדה זה לא יישלח במידה והשיחה לא עברה במעגל המתנה. | "seconds_waiting_in_queue":5 |
OriginalIvrUniqueID | שדה זה יישלח אך ורק במידה והשיחה הזו הייתה מקושרת לשיחה אחרת. לדוגמא במקרה של שיחות שהועברו שדה זה יכיל את מזהה השיחה של השיחה שהועברה. | "OriginalIvrUniqueID": "201809131730110122A1212" |
DepartmentName | שדה זה מכיל את שם החשבון אשר השיחה מקושרת אליו. | "DepartmentName": "Voicenter Account" |
DepartmentID | שדה זה מכיל את מזהה החשבון אשר השיחה מקושרת אליו. | "DepartmentId":123456 |
TopDepartmentName | שדה זה מכיל את שם החשבון הראשי אשר השיחה מקושרת אליו. | "DepartmentId":123456 |
TopDepartmentID | שדה זה מכיל את מזהה החשבון הראשי אשר השיחה מקושרת אליו. | "TopDepartmentID":7654321 |
IVR | פרמטר מסוג מערך אשר מציג את השכבות בנתב שהשיחה עברה בהם. השדות הם: שדה: Layer_id מציג את המזהה הייחודי של השכבה. שדה Layer_name - מציג את שם השכבה כפי שמופיע בממשק הנתב. שדה DTMF - מציג את הלחיצות של הלקוח בנתב. במידה ולא הייתה לחיצה הערך יהיה 0. שדה LayerNumber - יציג את מספר השכבה. שדה dtmf_order - מציג את סדר מעבר השיחה בשכבות. | "IVR": "[{ \"layer_id\":1234567, \"layer_name\":\"LayerName\, \"layer_number\":6, \"Dtmf\":0, \"dtmf_order\":1 }]" |
להלן פירוט על סוגי השיחות השונים אשר יכולים להיווצר:
סוג שיחה | תיאור |
Incoming Call | שיחה נכנסת רגילה. לקוח קצה חייג אליכם למספר טלפון שלכם, השיחה נכנסה לנתב וצלצלה בשלוחה אחת או מספר שלוחות. * השיחה לא עברה במעגל המתנה. |
CC | שיחה שבוצעה בעזרת שירות מספר גישה של חברת וויסנטר. |
Extension Outgoing | שיחה יוצאת רגילה משלוחה של וויסנטר. * לא שיחת קליק2קול. |
Queue | שיחה נכנסת שהתקבלה אל מעגל המתנה. |
Click2Call leg1 | שיחת קליק2קול (לא שיחת חייגן). "רגל 1" של השיחה - השיחה בין השירות לשלוחה שאמורה לחייג ליעד ב"רגל 2" של השיחה. |
Click2Call leg2 | שיחת קליק2קול (לא שיחת חייגן). "רגל 2" של השיחה - השיחה בין השלוחה ליעד. ברשומה זו תקבלו תיעוד על פרטי השיחה וקישור להקלטות השיחה. |
VoiceMail | שיחה אשר נענתה על ידי שירות התא קולי של וויסנטר. |
Callference | שיחה שבוצעה בעזרת שירו תחדר וועידה של חברת וויסנטר. |
XferCDR | שיחה אשר הוערה ידנית משלוחה של מספר/שלוחה אחרת. |
ProductiveCallLeg1 | שיחת "רגל 1" של חייגן לנציג - השיחה אשר מחברת בין השירות לנציג. |
ProductiveCallLeg2 | שיחת "רגל 2" של חייגן לנציג - השיחה אשר מחברת בין הנציג ליעד/לקוח/ליד שהזנתם בחייגן. |
Scrubber | שיחה שבוצעה דרך שירות הסקראבר של חברת וויסנטר. |
Click 2 IVR | שיחת "רגל 1" של חייגן חכם - השיחה הראשונית בין החייגן ליעד. |
Click 2 IVR Incoming | שיחת "רגל 2" של חייגן חכם - השיחה שמתרחשת לאחר חיבור מוצלח ומענה של היעד "ברגל ה1". בסוג שיחה זה מתבצע חיוג מהיעד אל נתב השיחות שלכם. סוג שיחה זה מסמן כי השיחה לא עברה למעגל המתנה אלא הועברה ישירות לנציג או השמעת הקלטה. ברשומה זו תקבלו את סטטוס השיחה וקישור להקלטת השיחה. |
Click 2 Queue Incoming | שיחת "רגל 2" של חייגן חכם - השיחה שמתרחשת לאחר חיבור מוצלח ומענה של היעד "ברגל ה1". בסוג שיחה זה מתבצע חיוג מהיעד אל נתב השיחות שלכם. סוג שיחה זה מסמן כי השיחה עברה למעגל המתנה והיעד המתין עד למענה של נציג. ברשומה זו תקבלו את סטטוס השיחה וקישור להקלטת השיחה. |
FaxCdr | שיחה אשר בוצעה דרך שירות הפקס הפנימי של וויסנטר. *השירות לא פעיל עדיין. |
Attended CDR leg1 | שיחה בהעברה עם התייעצות. |
Attended CDR leg2 | שיחה בהעברה עם התייעצות. רשומה זו תתקיים כאשר מתבצע תסריט שיחה הבא: נציג א' עונה לשיחה נכנסת, הלקוח מבקש לדבר עם נציג ב'. נציג א' מתקשר אל נציג ב'. לאחר מכן נציג א' מעביר את השיחה והלקוח לנציג ב'. סוג שיחה זה נותן מידע על השיחה של הלקוח עם נציג ב'. |
Auto forward | שיחה שהועברה באופן אוטומטי משלוחה למספר טלפון - בדרך כלל מדובר על הגדרה דרך הטלפון IP. |
יש מספר סוגי שיחות אשר מורכבות משתי שיחות בפועל:
להלן פירוט על סטטוס שיחה (תוצאה של השיחה לאחר סיומה):
שם סטטוס | תיאור |
NOTDIALED | ניתוק לפני ביצוע שיחה. |
ANSWER | מענה של שיחה לאחר חיוג/צלצול מוצלח. השיחה הגיעה ליעדה. מענה מתרחש כאשר וויסנטר מקבל איתות של מענה בשיחהכ מו כן גם הגעת השיחה לתא קולי. |
BUSY | כאשר מנסים לבצע חיוג ליעד מסוים אבל מספר הטלפון שולח בחזרה איתות של "עסוק". |
NOANSWER | אין מענה. השיחה הגיעה ליעד אך צלצלה למשך זמן מסוים עד לאי מענה. |
CANCEL | ביטול שיחה. מצב זה קורה כאשר מחייגים ליעד מסוים אבל מתבצע ניתוק לפני מענה ביעד. |
ABANDONE | שיחה שננטשה לאחר המתנה במעגל המתנה ומתרחש במצבים הבאים: בוצע ניתוק של השיחה לפני מענה. יציאה מהמעגל בעת המתנה. לקוח המתין זמן המתנה מקסימלי. |
VOEND | ניתוק של השיחה במעמד הנתב ללא צלצול בשלוחה כלשהי או מעגל המתנה. במקרה זה לקוח התקשר הגיע לנתב השיחות וניתק. |
TE | מתרחש כאשר השיחה מגיעה לנתב השיחות ומשמיעה הקלטה ולאחר מכן מתנתקת. |
NOTCALLED | סטטוס זה מציין כי הרגל השנייה של השיחה לא בוצעה מאחר והרגל ה1 של השיחה לא הייתה מוצלחה (השיחה לא התחברה לשלוחה). |
VOICEMAIL | שיחה הגיעה לתא הקולי של וויסנטר. |
CONGESTION | סטטוס זה מסמל לרוב חיוג ליעד לא מוכר. |
CHANUNAVAIL | ערוץ לא זמין או שלוחה לא מחוברת ורשומה. |
INVALIDARGS | שגיאה בעיבוד פקודת חיוג ליעד. |
SSWPREAUTH | ביטול שיחה יוצאת לפני ביצוע חיוג. |
שיחה יוצאת:
נציג "User 1" ביצע שיחה יוצאת מהשלוחה שלו (SIPSIP) אל היעד 0501234567, היעד קיבל שיחה ממספר: 0722776772.
השיחה נענתה לאחר חיוג של 2 שניות.
אורך השיחה היה 11 שניות.
שיחה נכנסת:
בדוגמא זו ניתן לראות כי התקבלה שיחה נכנסת מהמספר 0501234567 אל המספר 0722776772.
השיחה עברה בשכבה Main IVR והלקוח המתקשר הקיש על ספרה 2 בשכבה זו ונותב לשכבה Sales Department לאחר מכן.
השיחה הגיעה למעגל המתנה Sales Queue ולאחר המתנה של 20 שניות השיחה נענתה.
אנחנו רואים חשיבות גדולה בכך שתחזירו אלינו תגובה (Response) אשר מעידה על קבלת מידע באופן תקין.
במידה ולא תחזירו לנו תשובה תקינה אנחנו נבצע שליחה חוזרת של פירוט השיחה בטווחי הזמן אשר נקבעים מראש.
שם | סוג | דוגמא | תיאור |
Err | מספר שלם | 0 | קודי הודעה: 0 – OK 1 – Parse error 2 – Application error |
Errdesc | מחרוזת | OK | תיאור השגיאה. |
אתם מוזמנים להיכנס לממשק הניהול בכתובת: https://cpanel.voicenter.co.il/ApiManager/Index ולהטמיע את השירות באופן עצמאי.
https://api.voicenter.com/hub/cdr
1. POST
2. GET
1. JSON
הפנייה שלכם בעצם צריכה להיות מורכבת משני חלקים:
1. הסינון שלפיו אנו נחזיר אליכם את פרטי השיחה - לדוגמא סינון לפי תאריך בפרמטרים: Fromdate + Todate.
כמו כן ישנם שדות נוספים שיאפשרו לכם לבצע סינון נוסף - מצוף בטבלה מטה.
2. השדות שתרצו לקבל בחזרה - בתגובה שלנו אנו נחזיר אליכם את פרטי השיחה שתרצו לקבל, בבקשה שלכם תצטרכו להעביר אילו פרמטרים תהיו מעוניינים לקבל חזרה.
לדוגמא, במידה ותהיו מעוניינים לדעת רק מה הקישור להקלטה, מספר טלפון של הלקוח בשיחה נכנסת ומזהה שיחה - אם תבקשו מאיתנו לקבל רק שדות אלו, שדות אחרים לא יועברו אליכם.
* סינון המידע מתייחס על פי איזה פרמטרים יועבר לכם המידע? למשל על פי אילו תאריכים? לפי איזה מספר טלפון? וכן הלאה, כמפורט מטה.
שדה | תיאור | סוג |
code | מחרוזת | קוד ייחודי לחשבון שלכם. פרמטר חובה. |
fromdate | תאריך וזמן תחילת סינון בפורמט ISO 8601, הפרמטר הוא באזור זמן GMT 0. | חובה. |
todate | תאריך וזמן סוף סינון בפורמט ISO 8601, הפרמטר הוא באזור זמן GMT 0. | חובה. |
phones | מערך של מחרוזות, כל מחרוזת היא ספר טלפון יחד עם קידומת מדינה. מספר טלפון ישראלי ניתן לרשום ללא קידומת בינלאומית. | רשות. |
extensions | מערך של מחרוזות, כל מחרוזת היא מזהה של שלוחה של Voicenter. | רשות. |
IdentityCriteria | חיפוש לפי רמת חשבון, ניתן להגדיר אחת מהאפשרויות הנ"ל: חיפוש לפי כל החשבון - Account - תקף במידה ותרצו לקבל מידע על כלל החשבון לפי הקוד שהזנתם. חיפוש לפי חשבון מסוים והחשבונות תחתיו - Hierarchical - מומלץ במידה ובתת חשבון מסויים יש מספר תתי חשבונות מתחתיו. חיפוש רק לפי חשבון מסוים - Department - רלוונטי במידה ואתם רוצים תוצאה רק של חשבון מסוים חיפוש של שיחות של משתמש מסוים בלבד - User - יש להעביר את הקוד של אותו משתמש בנוסף לפרמטר זה. | רשות. |
CallID | מחרוזת, תוכלו לחפש שיחה ספציפית. | רשות. |
cdrTypes | מערך של מספרים שלמים, נותן לכם את האפשרות לסנן תוצאות על פי סוגי שיחה מסוימים. | רשות. |
כמו כן, תוכלו לקבוע באיזה סדר הסינון יופיע והאם בסדר עולה או יורד.
שדה | תיאור | סוג | תיאור |
field | שם של השדה שלפיו יתבצע המיון. | מערך. | רשות. |
order | ניתן לקבוע: asc/desc אשר יקבע את הסדר של המיון. | מחרוזת. | רשות. |
אלו הם הפרמטרים שבאפשרותכם לשלוח בבקשה שלכם על מנת שנחזיר אליהם מידע בשיחות על פי הסינון שביצעתם
שדה | תיאור | דוגמא |
CallerNumber | מציג את מספר הטלפון של המתקשר. זהו מספר הטלפון אשר מי שמקבל את השיחה ייראה. | "CallerNumber":"0722776772" |
TargetNumber | מציג את מספר הטלפון של יעד השיחה. הפרמטר יהיה מספר טלפון או מזהה שלוחה של וויסנטר. מספרי טלפון יופיעו עם קידומת בינלאומית. | "TargetNumber":"AAPINFzL" / “TargetNumber":"972722776772" |
Date | מציג את הזמן והתאריך שהשיחה בוצעה. | "Date":"2017-07-20 09:59:29" |
DateEpoch | מציג את הזמן והתאריך שהשיחה בוצעה בפורמט Epoch. | "DateEpoch":1554027973 |
Duration | מציג את משך השיחה בשניות. משך השיחה אינו כולל את משך זמן צלצול השיחה אלא רק את השיחה בפועל. | "Duration":33 |
CallID | מציג מזהה שיחה ייחודי עבור כל שיחה. | "CallID":"20200720095ilila137b2f69s" |
Type | מציג את סוג השיחה. לדוגמא: שיחה יוצאת/נכנסת/שיחה של מעגל המתנה. בהמשך תוצג טבלה עם פירוט על כלל סוגי השיחות. | "Type":"Incoming Call" / "Type":"Extension Outgoing" / "Type":"Click2Callleg1" |
CdrType | מציג את סוג השיחה לפי מספר סידורי אשר שייך לסוג שיחה בטבלה מטה. | "CdrType": 4 |
DialStatus | מציג את הסטטוס השיחה, האם נענתה? או לא? במידה ומדובר על שיחות עם 2 רגליים (כגון: קליק2קול, שיחות חייגן) שדה זה יראה מידע רק עבור הרגל הראשונה של השיחה. | "DialStatus":"ANSWER" / "DialStatus":"ABANDONE" / "DialStatus":"TE" |
Targetextension | מציג את המזהה של השלוחה אשר קיבלה שיחה נכנסת. ישנם מקרים בהם הנתון בשדה זה עשוי להיות זהה לשדה "TargetNumber" באותה שיחה. אך ישנם מקרים כאשר שיחה נכנסת אינה מפנה ישירות לשלוחה מסוימת ולכן השדה "TargetNumber" יציג נתון שונה. | "Targetextension":"AAPINFzL" |
Callerextension | מציג את המזהה של השלוחה אשר ביצעה שיחה יוצאת. המידע בשדה זה הוא שונה מהמידע בשדה "CallerField" מאחר ושדה "CallerField" מציג מספר מזהה של השלוחה בשיחה יוצאת. | "Callerextension":"AAPIUtdL" |
DID | מספר הטלפון שהתקשרו אליו בשיחה נכנסת. | "DID":"0722776772" |
QueueName | מציג את שם מעגל ההמתה אשר השיחה עברה בו. | "QueueName":"Service Queue" |
RecordURL | קישור להקלטת השיחה. | "RecordURL":"https://cpanel.voicenter.co.i l/CallsHistory/PlayRecord/123abc.mp3" |
RecordExpect | שדה בוליאני אשר מציג האם השיחה הוקלטה או לא. | "RecordExpect":true |
RingTime | מציג משך זמן צלצול של השיחה. | "RingTime":23 |
Price | מציג באגורות את מחיר השיחה. | "Price":7 |
RepresentativeName | מציג את שם הנציג אשר היה מחובר וביצע/ענה לשיחה זו. הנציג חייב להתחבר למערכת על מנת ששדה זה יוצג. | "RepresentativeName":"Walter Melon" |
RepresentativeCode | מציג את קוד עובד של הנציג אשר היה מחובר וביצע/ענה לשיחה זו. הנציג חייב להתחבר למערכת על מנת ששדה זה יוצג. | "RepresentativeCode":"19996" |
UserName | בדומה לשדה "RepresentativeName" במידה והנציג היה מחובר לשלוחה בעת ביצוע/מענה לשיחה שדה זה יציג את אותו נתון. במידה ונציג לא היה מחובר לשלוחה שדה זה יציג את שם המשתמש אשר מקושר לשיחה/למספר טלפון שקשור לשיחה זה. | "UserName":"Walter Melon" |
DepartmentName | מציג את שם החשבון כפי שהוא רשום בוויסנטר ומקושר לשיחה זו. | "DepartmentName":"Voicenter Account" |
DepartmentId | מציג את מספר החשבון כפי שהוא רשום בוויסנטר ומקושר לשיחה זו. | "DepartmentId":123456 |
TargetPrefixName | מציג את שם מדינת היעד בשיחה יוצאת. | "TargetPrefixName":"Israel" |
DTMFData | שדה מסוג מערך JSON אשר מציג את מסלול שיחה נכנסת בנתב השיחות. השדות שיופיעו הם: שם השכבה - "LayerName" הקשות הלקוח בנתב - "DTMF" מספר שכבה - "LayerNumber" | "DTMFData":"[{LayerName: "Main Menu", DTMF: 2, LayerNumber: "0"}, {LayerName: "Sales", DTMF: 0, LayerNumber: "15"}]" |
CustomData | שדה מסוג מערך JSON, מציג קוסטום דאטה אשר נשלח אלינו, בנוסף במידה ומדובר על שיחה שיש לה מזהה שיחה מקורי, אז גם נתון זה יופיע בשדה זה. | "CustomData": {"OriginalIvrUniqueID":"2020072118102as sdsdas"}" / "CustomData": {"var_clientID":"2118102", {"var_clientAccountID":"123456"}" |
https://api.voicenter.com/hub/cdr/?code=xxxxxxxxxxxxxxxxxxxx&fromdate=2022-06-01T08:09:40&todate=2022-06- 01T23:59:40&phones=972501234567&extensions=SipSip&fields=Date&fields=Type&Fields=DID&Fields=CallerNumber
יש מספר של סוגי שיחות שאתם עשויים להיתקל בהם, להלן הסבר עבור כל אחד מהם.
סוג שיחה | מספר מזהה | תיאור |
Incoming Call | 1 | שיחה נכנסת רגילה אשר התקבלה דרך מספר טלפון אשר ניתב ישירות לשלוחה מסוימת. |
CC | 2 | שיחה שבוצעה בעזרת שירות מספר גישה של חברת וויסנטר. |
Extension Outgoing | 4 | שיחה יוצאת רגילה משלוחה של וויסנטר. * לא שיחת קליק2קול. |
Queue | 8 | שיחה נכנסת שהתקבלה אל מעגל המתנה. |
Click2Call leg1 | 9 | שיחת קליק2קול (לא שיחת חייגן). "רגל 1" של השיחה - השיחה בין השירות לשלוחה שאמורה לחייג ליעד ב"רגל 2" של השיחה. |
Click2Call leg2 | 10 | שיחת קליק2קול (לא שיחת חייגן). "רגל 2" של השיחה - השיחה בין השלוחה ליעד. ברשומה זו תקבלו תיעוד על פרטי השיחה וקישור להקלטות השיחה. |
VoiceMail | 11 | שיחה אשר נענתה על ידי שירות התא קולי של וויסנטר. |
Callference | 12 | שיחה שבוצעה בעזרת שירות חדר וועידה של חברת וויסנטר. |
XferCDR | 13 | שיחה אשר הוערה ידנית משלוחה של מספר/שלוחה אחרת. |
ProductiveCall Leg1 | 14 | שיחת "רגל 1" של חייגן לנציג - השיחה אשר מחברת בין השירות לנציג. |
ProductiveCall Leg2 | 15 | שיחת "רגל 2" של חייגן לנציג - השיחה אשר מחברת בין הנציג ליעד/לקוח/ליד שהזנתם בחייגן. |
Scrubber | 16 | שיחה שבוצעה דרך שירות הסקראבר של חברת וויסנטר. |
Click 2 IVR | 17 | שיחת "רגל 1" של חייגן חכם - השיחה הראשונית בין החייגן ליעד. |
Click 2 IVR Incoming | 18 | שיחת "רגל 2" של חייגן חכם - השיחה שמתרחשת לאחר חיבור מוצלח ומענה של היעד "ברגל ה1". בסוג שיחה זה מתבצע חיוג מהיעד אל נתב השיחות שלכם. סוג שיחה זה מסמן כי השיחה לא עברה למעגל המתנה אלא הועברה ישירות לנציג או השמעת הקלטה. ברשומה זו תקבלו את סטטוס השיחה וקישור להקלטת השיחה. |
Click 2 Queue Incoming | 19 | שיחת "רגל 2" של חייגן חכם - השיחה שמתרחשת לאחר חיבור מוצלח ומענה של היעד "ברגל ה1". בסוג שיחה זה מתבצע חיוג מהיעד אל נתב השיחות שלכם. סוג שיחה זה מסמן כי השיחה עברה למעגל המתנה והיעד המתין עד למענה של נציג. ברשומה זו תקבלו את סטטוס השיחה וקישור להקלטת השיחה. |
FaxCdr | 20 | שיחה אשר בוצעה דרך שירות הפקס הפנימי של וויסנטר. *השירות לא פעיל עדיין. |
Attended CDR leg1 | 21 | שיחה בהעברה עם התייעצות. |
Attended CDR leg2 | 22 | שיחה בהעברה עם התייעצות. רשומה זו תתקיים כאשר מתבצע תסריט שיחה הבא: נציג א' עונה לשיחה נכנסת, הלקוח מבקש לדבר עם נציג ב'. נציג א' מתקשר אל נציג ב'. לאחר מכן נציג א' מעביר את השיחה והלקוח לנציג ב'. סוג שיחה זה נותן מידע על השיחה של הלקוח עם נציג ב'. |
Auto forward | 23 | שיחה שהועברה באופן אוטומטי משלוחה למספר טלפון - בדרך כלל מדובר על הגדרה דרך הטלפון IP. |
שיחה יכולה להסתיים מסיבות שונות כגון, יציאה/נטישה ממעגל המתנה, סיום שיחה לאחר מענה, ניתוק לאחר מענה וכן הלאה.
לפניכם טבלה אשר מרכזת את המידע עבור סטטוסים שונים אפשריים.
שם סטטוס | תיאור |
NOTDIALED | ניתוק לפני ביצוע שיחה. |
ANSWER | מענה של שיחה לאחר חיוג/צלצול מוצלח. השיחה הגיעה ליעדה. מענה מתרחש כאשר וויסנטר מקבל איתות של מענה בשיחהכ מו כן גם הגעת השיחה לתא קולי. |
BUSY | כאשר מנסים לבצע חיוג ליעד מסוים אבל מספר הטלפון שולח בחזרה איתות של "עסוק". |
NOANSWER | אין מענה. השיחה הגיעה ליעד אך צלצלה למשך זמן מסוים עד לאי מענה. |
CANCEL | ביטול שיחה. מצב זה קורה כאשר מחייגים ליעד מסוים אבל מתבצע ניתוק לפני מענה ביעד. |
ABANDONE | שיחות שהגיעו למעגל המתנה והלקוח המתקשר ניתק לפני מענה מנציג. |
TIMEOUT | שיחת מעגל המתנה אשר המתינה זמן מקסימלי במעגל. |
FULL | שיחת אשר ניסתה להצטרף למעגל המתנה אך המעגל היה מלא בממתינים ולא היה ניתן לצרף ממתין נוסף. |
EXIT | שיחת מעגל המתנה אשר לקוח החליט לצאת מהמתנה. |
JOINEMPTY | לקוח מתקשר ניסה להצטרף למעגל המתנה אך לא היו בו נציגים מחוברים. |
VOEND | ניתוק של השיחה במעמד הנתב ללא צלצול בשלוחה כלשהי או מעגל המתנה. במקרה זה לקוח התקשר הגיע לנתב השיחות וניתק. |
TE | מתרחש כאשר השיחה מגיעה לנתב השיחות ומשמיעה הקלטה ולאחר מכן מתנתקת. |
NOTCALLED | סטטוס זה מציין כי הרגל השנייה של השיחה לא בוצעה מאחר והרגל ה1 של השיחה לא הייתה מוצלחה (השיחה לא התחברה לשלוחה). |
VOICEMAIL | שיחה הגיעה לתא הקולי של וויסנטר. |
CONGESTION | סטטוס זה מסמל לרוב חיוג ליעד לא מוכר. |
CHANUNAVAIL | ערוץ לא זמין או שלוחה לא מחוברת ורשומה. |
INVALIDARGS | שגיאה בעיבוד פקודת חיוג ליעד. |
SSWPREAUTH | ביטול שיחה יוצאת לפני ביצוע חיוג. |
שדה | תיאור |
ERROR_NUMBER | מספר שלם. מציג מספר שגיאה. נא עיינו מטה לראות מספרי שגיאות אפשריים. |
ERROR_DESCRIPTION | מחרוזת תיאור מילולי של השגיאה. |
STATUS_CODE | מחרוזת. קוד תגובה לבקשת HTTP. |
TOTAL_HITS | מספר שלם. מציג את מספר השיחות על טווח הזמן שהגדרתם. |
RETURN_HITS | מספר שלם. כמות השיחות שמופיעות בתגובה שקיבלתם. |
CDR_LIST | מערך של אובייקטים. כל אובייקט הוא פירוט של שיחה. |
מספר שגיאה | תיאור שגיאה | קוד שגיאה | תיאור מילולי |
0 | OK | 200 | הבקשה נשלחה בהצלחה. |
1 | Request limit exceeded. Please try again later. | 403 | יש הגבלה על כמות הבקשות שכל ארגון יכול לשלוח בטווח זמן מסוים. מומלץ לשלוח בקשה אחת כל 5 דקות. |
2 | Authorization failed. | 403 | הקוד בבקשה שלכם אינו תקין. |
4 | IP address xx.xx.xx.xx is not trusted. | 403 | הבקשה נשלחה מכתובת IP לא מורשית. |
5 | Out of range | 404 | הייתה בעיה עם חיפוש שיחות לפי התאריכים שהוזנו, טווח הזמנים אינו תקין. |
בעזרת שירות External Layer API תוכלו להרחיב את שירותי נתב השיחות של חברת Voicenter ולהחליט על ניתוב שיחה על פי הלוגיקה העסקית שלכם בעזרת מערכת המידע שלכם/ לפי המידע הקיים במסד הנתונים שלכם.
דוגמאות לשימושים שתוכלו לבצע:
נתב השיחות של Voicenter בנוי משכבות, כל שכבה מבצעת פעולה נוספת (כגון העברת שיחה לנציג/ מעגל המתנה ועוד).
כל שכבה בנתב ממוספרת, עליכם להעביר לחברת וויסנטר URL שלכם אשר ניתן להטמיע בכל שכבה תחת תפריט Layer Settings.
* ניתן לפנות למחלקת התמיכה שלנו על הסבר והדרכה על ניהול נתב השיחות.
ברגע ששיחה מגיעה לשכבה שבה הוגדר ה URL שלכם, חברת Voicenter תיזום אליו בקשת API בפורמט POST-JSON.
1) POST-JSON.
1) POST-JSON
שם שדה | תיאור | סוג |
METHOD | הערך תמיד יהיה: IVR_LAYER_INPUT. | מחרוזת |
DATA | אובייקט אשר מכיל את פרטי השיחה. | מחרוזת |
DID | מספר הטלפון אשר קיבל את השיחה, אשר אליו התקשרו. | מחרוזת |
CALLER_ID | מספר טלפון של הלקוח המתקשר. | מחרוזת |
IVR_UNIQUE_ID | מזהה ייחודי של השיחה. | מחרוזת |
DTMF | הקשות של הלקוח המתקשר בנתב - לדוגמא הקשה של תעודת זהות תשוקף בפרמטר זה. במידה והלקוח המתקשר לא הקיש כלום, ערך ברירת המחדל יהיה 0. | מחרוזת |
LAYER_ID | מספר השכבה אשר ממנה נשלחת בקשת API על הURL שלכם. רצוי לשים לב לפרמטר זה ומאחר ובמידה יש שכבות שונות שמהן תתבצע פנייה אליכם מספר השכבה יכול לעזור לכם במעקב וביצוע לוגיקה שונה פר פנייה. | מספר שלם |
PREVIOUS_LAYER_ID | מספר שכבה קודם שבה השיחה עברה לפני ביצוע בקשת API לURL שלכם. | מספר שלם |
שם שדה | תיאור | סוג | הערות |
STATUS | יש לשלוח את הערך 0 -במידה וקיבלתם את הבקשה בצורה תקינה יש לשלוח את הערך 1 במידה ונתקלתם בבעיה כלשהי. | מספר שלם. | חובה |
ACTION | שדה זה מסמל את הפעולה שהשירות של חברת Voicenter יצטרך לבצע, יש 3 אפשרויות אפשרות 1:GO_TO_LAYER - אתם מבקשים להפנות את השיחה למספר שכבה מסוימת. אפשרות 2:SAY - אתם מבקשים להשמיע הקלטה מסוימת. אפשרות 3: DIAL - אתם מבקשים לבצע חיוג לשלוחה/מספר טלפון חיצוני. | מספר שלם. | חובה |
LAYER | מספר השכבה שאליה יש להעביר את השיחה. | מספר שלם. | חובה |
CALLER_ NAME | תוכלו לקבוע את שם המתקשר אשר יוצג בשלוחה של הנציג שבה השיחה מחייגת. | מחרוזת | רשות |
CUSTOM_ DATA | מידע ייחודי שלכם שתוכלו לשלוח בבקשה שלכם, לאחר מכן חברת Voicenter תעביר אליכם את המידע הנ"ל בפירוט השיחות למערכת המידע שלכם. | מחרוזת. | רשות |
לפניכם דוגמא לכיצד ניתן להשתמש בשירות וכיצד השירות יכול להתבטא ברמת השירות עבורכם.
להן בקשת API שנשלחה מחברת Voicenter, לאחר שלקוח חייג לנתב השיחות שלכם והשיחה הגיעה לשכבה מספר 5 - ניתן לראות זאת לפי השדה LAYER_ID.
כמו כן, ניתן לראות בשדה CALLER_ID כי מספר הטלפון של הלקוח הוא 0501234567.
בנוסף, ניתן לראות בשדה DTMF כי הלקוח הקיש בנתב בשכבה 5 את הספרות: 12345678.
לאחר שקיבלתם את בקשת הAPI מחברת Voicenter, ועיבדתם את המידע שהתקבל גיליתם שמדובר על לקוח VIP (גיליתם זאת לפי מספר הטלפון או לפי ההקשה בנתב) ולכן החלטתם שיש צורך להעביר את השיחה לשכבה מספר 12.
כאשר השיחה תגיע לשכבה מספר 12, השיחה תיכנס למעגל המתנה עם משקל גבוה מהאחרים והלקוח VIP יקבל מענה מהיר.
זאת לוגיקה עסקית לדוגמא שניתן להטמיע בעזרת API זה.
ולכן התגובה שלכם לשירות תראה כך:
ניתן לראות כי לפי הערך GO_TO_LAYER בשדה ACTION בחרתם לנתב את השיחה לשכבה מסוימת.
לפי הערך 12 בשדה LAYER השיחה תנותב לשכבה מספר 12.
עשויים להיות מקרים שבהם תרצו להשמיע דרך הנתב הקלטה כלשהי, הקלטה לא קבועה אלא בעלת תוכן משתנה בהתאם ללקוח המתקשר.
לדוגמא, תוכלו להשמיע ללקוח את מספר הטלפון/תעודת זהות שהוקשה ובכך לאשר את תקינותם, ניתן יהיה להשמיע הקלטה של תאריך ושעה של הגעת טנכאי לאתר הלקוח ועוד.
להלן הפרמטרים אשר תצרטכו לבצע בהם שימוש בתגובה שלכם לשירות על מנת לבצע פעולה של השמעת הקלטה דינאמית:
שם שדה | תיאור | סוג | הערות |
STATUS | יש לשלוח את הערך 0 -במידה וקיבלתם את הבקשה בצורה תקינה יש לשלוח את הערך 1 במידה ונתקלתם בבעיה כלשהי. | מספר שלם. | חובה |
ACTION | SAY_DIGITS | מחרוזת. | חובה |
NEXT_LAYER | מספר השכבה שאליה השיחה תנותב לאחר סיום השמעת ההקלטות. | מספר שלם | חובה |
LANGUAGE | השפה שבה שהלקוח ישמע את ההקלטות שהגדרתם להשמיע, ניתן להגדיר את השפות הבאות: עברית, אנגלית, ערבית ורוסית.בצורה כזו: HE, EN, AR וRU. | מחרוזת. | רשות |
DATA | מערך אשר מכיל את המידע שברצונכם להשמיע. סוגי המידע שניתן להשמיע: ספרות - Digits, משתנה מסוג מספר שלם, הנתב יקריא ספרה ספרה, לדוגמא מספר טלפון. מספר - Number, משתנה מסוג מספר שלם, הנתב יקריא מספר לדוגמא יתרת כרטיס נטען. תאריך - Date, משתנה מסוג מחרוזת, הנתב יקריא את התאריך בפורמן ISO 8601, לדוגמא: 2022-06-12. תאריך וזמן - DateTime, משתנה מסוג מחרוזת אשר יקריא תאריך וזמן בפורמט ISO 8601, לדוגמא: 2022-06-12T10:12:59 עבור השמעה של נתון זה. הקלטה - Recording, משתנה מסוג מחרוזת עם מזהה ההקלטה. | מחרוזת. | חובה |
מה בעצם יתרחש בעקבות תשובה זו?
סדר פעולות יתרחשו כך:
לאחר מכן, השיחה תנותב לשכבה מספר 2.
יהיו מקרים שבהם ישנה אפשרות שתרצו לבצע חיוג ליעד חיצוני - לדוגמא מספר טלפון נייד של טכנאי/כונן חירום בלילה.
מאחר ומספרי הטלפון עלולים להשתנות בכל פעם ואינכם רוצים כל יום להגדיר בנתב את השכבה הרלוונטית כדי להפנות שיחות לאותו כונן, תוכלו לבצע שימוש במתודה Dial.
שם שדה | תיאור | סוג משתנה | הערות |
STATUS | יש לשלוח את הערך 0 -במידה וקיבלתם את הבקשה בצורה תקינה יש לשלוח את הערך 1 במידה ונתקלתם בבעיה כלשהי. | מספר שלם. | חובה |
ACTION | DIAL | מחרוזת. | חובה |
CALLER_ID | מספר טלפון אשר ישמש כמזהה השיחה, מספר הטלפון אשר היעד יראה כאשר יקבל את השיחה. לדוגמא: “0722776772”. | מחרוזת. | חובה |
CALLER_NAME | במידה והיעד הוא שלוחה של וויסנטר, ניתן להגדיר שם מזהה אשר היעד יראה בעת קבלת השיחה. | מחרוזת. | רשות |
MAX_CALL_ DURATION | משך שיחה מקסימלי אשר תגדירו (משך זמן השיחה לא כולל את משך זמן חיוג ליעד). | מספר שלם. | חובה |
MAX_DIAL_ DURATION | משך חיוג מקסימלי אשר תגדירו. | מספר שלם. | מחרוזת |
NEXT_VO_ID | מספר השכבה אליה השיחה תנותב במידה והיעד אינו זמין עקב תקלה טכנית ביעד. | מספר שלם. | חובה |
RECORDING | האם להקליט את השיחה? ניתן להשתמש בערכים "yes" או "no", ברירת המחדל היא לא להקליט את השיחה. | מחרוזת. | חובה |
TARGETS | מערך אשר יכלול את היעד לשיחה: סוג היעד - TYPE, ניתן להגדיר "PHONE" או "EXTENSION" (עבור שלוחה של וויסנטר). היעד - TARGET - ניתן להגדיר מספר טלפון או מזהה של שלוחה של וויסנטר (סיפ). מספרי טלפון בינלאומיים יש להגדיר עם קידומת בינלאומית. | מחרוזת. | חובה |
CUSTOM_ DATA | מידע פנימי של מערכת המידע שלכם אשר תוכלו לצרף לתשובה שלכם לשירות, המידע יעבור בהקפצת מסך ובשירות של העברת פירוטי שיחות לאחר סיום השיחה. | מחרוזת. | רשות |
השירות Blacklist API של חברת Voicenter יאפשר לחסום לנהל חסימה של יעדים לחיוג על ידי הנציגים שלכם, תוכלו להגדיר בעזרת מערכת המידע שלכם שלא יהיה ניתן לחייג למספרי טלפון מסוימים.
בנוסף, תוכלו להסיר גם מספרי טלפון על מנת לאפשר חיוג אליהם על ידי הנציגים שלכם והכל נעשה בעזרת בקשת Web פשוטה.
https://api.voicenter.com/Blacklist/AddBlackList
1. POST-JSON
2. GET
1. POST-JSON
שם שדה | תיאור | סוג | הערות |
Code | קוד ייחודי לחשבונכם, ניתן לפנות למחלקת התפעול לקבל את הקוד. | מחרוזת | חובה |
Phones | מערך של JSON, אשר יכיל את מספרי הטלפון אשר ברצונכם להוסיף לשירות ה Blacklist על מנת למנוע אליהם חיוג. | מערך | חובה |
Phone | מספר טלפון לחסימה לחיוג, נמצא בתוך המערך תחת Phones | מחרוזת | חובה |
Name | שם של היעד שנחסם לחיוג. נתמך רק בבקשות בפורמט POST-JSON | מחרוזת | רשות |
https://api.voicenter.com/Blacklist/AddBlackList?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
שם שדה | תיאור | סוג |
ErrorCode | מציין סטטוס כללי לבקשה שלכם: סטטוס "0" - אין שגיאה. סטטוס "1" - הפרמטר קוד אינו תקין או הפורמט של הבקשה אינו תקין. סטטוס "2" - השדה Phone חסר או מכיל מידע לא תקין. | מספר שלם. |
ErrorMessage | תיאור מילולי כללי של התגובה: תיאור "OK" - אין שגיאות והכל תקין. תיאור "Authorization failed" - ערך הקוד או פורמט הבקשה אינו תקין. תיאור "The Phone field is missing or invalid" - השדה "Phones" חסר. | מחרוזת |
Phones | מערך של JSON, עבור כל מספר טלפון שהתווסף ל Blacklist API יתקבל חיווי האם המספר נוסף בהצלחה. | מערך |
ErrorCode | סטטוס בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: סטטוס "0" - אין שגיאות. סטטוס "1" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין. מספרי טלפון יש לרשום בפורמט E.164 בבקשה שלכם. סטטוס "2" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה. | מספר שלם |
ErrorMessage | תיאור בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: תיאור "OK" - אין שגיאות. תיאור "Please make sure the phone destination is in a valid format" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין של E.164, יש לרשום את מספרי הטלפון בפורמט זה. תיאור "Internal Error" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה. | מחרוזת |
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist
1. POST-JSON
2. GET
1. POST-JSON
שם שדה | תיאור | סוג | הערות |
Code | מזהה ייחודי לחשבונכם, ניתן לקבל ממחלקת התפעול. | מחרוזת | חובה |
Phones | מערך של JSON אשר מציין את מספרי הטלפון שיש להסיר משירות Blacklist API | מערך | חובה |
Phone | מספרי הטלפון אשר יוסרו משירות Blacklist. | מחרוזת | חובה |
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
שם שדה | תיאור | סוג |
ErrorCode | מציין סטטוס כללי לבקשה שלכם: סטטוס "0" - אין שגיאה. סטטוס "1" - הפרמטר קוד אינו תקין או הפורמט של הבקשה אינו תקין. סטטוס "2" - השדה Phone חסר או מכיל מידע לא תקין. | מספר שלם |
ErrorMessage | תיאור מילולי כללי של התגובה: תיאור "OK" - אין שגיאות והכל תקין. תיאור "Authorization failed" - ערך הקוד או פורמט הבקשה אינו תקין. תיאור "The Phone field is missing or invalid" - השדה "Phones" חסר. | מחרוזת |
Phones | מערך של JSON, עבור כל מספר טלפון שהתווסף ל Blacklist API יתקבל חיווי האם המספר הוסר מהרשימה בהצלחה. | מערך |
ErrorCode | סטטוס בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: סטטוס "0" - אין שגיאות. סטטוס "1" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין. מספרי טלפון יש לרשום בפורמט E.164 בבקשה שלכם. סטטוס "2" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה. | מספר שלם |
ErrorMessage | תיאור בתשובה של Blacklist API עבור כל מספר טלפון שהוסר מהשירות: תיאור "OK" - אין שגיאות. תיאור "Please make sure the phone destination is in a valid format" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין של E.164, יש לרשום את מספרי הטלפון בפורמט זה. תיאור "Internal Error" - הייתה שגיאה פנימית בעת ניסיון להסיר את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה של חברת Voicenter. | מחרוזת |
לעיתים ישנם מקרים שבו אתם עשויים להעדיף שחלקי שיחה מסוימים לא יוקלטו, לדוגמא כאשר לקוח קצה שלכם מוסר פרטי אשראי ואתם מעדיפים שהקלטת השיחה לא תכלול את פרטי האשראי שנמסרו.
באפשרותכם להשתיק הקלטת שיחה לפי מזהה שלוחה, אשר תאפשר לכם להשתיק הקלטה עבור כלל השיחות הפעילות של השלוחה באותו רגע.
אנא שימו לב כי במידה ושלחת בקשת API להשתקת הקלטת שיחה והנציג ענה/ביצע שיחה חדשה נוספת אז השיחה החדשה תוקלט במלואה.
כדי שהשיחה החדשה לא תוקלט במלואה יש לבצע בקשת API נוספת.
במידה נציג משוחח עם לקוח ועומד להיכנס לטופס פרטי אשראי במערכת מידע הארגונית שלכם, ברגע שנכנסים לטופס ניתן לשלוח בקשת API כדי להשתיק את הקלטת השיחה.
לאחר שהנציג קיבל פרטי אשראי וסיים למלא את הטופס לאחר היצאה ממנו תוכלו לשלוח בקשת API כדי להספיק את השתקת הקלטת השיחה.
https://monapisec.voicenter.co.il/Comet/API/MuteUnmuteCalls
שם שדה | תיאור | סוג |
extension | מזהה שלוחה שעבורה תרצו לבצע את הפעולה. | מחרוזת |
state | 0 - להשתיק הקלטה, 1 - לבטל השתקת הקלטה. | מחרוזת |
1. POST - JSON
2. GET
https://monapisec.voicenter.co.il/Comet/API/MuteUnmuteCalls?extension=XXXXXXXX&state=1
שם שדה | תיאור | סוג |
ErrorCode | קוד הפעולה, במידה והבקשה הייתה תקינה קוד הפעולה יהיה 200. | מחרוזת |
Message | הודעה אשר תתריע על פעולה מוצלחת או לא. במידה והבקשה שנשלחה היא תקינה תוצג הודעה Success. | מחרוזת |
ActionID | מזהה סידורי של הפעולה שביקשתם לבצע. | מחרוזת |
יש באפשרותכם להשתיק הקלטת שיחה לפי מזהה של שיחה ספציפית ולא רק לפי שלוחה.
על מנת לבצע זאת עליכם לשלוח בקשת API עם מזהה שיחה ייחודי בפרמטר ivrid.
את מזהה השיחה ניתן לקבל דרך שימוש אחד משני הAPIים הבאים:
https://monapisec.voicenter.co.il/Comet/API/MuteUnmuteCalls
https://monapisec.voicenter.co.il/Comet/API/MuteUnmuteCalls
שם שדה | תיאור | סוג |
ErrorCode | קוד הפעולה, במידה והבקשה הייתה תקינה קוד הפעולה יהיה 200. | מחרוזת |
Message | הודעה אשר תתריע על פעולה מוצלחת או לא. במידה והבקשה שנשלחה היא תקינה תוצג הודעה Success. | מחרוזת |
ActionID | מזהה סידורי של הפעולה שביקשתם לבצע. | מחרוזת |
דוגמא לתשובה לא תקינה
https://monitor.voicenter.co.il/Comet/api/GetExtensions
1. POST
2. GET
JSON
שם שדה | תיאור | סוג | הערות |
code | מזהה אישי, מסופק על ידי מחלקת התפעול של Voicenter. | מחרוזת | חובה |
showAll | מאפשר לכם לקבוע כי לפי איזו היררכיה בחשבון הAPI יחזיר לכם מידע השלוחות. תוכלו לקבוע האם לקבל מידע עבור כלל השלוחות של כלל הארגון או של תת חשבון ספציפי. כדי לקבל מידע עבור תת חשבון ספציפי יש להעביר את הקוד של אותו תת חשבון ולהגדיר "False" או "0". כדי לקבל מידע עבור כלל הארגון יש להגדיר "True" או "1" . | בוליאני | רשות |
https://monitor.voicenter.co.il/Comet/api/GetExtensions?code=XXXXXXXXXXXXXXX&showAll=0
שם שדה | תיאור | סוג |
ERR | סטטוס התשובה: סטטוס "0" מסמן שאין שגיאות. סטטוס "1" מסמן שנשלח קוד בפורמט לא תקין. במידה ונשלח קוד שאינו מתאים לשום חשבון התשובה תהיה מערך ריק. | מספר שלם |
DESC | תיאור סטטוס התגובה: במידה והבקשה הייתה תקינה יוחזר הערך "OK" בפרמטר זה. במידה והקוד שנשלח בבקשה אינו תקין או בפורמט אינו תקין תוצג ההודעה "Unauthorized". | מחרוזת |
EXTENSIONS | רשימה של כלל השלוחות המבוקשות. | מערך |
SIP | מזהה ייחודי של השלוחה בפרוטוקול טלפוניה SIP. | מחרוזת |
Name | שם של השלוחה כפי שהיא מופיעה בממשק הניהול (Cpanel). | מחרוזת |
SpeedDial | חיוג מהיר של השלוחה אשר מאפשר לשלוחה לקבל שיחות פנים ארגוניות. | מחרוזת |
AccountID | מזהה החשבון שהשלוחה מוגדרת בו. | מספר שלם |
AccountName | שם החשבון שהשלוחה מוגדרת בו. | מחרוזת |
UserName | שם המשתמש שבו מוגדרת השלוחה. | מחרוזת |
UserEmail | כתובת הדואר האלטקרוני שמוגדרת בממשק הניהול (Cpanel) למשתמש של השלוחה. | מחרוזת |
כאשר הנכם מקימים חייגן אוטומטי תוכלו לפתוח מספר קמפיינים כאשר כל קמפיין משרת מטרה מסוימת (חיוג ללידים חמים/קרים/לידים שהשאירו פרטים מדף נחיתה ועוד).
הקמפיין יכול להיות מסוג מסוים:
במידה וקיים בחשבונכם חייגן אוטומטי תוכלו לבצע שימוש בכלי הAPI שלנו למגוון מטרות ומימוש הלוגיקה העסקית הארגונית שלכם בצורה אוטומטית מתוך מערכת המידע הארגונית שלכם.
חייגן אוטומטי יכול להתחלק למספר קמפיינים - כאשר לכל קמפיין יש יעדי חיוג ייעודים, ולכל קמפיין תוכלו לבצע פעולות שונות:
כל מה שתצטרכו לבצע הוא בקשת HTTP פשוטה למתודות המפורטות מטה:
מומלץ שזו תיהיה המתודה הראשונה שבה תבצעו שימוש מאחר והיא תחזיר לכם את הקמפיינים הפעילים בחשבונכם.
לאחר שתדעו איזה קמפיין פעיל תוכלו לתת את האופציה להוסיף מספרי טלפון לקמפיין פעיל.
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList
למתודה זו יש לשלוח רק קוד אימות לחשבונכם, את הקוד ניתן לקבל ממחלקת התפעול שלנו.
שם שדה | תיאור | סוג שדה | הערות |
Code | מזהה חשבון ייחודי - ניתן לקבל ממחלקת התפעול של וויסנטר | מחרוזת | חובה |
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList?Code=XXXXXXXXXXXXX
שם שדה | תיאור | סוג |
ErrorCode | ססטוס התגובה. במידה ומתקבל "0" סימן שאין שגיאות. | מספר שלם |
Description | תיאור סטטוס התגובה. במידה ומתקבל "OK" סימן שאין שגיאה ותיאור שלה. | מחרוזת |
Data | משתמנה מסוג מערך JSON אשר יכיל את הקמפיינים בחשבונכם. | מערך |
Name | שם הקמפיין | מחרוזת |
StatusName | מציג את סטטוס הקמפיין, יש שתי אפשרויות: אפשרות ראשונה: "Enabled" - קמפיין פעיל. אפשרות שנייה: "Disabled" - קמפיין לא פעיל/ | מחרוזת |
TotalPendingCalls | סכום היעדים אשר ממתינים לחיוג. | מספר שלם |
MaxPriority | משתנה אשר מחזיר את עדיפות המקסימלית אשר הוגדרה לכל יעד. | מספר שלם |
MinPriority | משתנה אשר מחזיר את עדיפות המינימלית אשר הוגדרה לכל יעד. | מספר שלם |
TotalAwaitingCalls | שדה זה רלוונטי רק עבור קמפיין מסוג חייגן חכם. שדה זה מציג את סכום היעדים לחיוג קמפיין. שדה זה יותר מומלץ לשימוש מאשר שדה "TotalPendingCalls" עבור קמפיין מסוג חייגן חכם. במידה ומדובר על קמפיין מסוג חייגן לנציג שדה זה יציג "null". | מספר שלם |
Code | מזהה ייחודי של כל קמפיין, יש צורך בו עבור שימוש בשאר המתודות כמפורט בהמשך. | מחרוזת |
במידה ויש לכם צורך להוסיף מספר טלפון בודד לקמפיין פעיל, תוכלו לבצע שימוש במתודה זו.
במידה ויש לכם צורך להוסיף מספר יעדים לחיוג יש לבצע שימוש במתודה הבאה: AddCallsBulk.
https://api.voicenter.com/ForwardDialer/Dialer/AddCall
שם שדה | תיאור | סוג משתנה | הערות |
Campaign | מזהה ייחודי של הקמפיין, ניתן להשגה על ידי שימוש במתודה GetCampaignList כמתואר מעלה. | מחרוזת | חובה |
Target | מספר טלפון של היעד אליו תרצו לחייג. עליכם להוסיף קידומת בינלאומית למספר טלפון - לא חובה עבור מספרים ישראלים. | מחרוזת | חובה |
CustomerName | שם הלקוח של היעד אליו מחייגים. | מחרוזת | רשות |
CallerID | מספר טלפון אשר יוצג כמזהה לנציג אשר מקבל את השיחה ליעד זה. | מחרוזת | רשות |
Priority | עדיפות חיוג על היעד שהוספתם, העדיפות ניתנת לערך שיותר גבוה. | מספר שלם | רשות |
CustomData | יש באפשרותכם להעביר מידע ייחודי שלכם ליעד שהוספתם בעזרת Custom Data יחד עם ערכים שתרצו לוודא שיישלחו אליכם לאחר סיום השיחה. מידע זה גם יופיע בהקפצת מסך. | מערך | רשות |
OriginateTime | במידה ותרצו לקבוע חיוג בתאריך עתידי בזמן Epoch, תוכלו לבצע שימוש במשתנה זה. במידה ולא נקבע ערך במשתנה זה, החיוג אל היעד יתבצע במועד הכי מוקדם שמתאפשר. במידה וכן החלטתם לבצע שימוש במשתנה זה עליכם גם לכלול את המשתנה IsDateLocal בבקשה שלכם. | מספר שלם | רשות |
IsDateLocal | משתנה זה קובע האם שיחות עתידיות יתבצעו בזמן מקומי לפי ההגדרה של חשבונכם בממשק הניהול. במידה ואתם קובעים ערך "false" לשדה זה החיוג ליעד שהוספתם יתבצע לפי אזור זמן GMT - 0 בינלאומי. ההמלצה שלנו היא להשתמש בערך "true". | בוליאני | רשות |
https://api.voicenter.com/ForwardDialer/Dialer/AddCallCampaign=XXXXXXXXXXXXXXXXXXXXX&Target=0501234567&CustomerName=John Doe&Priority=42&var_leadID=1234567
שם שדה | תיאור | סוג |
ErrorCode | סטטוס התגובה: סטטוס "0" יעיד על חוסר שגיאות ותקינות הבקשה. ססטוס "1" יעיד על בקשה שלכם עם קמפיין קוד לא תקין. סטטוס "2" יעיד על העדרות של ערך בשדה Target בבקשה שלכם. סטטוס "2-" יעיד על מספר טלפון לא תקין בשדה Target. | מספר שלם |
Description | תיאור מילולי של השגיאה: תיאור סטטוס "OK" יעיד על חוסר שגיאה. תיאור "Invalid campaign code" יעיד על קמפיין קוד לא תקין. תיאור סטטוס "Campaign code missing" יעיד על חוסר של קוד קמפיין. תיאור סטטוס "Target missing" יעיד על העדרות של השדה הנ"ל. תיאור סטטוס "Number is invalid" יעיד על מספר טלפון לא תקין בשדה Target. | מחרוזת |
מתודה זו תיתן לכם מענה על הצורך של הוספת יעדים לחייגן (כאשר רוצים להוסיף יותר מיעד אחד).
במידה ואתם רוצים להוסיף יעד בודד - יש לבצע שימוש במתודה AddCall - המפורטת מעלה.
https://api.voicenter.com/ForwardDialer/Dialer/AddCallsBulk