נקודת קצה (endpoint) של סטטוסים של פעולות בתור

אפשר להשתמש בנקודת הקצה (endpoint) של סטטוסי פעולות בתור כדי לקבל את סטטוס הזמינות של תור לפני שמעבירים אליו סשן. נקודת הקצה הזו מחזירה את מאפייני הבוליאן הבאים:

  • after_hours: true אם התור לא זמין כי הוא במצב 'אחרי שעות הפעילות'

  • overcapacity: true אם התור לא זמין כי הוא במצב של עומס יתר

נקודת קצה (endpoint):

שיטה: GET

סוג: RAW

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

שאילתה:

מפתח ערך תיאור
menu_id מספר שלם המזהה של התור שרוצים לקבל לגביו מידע על הזמינות. חובה.
lang מחרוזת קוד השפה של התור, בן שתי אותיות בפורמט ISO 639-1. חובה.
channel_type מחרוזת סוג הערוץ. הערכים האפשריים הם call ו-chat. חובה.

דוגמה לבקשה ולתגובה

בקטע הזה מופיעה דוגמה לבקשה ולתשובה.

בקשה

https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses?menu_id=1&lang=en&channel_type=call

תשובה

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}