הסבר כללי
איך השירות עובד?
במערכת המידע שלכם תוכלו לאפשר לנציגים שלכם לשנות סטטוס בלחיצת כפתור.
בעת שימוש בכפתור במערכת המידע הארגונית שלכם תישלח בקשת HTTP אל הAPI כדי לשנות סטטוס לסטטוס הרצוי עבור המשתמש שביקש לבצע זאת.
לדוגמא שינוי סטטוס להפסקת צהריים על מנת להפסיק קבלת שיחות נכנסות למשך ההפסקה.
קישור שיש לפנות אליו
1
https://api.voicenter.com/UserLogin/SetStatusFromAPI
פורמט בקשה
1. POST-JSON
2. GET
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור שדה | סוג שדה | הערות |
| Code | מזהה ארגוני אישי, ניתן על ידי וויסנטר. | מחרוזת | חובה |
| UserId | מזהה משתמש בוויסנטר של הנציג. | מחרוזת | חובה |
| ExtensionUser | מזהה שלוחה (SIP) של הנציג בוויסנטר. | מחרוזת | חובה |
| Status | מזהה מספרי של הסטטוסים האפשרים לפי הגדרת החשבון שלכם: סטטוס לוגין - 1 סטטוס לוג אאוט - 2 סטטוס הפסקת צהריים - 3 סטטוס זמן אדמיניסטרטיבי - 5 סטטוס הפסקה פרטית - 7 סטטוס אחר - 9 סטטוס הדרכה - 11 סטטוס פגישה מחלקתית - 12 סטטוס תקציר - 13 שמות הסטטוסים ניתנים לשינוי בממשק הניהול שלכם. | מספר שלם | חובה |
בקשה לדוגמא בפורמט Get
1
https://api.voicenter.com/UserLogin/SetStatusFromAPI?Code=XXXXXXXXXXX&UserId=123456789&ExtensionUser=sipsip&Status=1
בקשה לדוגמא בפורמט POST-JSON
{
"Code": "XXXXXXXXXXX",
"UserId": "123456789",
"ExtensionUser": "sipsip",
"Status": 1
}
פרמטרים בתגובה
| שם שדה | תיאור שדה | Type |
| Status | סטטוס התגובה: במידה והבקשה תקינה יוחזר סטטוס "1". במידה והבקשה שלכם אינה כוללת מזהה משתמש או קוד ארגוני יוחזר ססטוס "2". במידה והערך של מזהה השלוחה אינו תקין בבקשה יוחזר סטטוס "3". במידה והערך של הסטטוס בבקשה שלכם אינו מוגדר בחשבונכם יוחזר סטטוס "4". | מספר שלם |
| StatusError | שגיאה של סטטוס התגובה: במידה ופורמט הבקשה אינו תקין יוחזר סטטוס "0". במידה והבקשה שלכם תקינה יוחזר סטטוס "1". במידה והערך של מזהה השלוחה אינו תקין בבקשה יוחזר סטטוס "3". במידה והייתה בעיה פנימית שהובילה לשגיאה יוחזר סטטוס "4". במידה וחסרים פרמטרים בבקשה שלכם יוחזר סטטוס "6". | מספר שלם |
| StatusErroMessage | תיאור שגיאה של התגובה: . יוזר תיאור סטטוס "OK" אם הבקשה הייתה תקינה. יוחזר תיאור ססטוס "Authorization Failed" במידה ופורמט הבקשה או הקוד הארגוני אינו תקין. יוחזר תיאור סטטוס "Status not support" במידה והסטטוס שמופיע בבקשה אינו מוגדר בחשבונכם. יוחזר תיאור סטטוס "Extension is already in use" במידה ונציג מנסה לבצע לוגין לשלוחה שכבר מחוברת. יוחזר תיאור סטטוס של "No extension found" במידה ומזהה השלוחה אינו תקין . יוחזר תיאור סטטוס של "Error on update" במידה והתרחשה בעיה בצד שרת של השירות. | מחרוזת |
דוגמא לתגובה
{
"Status": 1,
"StatusError": 1,
"StatusErroMessage": "OK"
}