נקודת הקצה של הסוכנים שמאפשרת לכם להוציא סוכנים מחוברים מהמערכת. נציגים שנמצאים בשיחות או בצ'אטים פעילים מתנתקים אוטומטית מהמערכת כשהם מסיימים את האינטראקציות הנוכחיות שלהם. סוכנים לא פעילים יוצאים מהחשבון באופן מיידי. נקודת הקצה הזו תומכת בהתנתקות מאולצת של סוכנים ספציפיים, של צוותים שלמים או של סוכנים שמזוהים לפי כתובות IP עם סימון CIDR, רשימה של כתובות IPv4/IPv6 או טווחי כתובות IP. אם יש מספר גדול של נציגים, נוצרת משימה ברקע כדי לנהל את תהליך היציאה בצורה יעילה.
אלה נקודות הקצה של ה-API שמשמשות ליציאה מאולצת של סוכנים:
אילוץ יציאה מהחשבון של סוכנים
נקודת הקצה הזו מאפשרת לצאת מסוכנים ספציפיים. אפשר לזהות סוכנים לפי הפרטים הבאים:
מזהה הנציג.
מזהה הצוות.
כתובת IP.
נקודת קצה (endpoint):
Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json | |
| אישור | application/json |
Body:
{
"agent_ids": [
11,
12
],
"team_ids": [
1
],
"ip_addrs": [
"34.211.11.0/24"
]
}
דוגמה לבקשה ולתשובות
בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.
התנתקות של סוכנים
בדוגמה הזו אנחנו מראים איך להתנתק מסוכנים ספציפיים על סמך מזהה הסוכן ומזהה הצוות. במקרה הזה, מדובר במזהי סוכנים 11 ו-12 ובמזהה צוות 1.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
Body:
{
"agent_ids": [
11,
12
],
"team_ids": [
1
]
}
תשובה
[
{
"agent_id": 11,
"name": "Darth Vader",
"email": "notanakinskywalker@empire.com",
"agent_number": "Agent No.111",
"previous_status": "lunch",
"current_status": "Offline"
},
{
"agent_id": 12,
"name": "Craig T",
"email": "craigT@nelson.com",
"agent_number": "Agent No.112",
"previous_status": "Unavailable",
"current_status": "Offline"
},
{
"agent_id": 13,
"name": "Raymond D",
"email": "rayd@nelson.com",
"agent_number": "Agent No.113",
"previous_status": "Break",
"current_status": "Offline"
}
]
קוד הסטטוס: 200
התנתקות של סוכנים באמצעות כתובת IP בוצעה בהצלחה
בדוגמה הזו מוסבר איך להוציא סוכנים מהחשבון על ידי ציון טווח של כתובות IP.
במקרה הזה, טווח כתובות ה-IP שצוין הוא 34.211.11.0/24.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
Body:
{
"agent_ids": [
11,
12
],
"team_ids": [
1
],
"ip_addrs": [
"34.211.11.0/24"
]
}
קוד הסטטוס: 200
נוצרה משימה של סוכן ליציאה מהחשבון
בדוגמה הזו מוסבר איך לבקש מהסוכן להתנתק ואיך נוצרת המשימה כתוצאה מכך.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
Body:
{
"agent_ids": [
11,
12
],
"team_ids": [
1
],
"ip_addrs": [
"34.211.11.0/24"
]
}
תשובה
{
"ip_addrs": [
"34.211.11.0/16"
]
}
קוד הסטטוס: 200
נציגים שנמצאים בשיחה או בצ'אט יתנתקו מאוחר יותר
בדוגמה הזו אפשר לראות איך נציגי תמיכה שנמצאים בשיחה או בצ'אט יתנתקו מהמערכת מאוחר יותר, אחרי שהשיחה או הצ'אט יסתיימו.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
Body:
{
"agent_ids": [
11,
12
],
"team_ids": []
}
תשובה
[
{
"agent_id": 11,
"name": "Darth Vader",
"email": "notanakinskywalker@empire.com",
"agent_number": "Agent No.111",
"previous_status": "In-call",
"current_status": "In-call",
"message": "will force logout as soon as the ongoing call/chat is completed"
},
{
"agent_id": 12,
"name": "Craig T",
"email": "craigT@nelson.com",
"agent_number": "Agent No.112",
"previous_status": "In-chat",
"current_status": "In-chat",
"message": "will force logout as soon as the ongoing call/chat is completed"
}
]
קוד סטטוס: 400
שגיאה: לא ניתן למצוא סוכנים
בדוגמה הזו מוצג תרחיש של כשל שבו לא נמצאו הסוכנים שצוינו.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
Body:
{
"ip_addrs": [
"34.211.11.0/24"
]
}
תגובה: שגיאה : לא נמצא סוכן עם פרמטרי הקלט
{
"message": "cannot find any agent by input params"
}
קוד סטטוס: 400
אילוץ יציאה של סוכנים ממשרות
נקודת הקצה הזו מאפשרת לקבל את הסטטוס של בקשת התנתקות מאולצת של סוכן.
{
"identifier": "string",
"email": "string",
"name": "string",
"phone": "string"
}
נקודת קצה (endpoint):
Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout/jobs/:id
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| id | מזהה המשימה של בקשה שנשלחה להתנתקות מאולצת. |
דוגמה לבקשה ולתשובות
בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.
המשימה הושלמה
בדוגמה הזו אפשר לראות איך מאחזרים עבודה שהושלמה בהצלחה.
בקשה
כותרות:
| מפתח | ערך | תיאור |
|---|---|---|
| סוג התוכן | application/json |
שאילתה:
Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout/jobs/105
תשובה
{
"id": 105,
"status": "completed"
}
קוד הסטטוס: 200