נקודות קצה של סטטוס הנציג

נקודות הקצה (endpoints) של ה-API של סטטוס הסוכן מספקות גישה לאובייקטים של סטטוס הסוכן. אובייקט של סוכן נוצר לכל משתמש שמגדירים בפלטפורמת Contact Center AI (פלטפורמת CCAI) שיש לו תפקיד שכולל הרשאת סוכן.

אלה נקודות הקצה של ה-API לסטטוס של הסוכן:

נקודות קצה של סטטוס הסוכן מאפשרות לשנות את הסטטוס של סוכנים. הם מאפשרים לשנות את הסטטוס מזמין לכל סטטוס מותאם אישית. מעברים לסטטוסים שמוגדרים על ידי המערכת ומסטטוסים כאלה, כמו במהלך שיחה, גורמים לשגיאה. בנוסף, נקודות הקצה האלה תומכות בעדכונים בכמות גדולה, ומאפשרות לבצע שינויים בסטטוס של צוותים שלמים או של קבוצות נבחרות של נציגים בו-זמנית.

עדכון סטטוס הסוכן

נקודת הקצה הזו מאפשרת לעדכן את הסטטוס של הסוכנים. בטבלה הבאה מוצגים הנכסים בגוף ה-JSON:

מאפיין (property) חובה סוג הנתונים הגדרה
סטטוס TRUE String הסטטוס שרוצים להגדיר לסוכנים, לדוגמה available (זמין).
agent_ids TRUE מספר שלם במערך מערך של מזהי סוכנים.
team_ids TRUE Array Integer מערך של מזהי צוותים.

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

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "status": "Available",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}

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

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

שינוי סטטוס הנציג בהצלחה

בדוגמה הבאה מוצגת הבקשה והתגובה המשויכת לשינוי הסטטוס של כמה סוכנים, במקרה שהפעולה בוצעה בהצלחה.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "status": "Available",
    "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": "Available"
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "previous_status": "In-call",
        "current_status": "In-call",
        "message": "Agent can't be changed from system status 'In-call'"
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "previous_status": "Offline",
        "current_status": "Offline",
        "message": "Agent's status can't be changed if they are offline or logged out"
    }
]

קוד הסטטוס: 200

הסטטוס לא קיים

בדוגמה הזו מוצגת הבקשה והתגובה המשויכת, שבהן הסטטוס שסופק לא קיים ולכן נחשב לא תקין.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

Body
{
    "status": "Napping",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
תגובה: שגיאה: הסטטוס 'Napping' לא קיים
{
    "message": "status 'Napping' does not exist"
}

קוד סטטוס: 400

הסטטוס מוגדר כסטטוס המערכת

בדוגמה הזו מוצגות הבקשה והתגובה שבהן הסטטוס מוגדר כסטטוס מערכת, במקרה הזה 'במהלך שיחה'. אי אפשר להגדיר את הסטטוס של סוכן לסטטוס שמנוהל על ידי המערכת.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

Body
{
    "status": "In-call",
    "agent_ids": [
        11,
        12
    ]
}
תגובה: שגיאה: אי אפשר לשנות את הסוכן לסטטוס המערכת'במהלך שיחה '
{
    "message": "Agent can't be changed to system status 'In-call'"
}

קוד סטטוס: 400

קבלת סטטוסים של נציגים

נקודת הקצה הזו מאפשרת לאחזר את הסטטוס של סוכנים. בטבלה הבאה מוצגים הנכסים בגוף ה-JSON:

מאפיין (property) חובה סוג הנתונים הגדרה
סטטוס TRUE String הסטטוס שרוצים להגדיר לסוכנים, לדוגמה available (זמין).
agent_ids לא נכון מספר שלם במערך מערך של מזהי סוכנים.
team_ids לא נכון Array Integer מערך של מזהי צוותים.

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

Method: GET
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}

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

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

קבלת הסטטוס של סוכנים וצוותים ספציפיים

בדוגמה הזו מוסבר איך לקבל את הסטטוס של סוכנים עם מזהים 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",
        "status": "lunch",
        "ip_addrs": [
            "34.211.11.101"
        ]
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "status": "In-call",
        "ip_addrs": [
            "34.211.11.102"
        ]
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "status": "Offline",
        "ip_addrs": [
            "34.211.11.103"
        ]
    }
]

קוד הסטטוס: 200