Agent-Endpunkte

Agent-Endpunkte bieten eine Möglichkeit, Agent-Objekte abzurufen. Jedes Agentenobjekt stellt einen einzelnen Agenten in der Contact Center AI Platform (CCAI Platform) dar. Sehen Sie sich das folgende Modell an, um zu erfahren, welche Felder personenidentifizierbare Informationen enthalten könnten.

[
  {
    "id": 0,
    "email": "string",
    "created_at": "2018-05-30T20:46:31.333Z",
    "last_login_time": "2018-05-30T20:46:31.333Z",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "agent_number": "string",
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "status_updated_at": "2018-05-30T20:46:31.333Z",
    "crm_authenticated": true,
    "online": true,
    "wrap_up": true,
    "call_count": 0,
    "chat_count": 0,
    "location": "string",
    "roles": [
      "agent"
    ],
    "teams": [
      {
        "id": 0,
        "name": "string",
        "parent_id": 0,
        "position": 0,
        "deleted": true,
        "agents_count": 0
      }
    ],
    "channels": [
      {
        "channel_type": "chat",
        "menu": {
          "id": 0,
          "name": "string",
          "parent_id": 0,
          "position": 0,
          "deleted": true,
          "hidden": "string",
          "menu_type": "ivr_menu",
          "output_msg": "string"
        }
      }
    ]
  }
]

KI-Agenten

Der Endpunkt /manager/api/v1/agents gibt Agentenobjekte sowie Echtzeitstatus- und Anwesenheitsdaten nur für aktive Agenten zurück. Dieser Endpunkt gibt keine deaktivierten KI-Agenten-Datensätze zurück.

Hinweis: Wenn Sie Nutzer- und Agentenkonfigurationsdatensätze für alle Nutzer abrufen möchten, einschließlich deaktivierter Konten und ihrer deactivated_at-Zeitstempel, verwenden Sie stattdessen den Apps API-Endpunkt /apps/api/v1/users. Weitere Informationen zum Abrufen vollständiger Nutzerdatensätze finden Sie unter Nutzerkonfigurationsdaten abrufen.

In der folgenden Tabelle sind die Suchparameter aufgeführt, die vom Endpunkt /manager/api/v1/agents unterstützt werden:

Parameter	Erforderlich	Datentyp	Definition
Seite	FALSE	String	Wird mit „per“ kombiniert, um anzugeben, auf welcher Seite sich die Datensätze befinden. Wenn „per“ beispielsweise auf 200 und „page“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201–400, da Seite 1 die Datensätze 1–200 enthält.
pro	FALSE	String	Wird mit „page“ kombiniert, um anzugeben, wie viele Datensätze auf einer Seite enthalten sein sollen. Wenn „per“ beispielsweise auf 200 und „page“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201–400, da Seite 1 die Datensätze 1–200 enthält.
id[]	FALSE	Array[String]	Array[Strings]. ID der Datensätze, die gesucht und zurückgegeben werden sollen
agent_number[]	FALSE	Array[String]	Agent-Nummern, die vom Administrator beim Erstellen eines Agents zugewiesen wurden
status_id[]	FALSE	Array[String]	Filtert nach Agentenstatus
online[]	FALSE	Boolesch	Nach Onlinestatus der KI-Agenten filtern
wrap_up[]	FALSE	Boolesch	Nach Agenten im Nachbereitungsstatus filtern
location[]	FALSE	Array[String]	Filtert nach Standort des KI-Agenten.
last_login_time[from]	FALSE	Zeit in UTC	erstellt eine Untergrenze für das Feld „Letzte Anmeldung“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
last_login_time[to]	FALSE	Zeit in UTC	erstellt eine Obergrenze für das Feld „Letzte Anmeldung“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
status_updated_at[from]	FALSE	Zeit in UTC	Erstellt eine Untergrenze für das Feld „status_updated_at“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
status_updated_at[to]	FALSE	Zeit in UTC	Erstellt eine Obergrenze für das Feld „status_updated_at“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.

Endpunkt:

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

Weitere Beispielanfragen/-antworten:

Beispielanfrage: Agents-Beispiel

Body: None

Beispielantwort: Beispiel für KI-Agenten

[
  {
    "id": 45,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Craig T",
    "middle_name": null,
    "last_name": "Nelson",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -6,
      "name": "Wrap-up",
      "color": "purple",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2016-11-10T00:15:04.000Z",
    "last_login_time": "2016-11-10T00:17:57.000Z",
    "status_updated_at": null,
    "teams": [
      {
        "id": 163,
        "name": "team CTN",
        "parent_id": null,
        "position": 11,
        "agents_count": 12,
        "deleted": false
      }
    ],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2029,
          "name": "Mobile Queue",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 60,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Darth",
    "middle_name": null,
    "last_name": "Vader",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -7,
      "name": "In-call",
      "color": "light_blue",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-02-03T19:44:14.000Z",
    "last_login_time": "2017-02-03T20:05:31.000Z",
    "status_updated_at": "2017-02-04T12:36:11.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 1693,
          "name": "Premium Support",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "ivr_menu",
          "output_msg": "You selected premium support",
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 81,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Barry",
    "middle_name": null,
    "last_name": "Allen",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -10,
      "name": "Offline",
      "color": "grey",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-03-13T23:47:39.000Z",
    "last_login_time": "2017-03-13T23:48:17.000Z",
    "status_updated_at": "2017-03-13T23:56:04.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2028,
          "name": "Speed Issues",
          "parent_id": 2027,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  }
]

Statuscode: 200

Aktueller Status des KI-Agenten

„Aktueller Status der Kundenservicemitarbeiter“ gibt alle angemeldeten Kundenservicemitarbeiter und ihren aktuellen Status zurück, wie lange sie sich in diesem Status befinden, und zusätzliche Informationen, die angeben, ob der Kundenservicemitarbeiter auf „In Warteschlange“ gesetzt ist und wie lange.

Endpunkt:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/agents/current_status

Weitere Beispielanfragen/-antworten:

Beispielanfrage: Aktueller Status der Agenten

Body: None

Beispielantwort: Aktueller Status des Agenten

[
  {
    "id": 1,
    "status": "Available",
    "status_id": 0,
    "status_updated_at": "2021-05-10T17:45:01.000Z",
    "on_hold": false,
    "on_hold_duration": 0
  }
]

Statuscode: 0

Unerwartete JSON-Schlüssel in API-Antworten erwarten

Alle API-Updates sind abwärtskompatibel. Wir behalten uns das Recht vor, jederzeit neue JSON-Schlüssel in bestehende API-Antworten einzuführen. Wir empfehlen, Antworten defensiv zu verarbeiten, indem Sie alle nicht erkannten Schlüssel ignorieren, um die Funktionalität aufrechtzuerhalten.