Endpunkte für Agent-Aktivitäten

Agent-Aktivitätsprotokolle sind Aufzeichnungen, die immer dann erstellt werden, wenn sich der Status des Widgets ändert. Das kann beispielsweise beim Anmelden im Widget, beim Erhalten einer Deltacast-Anrufbenachrichtigung oder beim Annehmen eines Anrufs der Fall sein. Für jede Aktivität wird ein neues Objekt erstellt. Im folgenden Modell sehen Sie, welche Felder möglicherweise personenbezogene Daten enthalten:

[
  {
    "id": 0,
    "agent_id": 0,
    "whodunnit": {
      "id": 0,
      "name": "string",
      "last_name": "string",
      "first_name": "string",
      "agent_number": "string",
      "avatar_url": "string"
    },
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "started_at": "2018-06-06T21:12:24.766Z",
    "ended_at": "2018-06-06T21:12:24.766Z",
    "duration": 0,
    "activity": "login",
    "call_id": 0,
    "chat_id": 0
  }
]

Die folgende Tabelle enthält eine Zusammenfassung aller Aktivitäten, die zur Erstellung eines Aktivitätsprotokolls führen können.

Aktivität Beschreibung
chat_picked_up Ereignis, das auftritt, wenn ein Agent einen Chat annimmt
chat_pick_up_attempt Ereignis, das auftritt, wenn ein Agent versucht, der antwortende Agent zu werden
chat_notification_offered Ereignis, das auftritt, wenn ein Endnutzer eine Chatsitzung anfordert und eine Benachrichtigung an die Agenten gesendet wird, die dieser Warteschlange zugewiesen sind.
call_notification_offered Ereignis, das auftritt, wenn ein Endnutzer anruft und dem Agenten eine Multicast- oder Deltacast-Anrufbenachrichtigung angeboten wird.
call_pick_up_attempt Ereignis, das auftritt, wenn ein Agent versucht, einen Multicast- oder Deltacast-Anruf anzunehmen.
call_picked_up Ereignis, das auftritt, wenn ein Agent einen Multicast- oder Deltacast-Anruf annimmt.
deltacast_call_notification_offered Ereignis, das angibt, dass ein Endnutzer in einer Warteschlange mit Multicast angerufen hat, wobei ein Deltacast-Anruf an einen Agenten in dieser Warteschlange gesendet wird.
deltacast_call_pick_up_attempt Ereignis, das auftritt, wenn ein Agent versucht, einen Deltacast-Anruf anzunehmen
deltacast_call_picked_up Ereignis, das auftritt, wenn ein Agent einen Deltacast-Anruf erfolgreich annimmt.
deltacast_call_missed Ereignis, das auftritt, wenn ein Agent seinen Deltacast-Anruf nicht annimmt
multicast_call_notification_offered Ereignis, das angibt, dass ein Endnutzer in einer Warteschlange mit Multicast angerufen hat, wobei ein Multicast-Anruf an die Agenten in dieser Warteschlange gesendet wird.
multicast_call_pick_up_attempt Ereignis, das auftritt, wenn ein Agent versucht hat, einen Multicast-Anruf anzunehmen
multicast_call_picked_up Ereignis, das auftritt, wenn ein Agent einen Multicast-Anruf angenommen hat
call_outbound_dialing Ereignis, das auftritt, wenn ein Agent das Wähltastenfeld im Widget verwendet, um einen Endnutzer anzurufen.
user_status_changed Ereignis, das auftritt, wenn ein Agent den Status des Widgets ändert
login Ereignis, das auftritt, wenn sich ein Agent vom Widget abmeldet
logout Ereignis, das auftritt, wenn sich ein Agent im Widget anmeldet

Agent-Aktivitätsprotokolle

Parameter Erforderlich Datentyp Definition
sort_column FALSE String Sortiert die Antwort anhand eines beliebigen Felds im Antwortobjekt.
sort_direction FALSE ASC oder DESC Gibt die Sortierrichtung an, entweder aufsteigend oder absteigend
page FALSE String Wird mit „per“ kombiniert, um die Seite der Datensätze anzugeben. Wenn „per“ beispielsweise auf 200 und „page“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201 bis 400, da Seite 1 die Datensätze 1 bis 200 enthält.
per FALSE String Wird mit „page“ kombiniert, um anzugeben, wie viele Datensätze auf einer Seite mit Datensätzen enthalten sein sollen. Wenn „per“ beispielsweise auf 200 und „page“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201 bis 400, da Seite 1 die Datensätze 1 bis 200 enthält.
started_at[from] FALSE Uhrzeit in UTC Erstellt eine Untergrenze für das Feld „started_at“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
started_at[to] FALSE Uhrzeit in UTC Erstellt eine Obergrenze für das Feld „started_at“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
ended_at[from] FALSE Uhrzeit in UTC Erstellt eine Untergrenze für das Feld „ended_at“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
ended_at[to] FALSE Uhrzeit in UTC Erstellt eine Obergrenze für das Feld „ended_at“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
duration[from] FALSE Zahl Erstellt eine Untergrenze für das Feld „duration“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
duration[to] FALSE Zahl Erstellt eine Obergrenze für das Feld „duration“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
id[] FALSE Array[String] Array[Strings] ID der Datensätze, die gesucht und zurückgegeben werden sollen
agent_id[] FALSE Array[String] Filtert die Antwort nach der Agent-ID
activity[] FALSE Array[String] Filtert Datensätze nach der Aufgabe/Aktivität, die der Agent ausgeführt hat. Mögliche Werte sind: „login“, „logout“, „call_outbound_dialing“, „deltacast_call_notification_offered“, „deltacast_call_pick_up_attempt“, „deltacast_call_picked_up“, „deltacast_call_projected“, „deltacast_call_missed“, „deltacast_call_bounced“, „multicast_call_notification_offered“, „multicast_call_pick_up_attempt“, „multicast_call_picked_up“, „user_status_changed“, „chat_notification_offered“, „chat_pick_up_attempt“, „chat_picked_up“
whodunnit_id[] FALSE Array[String] Filtert die Antwort nach der Agent-ID. „Whodunnit“ ist eine Teilmenge des Agent-Objekts und verwendet dieselbe „agent_id“ als Primärschlüssel.
call_id[] FALSE Array[String] Filtert Datensätze nach eingegebenen Anruf-IDs
chat_id[] FALSE Array[String] Filtert Datensätze nach eingegebenen Chat-IDs

Endpunkt:

Method: GET
Type: 
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agent_activity_logs

Weitere Beispielanfragen und ‑antworten:

Beispielanfrage: Agent-Aktivitätsprotokolle

Text: Keine

Beispielantwort: Agent-Aktivitätsprotokolle

[
    {
        "id": 190578,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 199548,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 190577,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": "2018-01-08T22:54:22.000Z",
        "duration": 1548004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 199547,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 190270,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2017-12-21T21:34:14.000Z",
        "ended_at": "2017-12-22T00:54:18.000Z",
        "duration": 12004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 198036,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2018-01-08T22:54:22.000Z",
        "ended_at": "2018-01-09T22:54:26.000Z",
        "duration": 86404,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 22249,
        "agent_id": 129,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-06-19T18:34:39.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "login",
        "whodunnit": null
    }
]

Statuscode: 200