Endpunkte für das Erzwingen der Agent-Abmeldung

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

Die folgenden API-Endpunkte zum Erzwingen der Abmeldung von Agenten sind verfügbar:

Erzwingen der Abmeldung von Agenten

Dieser Endpunkt bietet die Möglichkeit, die Abmeldung bestimmter Agenten zu erzwingen. Agenten können anhand der folgenden Informationen identifiziert werden:

  • Agent-ID

  • Team-ID

  • IP-Adresse

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"
    ]
}

Beispielanfragen 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 Agent-ID und Team-ID abmelden. In diesem Fall waren das die Agent-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 erfolgreich über die 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

Job zum Erzwingen der Abmeldung von Agenten erstellt

In diesem Beispiel wird gezeigt, wie Sie die Abmeldung von Agenten anfordern und den resultierenden Job, 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

Agenten in Anrufen oder Chats werden später abgemeldet

In diesem Beispiel wird gezeigt, wie Agenten, die sich in einem Anruf oder Chat befinden, 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: Agenten nicht gefunden

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

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "ip_addrs": [
        "34.211.11.0/24"
    ]
}
Antwort: Fehler : Es wurde kein Agent mit den Eingabeparametern gefunden
{
    "message": "cannot find any agent by input params"
}

Statuscode: 400

Jobs zum Erzwingen der Abmeldung von Agenten

Mit diesem Endpunkt können Sie den Status einer erzwungenen Abmeldeanfrage für einen Agenten 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 gesendeten erzwungenen Abmeldeanfrage.

Beispielanfragen und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Erfolgreich abgeschlossen

In diesem Beispiel wird gezeigt, wie Sie einen Job abrufen, der erfolgreich abgeschlossen wurde.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Anfrage:

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

Statuscode: 200