Organizational Extension List

API זה נועד על מנת להציג את שלוחות הטלפוניה בארגונכם והמידע שלהם.
תוכלו לראות את החיוג המהיר של כל שלוחה, את המזהה שלוחה (סיפ) ועוד שלל פרטים נוספים.
API זה נותן מענה נהדר בשילוב עם Login/Logout API, כאשר נציג ירצה לבצע חיבור לשלוחה שלו דרך המערכת המידע Organizational Extension List API ייתן אפשרות לנציג לבחור את השלוחה הרלוונטית עבורו מתוך כלל השלוחות במחלקה/בארגון שלכם.
 תיאור של אינטגרציית הצגת שלוחות טלפוניות

הסבר כללי

URI

 

1
          
https://monitor.voicenter.co.il/Comet/api/GetExtensions
        

 

 

פורמט בקשה

1. POST

2. GET

פורמט תשובה

JSON

 

פרמטרים בבקשה

שם שדה תיאור סוג הערות
codeמזהה אישי, מסופק על ידי מחלקת התפעול של Voicenter.מחרוזתחובה
showAllמאפשר לכם לקבוע כי לפי איזו היררכיה בחשבון הAPI יחזיר לכם מידע השלוחות.
תוכלו לקבוע האם לקבל מידע עבור כלל השלוחות של כלל הארגון או של תת חשבון ספציפי.
כדי לקבל מידע עבור תת חשבון ספציפי יש להעביר את הקוד של אותו תת חשבון ולהגדיר "False" או "0".
כדי לקבל מידע עבור כלל הארגון יש להגדיר "True" או "1" .
בוליאנירשות

בקשה לדוגמה בפורמט GET

1
          
https://monitor.voicenter.co.il/Comet/api/GetExtensions?code=XXXXXXXXXXXXXXX&showAll=0
        

בקשה בפורמט POST-JSON

{
"code":"XXXXXXXXXXXXXXX",
"showAll":0
}

פרמטרים בתגובה

שם שדה תיאור סוג
ERRסטטוס התשובה:
סטטוס "0" מסמן שאין שגיאות.
סטטוס "1" מסמן שנשלח קוד בפורמט לא תקין.
במידה ונשלח קוד שאינו מתאים לשום חשבון התשובה תהיה מערך ריק.
מספר שלם
DESCתיאור סטטוס התגובה:
במידה והבקשה הייתה תקינה יוחזר הערך "OK" בפרמטר זה.
במידה והקוד שנשלח בבקשה אינו תקין או בפורמט אינו תקין תוצג ההודעה "Unauthorized".
מחרוזת
EXTENSIONSרשימה של כלל השלוחות המבוקשות.מערך
SIPמזהה ייחודי של השלוחה בפרוטוקול טלפוניה SIP.מחרוזת
Nameשם של השלוחה כפי שהיא מופיעה בממשק הניהול (Cpanel).מחרוזת
SpeedDialחיוג מהיר של השלוחה אשר מאפשר לשלוחה לקבל שיחות פנים ארגוניות.מחרוזת
AccountIDמזהה החשבון שהשלוחה מוגדרת בו.מספר שלם
AccountNameשם החשבון שהשלוחה מוגדרת בו.מחרוזת
UserNameשם המשתמש שבו מוגדרת השלוחה.מחרוזת
UserEmailכתובת הדואר האלטקרוני שמוגדרת בממשק הניהול (Cpanel) למשתמש של השלוחה.מחרוזת

דוגמא לתשובה

{
"ERR":0,
"DESC":"OK",
"EXTENSIONS":[
{
"SIP":"SIPSIP1",
"Name":"Extension 1",
"SpeedDial":"11",
"AccountID":12345678,
"AccountName":"Voicenter Account",
"UserName":"John Doe",
"UserEmail":"[email protected]"
},
{
"SIP":"SIPSIP2",
"Name":"Extension 2",
"SpeedDial":"12",
"AccountID":12345679,
"AccountName":"Sales Department",
"UserName":"Walter Melon",
"UserEmail":"[email protected]"
}
]
}