Agent-Status-Endpunkte

Die API-Endpunkte für den Agent-Status bieten Zugriff auf die Agent-Statusobjekte. Für jeden Nutzer, der in der Contact Center AI Platform (CCAI Platform) konfiguriert ist und eine Rolle mit einer Agent-Berechtigung hat, wird ein Agent-Objekt erstellt.

Die API-Endpunkte für den Agent-Status sind:

Mit Agent-Status-Endpunkten können Sie den Status von Agents ändern. Sie ermöglichen Änderungen vom Status Verfügbar zu einem beliebigen benutzerdefinierten Status. Übergänge zu und von systemdefinierten Status wie In-Call (Im Anruf) lösen einen Fehler aus. Außerdem unterstützen diese Endpunkte Bulk-Aktualisierungen, sodass Statusänderungen für ganze Teams oder ausgewählte Gruppen von Kundenservicemitarbeitern gleichzeitig möglich sind.

Agent-Status aktualisieren

Mit diesem Endpunkt können Sie den Status von Kundenservicemitarbeitern aktualisieren. In der folgenden Tabelle werden die Attribute im JSON-Textkörper beschrieben:

Attribut Erforderlich Datentyp Definition
Status TRUE String Der Status, auf den die Kundenservicemitarbeiter gesetzt werden sollen, z. B. „Verfügbar“.
agent_ids TRUE Ganzzahl-Array ARRAY von Agent-IDs.
team_ids TRUE Array Integer ARRAY von Team-IDs.

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Beispielanfrage und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Agentenstatus ändern

Das folgende Beispiel zeigt die Anfrage und die zugehörige Antwort beim Ändern des Status einiger Kundenservicemitarbeiter, wenn die Aktion erfolgreich war.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "status": "Available",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Response:
[
    {
        "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"
    }
]

Statuscode:200

Status nicht vorhanden

In diesem Beispiel sehen Sie die Anfrage und die zugehörige Antwort, in der der angegebene Status nicht vorhanden ist und daher als ungültig betrachtet wird.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

Body
{
    "status": "Napping",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
Antwort: Fehler: Der Status „Napping“ ist nicht vorhanden.
{
    "message": "status 'Napping' does not exist"
}

Statuscode:400

Status auf Systemstatus festgelegt

In diesem Beispiel werden die Anfrage und die Antwort gezeigt, in denen der Status auf einen Systemstatus gesetzt ist, in diesem Fall „in-call“. Es ist nicht möglich, den Status eines Kundenservicemitarbeiters auf einen vom System verwalteten Status festzulegen.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

Body
{
    "status": "In-call",
    "agent_ids": [
        11,
        12
    ]
}
Antwort: Fehler: Der Status des Agents kann nicht in „In-call“ (Im Anruf) geändert werden.
{
    "message": "Agent can't be changed to system status 'In-call'"
}

Statuscode:400

Agent-Status abrufen

Mit diesem Endpunkt können Sie den Status von Agents abrufen. In der folgenden Tabelle werden die Attribute im JSON-Textkörper beschrieben:

Attribut Erforderlich Datentyp Definition
Status TRUE String Der Status, auf den die Kundenservicemitarbeiter gesetzt werden sollen, z. B. „Verfügbar“.
agent_ids FALSE Ganzzahl-Array ARRAY von Agent-IDs.
team_ids FALSE Array Integer ARRAY von Team-IDs.

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Beispielanfrage und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Status bestimmter Kundenservicemitarbeiter und Teams abrufen

In diesem Beispiel wird gezeigt, wie Sie den Status von Kundenservicemitarbeitern mit den IDs 11 und 12 sowie von allen Kundenservicemitarbeitern im Team mit der ID 1 abrufen.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Antwort: Status der angeforderten Kundenservicemitarbeiter
[
    {
        "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"
        ]
    }
]

Statuscode:200