Endpunkte für das Erzwingen der Agent-Abmeldung

Mit dem Endpunkt zum Erzwingen der Abmeldung von Kundenservicemitarbeitern können Sie die Abmeldung von Online-Kundenservicemitarbeitern erzwingen. Kundenservicemitarbeiter, die an aktiven Anrufen oder Chats beteiligt sind, werden automatisch abgemeldet, wenn sie ihre aktuellen Interaktionen abgeschlossen haben. Inaktive Kundenservicemitarbeiter werden sofort abgemeldet. Dieser Endpunkt unterstützt das erzwungene Abmelden bestimmter Kundenservicemitarbeiter, ganzer Teams oder Kundenservicemitarbeiter, die durch IP-Adressen mit CIDR-Notation, eine Liste von IPv4-/IPv6-Adressen oder IP-Bereiche identifiziert werden. Bei einer großen Anzahl von Kundenservicemitarbeitern wird ein Hintergrundjob erstellt, um den Abmeldevorgang effizient zu verwalten.

Die API-Endpunkte zum Erzwingen der Abmeldung von Kundenservicemitarbeitern sind:

Abmeldung von Agents erzwingen

Dieser Endpunkt ermöglicht das Abmelden bestimmter Kundenservicemitarbeiter. Agents können anhand der folgenden Merkmale erkannt werden:

  • Agent-ID.

  • Team-ID.

  • ohne dass eine externe IP-Adresse erforderlich ist.

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json
Akzeptieren application/json

Text:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}

Beispielanfrage und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Agenten erfolgreich abmelden

In diesem Beispiel wird gezeigt, wie Sie bestimmte Agenten anhand der Agenten-ID und Team-ID abmelden. In diesem Fall waren das die Kundenservicemitarbeiter-IDs 11 und 12 sowie die Team-ID 1.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Statuscode:200

Agenten über IP-Adresse abmelden

In diesem Beispiel wird gezeigt, wie Sie Agenten abmelden, indem Sie einen IP-Adressbereich angeben. In diesem Fall ist der angegebene IP-Adressbereich 34.211.11.0/24.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}

Statuscode:200

Logout-Agent-Job erstellt

In diesem Beispiel wird gezeigt, wie Sie die Abmeldungen des Kundenservicemitarbeiters und den daraus resultierenden Job anfordern, der erstellt wird.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ],
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
Antwort
{
    "ip_addrs": [
        "34.211.11.0/16"
    ]
}

Statuscode:200

Kundenservicemitarbeiter, die gerade telefonieren oder chatten, werden später abgemeldet

In diesem Beispiel wird gezeigt, wie Kundenservicemitarbeiter, die sich in einem Anruf oder Chat befinden, erst später abgemeldet werden, nachdem der Chat oder Anruf beendet wurde.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Statuscode:400

Fehler: KI-Agenten können nicht gefunden werden

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die angegebenen Agents nicht gefunden werden konnten.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
Antwort: Fehler : Mit den Eingabeparametern kann kein Kundenservicemitarbeiter gefunden werden.
{
    "message": "cannot find any agent by input params"
}

Statuscode:400

Agent-Abmelde-Jobs erzwingen

Mit diesem Endpunkt können Sie den Status einer Anfrage zum erzwungenen Abmelden für einen Agent abrufen.

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
id Die Job-ID einer eingereichten Anfrage zum Erzwingen der Abmeldung.

Beispielanfrage und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Erfolgreich abgeschlossen

In diesem Beispiel wird gezeigt, wie ein Job abgerufen wird, der erfolgreich abgeschlossen wurde.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Suchanfrage

Method: GET
Type: 
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses/force_logout/jobs/105
Antwort
{
    "id": 105,
    "status": "completed"
}

Statuscode:200