הסבר כללי
איך השירות עובד?
במידה וברצונכם לקבל תמונה בזק עדכנית של השיחות הפעילות הטלפונית הארגונית שלכם או פעילות טלפונית של נציג מסוים תוכלו לבצע שימוש במתודה: GetExtensionsCalls.
לחילופין השירות יוכל לשמש גם עבור הקפצת מסך במתכונת כזו שלאחר מענה לשיחה, הנציג יילחץ על כפתור ייעודי במערכת המידע שלכם.
כפתור זה יישלח בקשת API לשירות Active Calls.
תוכלו לממש זאת על ידי שליחת בקשת HTTP פשוטה לפי הדוגמא הבאה.
GetExtensionsCalls
מתודה זו מחזירה נתנונים על פעילות טלפונית של שלוחה ספציפית או כלל השלוחות בארגונכם.
קישור שיש לפנות אליו
1
https://monapisec.voicenter.co.il/comet/API/GetExtensionsCalls
פורמט בקשה
1. POST-JSON.
2. GET.
פורמט תגובה
1.POST-JSON.
פרמטרים בבקשה שלכם
| שם שדה | תיאור | סוג שדה | הערות |
| code | מזהה ארגוני אישי, ניתן על ידי וויסנטר. | מחרוזת | חובה |
| extension | במידה וברצונכם לקבל מידע על פעילות טלפונית של שלוחה ספציפית, תוכלו להשתמש בשדה זה. בשדה זה תוכלו להשתמש בערך של מזהה sip שלוחה אשר ניתן על ידי וויסנטר. במידה ופרמטר זה אינו מופיע בבקשה שלכם יינתן מידע עבור כלל הארגון. |
בקשה לדוגמא בפורמט GET
1
https://monapisec.voicenter.co.il/comet/API/GetExtensionsCalls?code=XXXXXXXXXXXXX&extension=SIPSIP
בקשה לדוגמא בפורמט POST-JSON
{
"code": "XXXXXXXXXXXXX",
"extension": "SIPSIP"
}
פרמטרים בתשובה
| שם שדה | תיאור שדה | סוג שדה |
| ERR | סטטוס התגובה: במידה והבקשה תקינה יוחזר סטטוס "0". במידה ופורמט הבקשה הוא לא תקין יוחזר ססטוס "1". במידה והערך של הפרמטרים בבקשה אינם תקינים יוחזר סטטוס "2". | מספר שלם |
| DESC | תיאור סטטוס התגובה: בתשובה יופיע תיאור "OK" במידה והבקשה תקינה . בתשובה יופיע תיאור "Authorization failed" במידה ופורמט הבקשה הוא לא תקין. בתשובה יופיע תיאור "Internal error" במידה והערך של הפרמטרים בבקשה אינם תקינים. | מחרוזת |
| EXTENSIONS | מציג את השלוחות הרלוונטיות לבקשה שלכם בתוך מערך JSON. | מערך |
| name | שם משתמש של השלוחה. | מחרוזת |
| userID | מזהה משתמש ייחודי של המשתמש המיוחס לשיחה. | מספר שלם |
| representative | שם של הנציג אשר מחובר לשלוחה. | מחרוזת |
| onlineUserID | מזהה משתמש ייחודי אשר מחובר לשלוחה - רלוונטי עבור עבודה עם כיסאות חמים. | מספר שלם |
| username | מזהה טלפוני ייחודי של השלוחה, נקרא גם מזהה sip. | מחרוזת |
| onlineUserStatus | סטטוס המשתמש אשר מחובר כרגע לשלוחה על פי ההגדרה בממשק הניהול: "1" - לוגין "2" - לוגאאוט "3" - הפסקת צהריים "5" - זמן אדמיניסטרטיבי "7" - הספקה קצרה "9" - אחר "11" - הדרכה "12" - פגישה קבוצתית "13" - תדריך | מספר שלם |
| calls | מציג את המידע עבור השיחות הפעילות באותו רגע בתוך מערך JSON. | מספר שלם |
| callStarted | זמן תחילת השיחה בפורמט Epoch. | מספר שלם |
| callAnswered | זמן מענה של השיחה בפורמט Epoch, במידה והשיחה לא נענתה יופיע 0 בערך הזה. | מספר שלם |
| callername | מזהה מתקשר אשר מוצג ליעד (רק עבור שלוחות וויסנטר). | מחרוזת |
| callerphone | מספר מזהה של המתקשר. | מחרוזת |
| callstatus | סטטוס השיחה: 1 - "Ringing" - שיחה נכנסת כאשר היא מצלצלת אצל שלוחה/ות. 2 - "Dialing" - שיחה יוצאת בשלב של חיוג ליעד. 3 - "Talking" - שיחה נכנסת או יוצאת פעילה. 4 - "Hold" - שיחה נכנסת או יוצאת במצב ממתינה. | מחרוזת |
| customdata | מציג קוסטום דאטה של השיחה שהתקבל אלינו ממכם עבור אותה שיחה, מוצג בתוך מערך JSON בתשובה. כמו כן, במידה ולשיחה יש שיחת מקור אחרת המזהה שיחה המקורי יוצג במערך זה תחת שדה: "OriginalIvrUniqueID". | מערך |
| direction | כיוון השיחה. עבור שיחות נכנסות יוצג Incoming ועבור שיחות יוצאות יוצג Outgoing. | מחרוזת |
| ivrid | מזהה ייחודי של השיחה. | מחרוזת |
| recording | מערך של JSON אשר מציג את פרטי הקלטת השיחה. | מערך |
| Filename | שם קובץ של ההקלטה. | מחרוזת |
| IsMuted | מציג האם השיחה הנוכחית מוקלטת במידה והשיחה אכן מוקלטת בשדה זה יוצג הערך 0, אחרת יוצג הערך 1. | מספר שלם |
| did | במידה והשיחה היא שיחה נכנסת, פרמטר זה יציג את מספר הטלפון אליו התקשרו. | מחרוזת |
תגובה לדוגמא
{
"ERR": 0,
"DESC": "OK",
"EXTENSIONS":
[
{
"name": "User 1",
"representative": "User 1",
"username": "SIPSIP1",
"extensionID": 875756567,
"userID": 6946792,
"onlineUserID": 0,
"onlineUserStatus": 2,
"calls":
[
]
}
{
"name": "User 2",
"representative": "User 2",
"username": "SIPSIP2",
"extensionID": 97483478,
"userID": 46454322,
"onlineUserID": 46454322,
"onlineUserStatus": 1,
"calls":
[
{
"callStarted": 1602465818,
"callAnswered": 1602465819,
"answered": 1,
"callername": "Voicenter",
"callerphone": "0722776772",
"callstatus": "Talking",
"customdata":
{
}
"direction": "Outgoing",
"ivrid": "2020101201cc7b38df",
"recording":
{
"Filename": "2020101201cc7b38df-aws-SIPSIP2-972722776772.mp3",
"IsMuted": 0
}
"did": ""
}
]
}
]
}
GetQueuesCallers
מתודה זו מחזירה מידע על השיחות הפעילות כרגע במעגל המתנה מסוים או כללי מעגלי ההמתנה בארגונכם.
קישור שיש לפנות אליו
1
https://monapisec.voicenter.co.il/comet/API/GetQueuesCallers
פורמט הבקשה
1. POST-JSON.
2. GET
פורמט התגובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| code | מזהה ארגוני ייחוד, ניתן על ידי וויסנטר. | מחרוזת | חובה |
| queue | במידה וברצונכם לקבל מידע עבור שיחות פעילות במעגל המתנה מסוים יש להוסיף את מזהה מעגל ההמתנה לפרמטר queue בבקשה שלכם. במידה והבקשה אינה כוללת את השדה queue התשובה תציג את השיחות הפעילות בכלל מעגלי ההמתנה בארגונכם. | מחרוזת | רשות |
GET בקשה לדוגמא בפורמט
1
https://monapisec.voicenter.co.il/comet/API/GetQueuesCallers?code=XXXXXXXXXXXXX&queue=XXXXXXXXX
POST-JSON בקשה לדוגמא בפורמט
{
"code": "XXXXXXXXXXXXX",
"queue": "XXXXXXXXX"
}
פרמטרים בתשובה
| שם שדה | תיאור | סוג שדה |
| ERR | סטטוס התגובה: במידה והבקשה תקינה יוחזר סטטוס "0". במידה ופורמט הבקשה הוא לא תקין יוחזר ססטוס "1". במידה והערך של הפרמטרים בבקשה אינם תקינים יוחזר סטטוס "2". | מספר שלם |
| DESC | תיאור סטטוס התגובה: בתשובה יופיע תיאור "OK" במידה והבקשה תקינה . בתשובה יופיע תיאור "Authorization failed" במידה ופורמט הבקשה הוא לא תקין. בתשובה יופיע תיאור "Internal error" במידה והערך של הפרמטרים בבקשה אינם תקינים. | מחרוזת |
| QUEUES | מערך של JSON אשר מציג את מעגלי ההמתנה הקיימים. | מערך |
| Name | שם מעגל ההמתנה | מחרוזת |
| ID | מזהה ייחודי של מעגל ההמתנה. | מספר שלם |
| Weight | המשקל המוגדר למעגל ההמתנה. | מספר שלם |
| Callers | מערך JSON אשר מציג מידע על השיחות הפעילות באותו רגע. | מערך |
| Phone | מספר טלפון של הלקוח | מחרוזת |
| JoinTime | זמן השיחה בפורמט Epoch שבה השיחה הצטרפה למעגל המתנה. | מספר מלא |
| CallID | מזהה שיחה ייחודי | מחרוזת |
| Duration | משך זמן ההמתנה בשניות של השיחה במעגל המתנה | מספר מלא |
תגובה לדוגמא
{
"ERR": 0,
"DESC": "OK",
"QUEUES":
[
{
"Name": "QUEUE 1",
"ID": 12345678,
"Weight": 5,
"Callers":
[
{
"Phone": "0722776772",
"CallID": "202010131430590714966",
"JoinTime": 1602599565,
"Duration": 21
}
{
"Phone": "0501234567",
"CallID": "202010131433000d14cc4b",
"JoinTime": 1602599583,
"Duration": 3
}
]
}
{
"Name": "QUEUE 2",
"ID": 87654321,
"Weight": 0,
"Callers":
[
]
}
]
}