הוראות שימוש בשלוחת API:
צריך לפרט:
למה זה משמש
איך זה עובד
פורמט הבקשה מהשרת שלנו
בכניסה לשלוחה תשלח המערכת פניה לשרת שלכם, הכוללת את הפרמטרים הבאים:
callid = מספר המתקשר
cwd = השלוחה שבה נמצא המתקשר
uuid = מזהה השיחה הייחודי לאותה השיחה
hotline = מספר המערכת.
הפניה נשלחת בפורמט GET.
המערכת ממתינה לקבל חזרה אובייקט JSON עם פעולות לביצוע.
האובייקט צריך להכיל מפתח בשם tasks, שהערך שלו צריך להיות מערך עם הפעולות שהמערכת צריכה לבצע.
כל איבר במערך הוא אובייקט עם פרטי פעולה שהמערכת תבצע. הפעולות תבוצענה כפי הסדר שלהם במערך. שימו לב שישנן פעולות שלאחריהן אי אפשר לשרשר פקודה נוספת, עיין להלן.
כל אובייקט צריך להכיל מפתח type, שהוא סוג הפעולה.
סוגי הפעולות האפשריות הן כדלהלן:
|
play_files |
השמעת קבצים |
|
collect_data |
קבלת נתונים מהמשתמש |
|
jump |
הקפצת המשתמש לשלוחה אחרת |
|
ping |
שליחת צינתוק למשתמש ממספר כלשהו |
|
credit_card |
סליקת אשראי |
|
transfer |
ניתוב השיחה למספר אחר |
להלן המפתחות שצריכים להיות באובייקטים של הפעולות, לפי סוגי הפעולות:
play_files:
| שם המפתח | הפעולה | סוג הערך | תיאור על הערכים האפשריים |
|---|---|---|---|
|
no_skip |
קובע האם יוכלו להקיש על מקש כלשהו כדי לסיים את ההשמעה או שיצטרך לשמוע עד הסוף | בוליאני | אם מכניסים true אז א"א לדלג, אבל אם זה false או שאין כזה מפתח באובייקט או שהוא ריק, אז אפשר לדלג |
jump:
| שם המפתח | הפעולה | סוג הערך | תיאור על הערכים האפשריים |
|---|---|---|---|
|
new_path |
קובע לאיזה מקום במערכת יוקפץ המשתמש. | טקסט | צריך להכניס את נתיב התיקיה הרצויה, לדוגמא להקפצה לשלוחה 5/3 שולחים '5/3' |
collect_data:
אילו מפתחות יכולים להיות במפתח סוג הפעולה באובייקט הפעולה במערך הפעולות שבאובייקט התשובה